Package org.apache.maven.doxia.document
Class DocumentAuthor
java.lang.Object
org.apache.maven.doxia.document.DocumentAuthor
- All Implemented Interfaces:
Serializable
An author of the document.
- Version:
- $Revision$ $Date$
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate StringThe city name of the address of the author.private StringThe name of the company that employs the author.private StringThe country of the address of the author.private StringThe email address of the author.private StringThe fax number of the author.private StringThe first name of the author.private StringThe initials of the author.private StringThe last name of the author.private StringThe full name of the author, usually as a String of "firstName lastName".private StringThe telephone number of the author.private StringThe position of the author.private StringThe postal code of the address of the author.private StringThe state or province of the address of the author, if applicable.private StringThe street name of the address of the author.private StringThe title of the author. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbooleanMethod equals.getCity()Get the city name of the address of the author.Get the name of the company that employs the author.Get the country of the address of the author.getEmail()Get the email address of the author.Get the fax number of the author.Get the first name of the author.Get the full name of the author.Get the initials of the author.Get the last name of the author.getName()Get the full name of the author, usually as a String of "firstName lastName".Get the telephone number of the author.Get the position of the author.Get the postal code of the address of the author.getState()Get the state or province of the address of the author, if applicable.Get the street name of the address of the author.getTitle()Get the title of the author.inthashCode()Method hashCode.voidSet the city name of the address of the author.voidsetCompanyName(String companyName) Set the name of the company that employs the author.voidsetCountry(String country) Set the country of the address of the author.voidSet the email address of the author.voidsetFaxNumber(String faxNumber) Set the fax number of the author.voidsetFirstName(String firstName) Set the first name of the author.voidsetInitials(String initials) Set the initials of the author.voidsetLastName(String lastName) Set the last name of the author.voidSet the full name of the author, usually as a String of "firstName lastName".voidsetPhoneNumber(String phoneNumber) Set the telephone number of the author.voidsetPosition(String position) Set the position of the author.voidsetPostalCode(String postalCode) Set the postal code of the address of the author.voidSet the state or province of the address of the author, if applicable.voidSet the street name of the address of the author.voidSet the title of the author.toString()Method toString.
-
Field Details
-
firstName
The first name of the author. -
lastName
The last name of the author. -
name
The full name of the author, usually as a String of "firstName lastName".- Since:
- 1.1.1 .
-
initials
The initials of the author. -
title
The title of the author. -
position
The position of the author. -
email
The email address of the author. -
phoneNumber
The telephone number of the author. -
faxNumber
The fax number of the author. -
companyName
The name of the company that employs the author. -
street
The street name of the address of the author. -
city
The city name of the address of the author. -
postalCode
The postal code of the address of the author. -
country
The country of the address of the author. -
state
The state or province of the address of the author, if applicable.
-
-
Constructor Details
-
DocumentAuthor
public DocumentAuthor()
-
-
Method Details
-
equals
Method equals. -
getCity
Get the city name of the address of the author.- Returns:
- String
-
getCompanyName
Get the name of the company that employs the author.- Returns:
- String
-
getCountry
Get the country of the address of the author.- Returns:
- String
-
getEmail
Get the email address of the author.- Returns:
- String
-
getFaxNumber
Get the fax number of the author.- Returns:
- String
-
getFirstName
Get the first name of the author.- Returns:
- String
-
getInitials
Get the initials of the author.- Returns:
- String
-
getLastName
Get the last name of the author.- Returns:
- String
-
getName
Get the full name of the author, usually as a String of "firstName lastName".- Returns:
- String
- Since:
- 1.1.1.
-
getPhoneNumber
Get the telephone number of the author.- Returns:
- String
-
getPosition
Get the position of the author.- Returns:
- String
-
getPostalCode
Get the postal code of the address of the author.- Returns:
- String
-
getState
Get the state or province of the address of the author, if applicable.- Returns:
- String
-
getStreet
Get the street name of the address of the author.- Returns:
- String
-
getTitle
Get the title of the author.- Returns:
- String
-
hashCode
public int hashCode()Method hashCode. -
setCity
Set the city name of the address of the author.- Parameters:
city- a city object.
-
setCompanyName
Set the name of the company that employs the author.- Parameters:
companyName- a companyName object.
-
setCountry
Set the country of the address of the author.- Parameters:
country- a country object.
-
setEmail
Set the email address of the author.- Parameters:
email- a email object.
-
setFaxNumber
Set the fax number of the author.- Parameters:
faxNumber- a faxNumber object.
-
setFirstName
Set the first name of the author.- Parameters:
firstName- a firstName object.
-
setInitials
Set the initials of the author.- Parameters:
initials- a initials object.
-
setLastName
Set the last name of the author.- Parameters:
lastName- a lastName object.
-
setName
Set the full name of the author, usually as a String of "firstName lastName".- Parameters:
name- a name object.- Since:
- 1.1.1.
-
setPhoneNumber
Set the telephone number of the author.- Parameters:
phoneNumber- a phoneNumber object.
-
setPosition
Set the position of the author.- Parameters:
position- a position object.
-
setPostalCode
Set the postal code of the address of the author.- Parameters:
postalCode- a postalCode object.
-
setState
Set the state or province of the address of the author, if applicable.- Parameters:
state- a state object.
-
setStreet
Set the street name of the address of the author.- Parameters:
street- a street object.
-
setTitle
Set the title of the author.- Parameters:
title- a title object.
-
toString
Method toString. -
getFullName
Get the full name of the author.- Returns:
nameif defined,firsName lastNameotherwise.- Since:
- 1.1.1
- See Also:
-