org.apache.maven.doxia.document
Class DocumentAuthor

java.lang.Object
  org.apache.maven.doxia.document.DocumentAuthor

All Implemented Interfaces:

Serializable

public class DocumentAuthor
extends Object
implements Serializable

An author of the document.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

DocumentAuthor()

Method Summary

boolean	equals(Object other) Method equals.
String	getCity() Get the city name of the address of the author.
String	getCompanyName() Get the name of the company that employs the author.
String	getCountry() Get the country of the address of the author.
String	getEmail() Get the email address of the author.
String	getFaxNumber() Get the fax number of the author.
String	getFirstName() Get the first name of the author.
String	getFullName() Get the full name of the author.
String	getInitials() Get the initials of the author.
String	getLastName() Get the last name of the author.
String	getName() Get the full name of the author, usually as a String of "firstName lastName".
String	getPhoneNumber() Get the telephone number of the author.
String	getPosition() Get the position of the author.
String	getPostalCode() Get the postal code of the address of the author.
String	getState() Get the state or province of the address of the author, if applicable.
String	getStreet() Get the street name of the address of the author.
String	getTitle() Get the title of the author.
int	hashCode() Method hashCode.
void	setCity(String city) Set the city name of the address of the author.
void	setCompanyName(String companyName) Set the name of the company that employs the author.
void	setCountry(String country) Set the country of the address of the author.
void	setEmail(String email) Set the email address of the author.
void	setFaxNumber(String faxNumber) Set the fax number of the author.
void	setFirstName(String firstName) Set the first name of the author.
void	setInitials(String initials) Set the initials of the author.
void	setLastName(String lastName) Set the last name of the author.
void	setName(String name) Set the full name of the author, usually as a String of "firstName lastName".
void	setPhoneNumber(String phoneNumber) Set the telephone number of the author.
void	setPosition(String position) Set the position of the author.
void	setPostalCode(String postalCode) Set the postal code of the address of the author.
void	setState(String state) Set the state or province of the address of the author, if applicable.
void	setStreet(String street) Set the street name of the address of the author.
void	setTitle(String title) Set the title of the author.
String	toString() Method toString.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DocumentAuthor

public DocumentAuthor()

Method Detail

equals

public boolean equals(Object other)

Method equals.

Overrides:

equals in class Object

Parameters:

other -

Returns:

boolean

getCity

public String getCity()

Get the city name of the address of the author.

Returns:

String

getCompanyName

public String getCompanyName()

Get the name of the company that employs the author.

Returns:

String

getCountry

public String getCountry()

Get the country of the address of the author.

Returns:

String

getEmail

public String getEmail()

Get the email address of the author.

Returns:

String

getFaxNumber

public String getFaxNumber()

Get the fax number of the author.

Returns:

String

getFirstName

public String getFirstName()

Get the first name of the author.

Returns:

String

getInitials

public String getInitials()

Get the initials of the author.

Returns:

String

getLastName

public String getLastName()

Get the last name of the author.

Returns:

String

getName

public String getName()

Get the full name of the author, usually as a String of "firstName lastName".

Returns:

String

Since:

1.1.1.

getPhoneNumber

public String getPhoneNumber()

Get the telephone number of the author.

Returns:

String

getPosition

public String getPosition()

Get the position of the author.

Returns:

String

getPostalCode

public String getPostalCode()

Get the postal code of the address of the author.

Returns:

String

getState

public String getState()

Get the state or province of the address of the author, if applicable.

Returns:

String

getStreet

public String getStreet()

Get the street name of the address of the author.

Returns:

String

getTitle

public String getTitle()

Get the title of the author.

Returns:

String

hashCode

public int hashCode()

Method hashCode.

Overrides:

hashCode in class Object

Returns:

int

setCity

public void setCity(String city)

Set the city name of the address of the author.

Parameters:

city -

setCompanyName

public void setCompanyName(String companyName)

Set the name of the company that employs the author.

Parameters:

companyName -

setCountry

public void setCountry(String country)

Set the country of the address of the author.

Parameters:

country -

setEmail

public void setEmail(String email)

Set the email address of the author.

Parameters:

email -

setFaxNumber

public void setFaxNumber(String faxNumber)

Set the fax number of the author.

Parameters:

faxNumber -

setFirstName

public void setFirstName(String firstName)

Set the first name of the author.

Parameters:

firstName -

setInitials

public void setInitials(String initials)

Set the initials of the author.

Parameters:

initials -

setLastName

public void setLastName(String lastName)

Set the last name of the author.

Parameters:

lastName -

setName

public void setName(String name)

Set the full name of the author, usually as a String of "firstName lastName".

Parameters:

name -

Since:

1.1.1.

setPhoneNumber

public void setPhoneNumber(String phoneNumber)

Set the telephone number of the author.

Parameters:

phoneNumber -

setPosition

public void setPosition(String position)

Set the position of the author.

Parameters:

position -

setPostalCode

public void setPostalCode(String postalCode)

Set the postal code of the address of the author.

Parameters:

postalCode -

setState

public void setState(String state)

Set the state or province of the address of the author, if applicable.

Parameters:

state -

setStreet

public void setStreet(String street)

Set the street name of the address of the author.

Parameters:

street -

setTitle

public void setTitle(String title)

Set the title of the author.

Parameters:

title -

toString

public String toString()

Method toString.

Overrides:

toString in class Object

Returns:

String

getFullName

public String getFullName()

Get the full name of the author.

Returns:

name if defined, firsName lastName otherwise.

Since:

1.1.1

See Also:

getName(), getFirstName(), getLastName()