org.apache.maven.doxia.document
Class DocumentCover

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

All Implemented Interfaces:

java.io.Serializable

public class DocumentCover
extends java.lang.Object
implements java.io.Serializable

Contains meta-data information for the document cover page.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

DocumentCover()

Method Summary

void	addAuthor(DocumentAuthor documentAuthor) Method addAuthor.
boolean	equals(java.lang.Object other) Method equals.
java.util.List	getAuthors() Method getAuthors.
java.lang.String	getCompanyLogo() Get The location of an image file that represents the company logo.
java.lang.String	getCompanyName() Get The name of the entity that is responsible for the content of the document, or a copyright holder.
java.util.Date	getCoverDate() Get The date to appear on the cover.
java.lang.String	getCoverSubTitle() Get a sub-title to appear on the cover.
java.lang.String	getCoverTitle() Get The title to appear on the cover.
java.lang.String	getCoverType() Get The type of the document.
java.lang.String	getCoverVersion() Get The version of the project that appears on the cover page.
java.lang.String	getProjectLogo() Get The location of an image file that represents the project logo.
java.lang.String	getProjectName() Get The name of the project.
int	hashCode() Method hashCode.
void	removeAuthor(DocumentAuthor documentAuthor) Method removeAuthor.
void	setAuthors(java.util.List authors) Set The authors that appear on the cover page.
void	setCompanyLogo(java.lang.String companyLogo) Set The location of an image file that represents the company logo.
void	setCompanyName(java.lang.String companyName) Set The name of the entity that is responsible for the content of the document, or a copyright holder.
void	setCoverDate(java.util.Date coverDate) Set The date to appear on the cover.
void	setCoverSubTitle(java.lang.String coverSubTitle) Set a sub-title to appear on the cover.
void	setCoverTitle(java.lang.String coverTitle) Set The title to appear on the cover.
void	setCoverType(java.lang.String coverType) Set The type of the document.
void	setCoverVersion(java.lang.String coverVersion) Set The version of the project that appears on the cover page.
void	setProjectLogo(java.lang.String projectLogo) Set The location of an image file that represents the project logo.
void	setProjectName(java.lang.String projectName) Set The name of the project.
java.lang.String	toString() Method toString.

Methods inherited from class java.lang.Object

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

Constructor Detail

DocumentCover

public DocumentCover()

Method Detail

addAuthor

public void addAuthor(DocumentAuthor documentAuthor)

Method addAuthor.

Parameters:

documentAuthor -

equals

public boolean equals(java.lang.Object other)

Method equals.

Overrides:

equals in class java.lang.Object

Parameters:

other -

Returns:

boolean

getAuthors

public java.util.List getAuthors()

Method getAuthors.

Returns:

List

getCompanyLogo

public java.lang.String getCompanyLogo()

Get The location of an image file that represents the company logo.

Returns:

String

getCompanyName

public java.lang.String getCompanyName()

Get The name of the entity that is responsible for the content of the document, or a copyright holder.

Returns:

String

getCoverDate

public java.util.Date getCoverDate()

Get The date to appear on the cover.

Returns:

Date

getCoverSubTitle

public java.lang.String getCoverSubTitle()

Get a sub-title to appear on the cover.

Returns:

String

getCoverTitle

public java.lang.String getCoverTitle()

Get The title to appear on the cover.

Returns:

String

getCoverType

public java.lang.String getCoverType()

Get The type of the document. This might be used on the cover page to specify the type of information contained in the document (eg 'User Guide', 'Manual', etc.).

Returns:

String

getCoverVersion

public java.lang.String getCoverVersion()

Get The version of the project that appears on the cover page.

Returns:

String

getProjectLogo

public java.lang.String getProjectLogo()

Get The location of an image file that represents the project logo.

Returns:

String

getProjectName

public java.lang.String getProjectName()

Get The name of the project.

Returns:

String

hashCode

public int hashCode()

Method hashCode.

Overrides:

hashCode in class java.lang.Object

Returns:

int

removeAuthor

public void removeAuthor(DocumentAuthor documentAuthor)

Method removeAuthor.

Parameters:

documentAuthor -

setAuthors

public void setAuthors(java.util.List authors)

Set The authors that appear on the cover page.

Parameters:

authors -

setCompanyLogo

public void setCompanyLogo(java.lang.String companyLogo)

Set The location of an image file that represents the company logo.

Parameters:

companyLogo -

setCompanyName

public void setCompanyName(java.lang.String companyName)

Set The name of the entity that is responsible for the content of the document, or a copyright holder.

Parameters:

companyName -

setCoverDate

public void setCoverDate(java.util.Date coverDate)

Set The date to appear on the cover.

Parameters:

coverDate -

setCoverSubTitle

public void setCoverSubTitle(java.lang.String coverSubTitle)

Set a sub-title to appear on the cover.

Parameters:

coverSubTitle -

setCoverTitle

public void setCoverTitle(java.lang.String coverTitle)

Set The title to appear on the cover.

Parameters:

coverTitle -

setCoverType

public void setCoverType(java.lang.String coverType)

Set The type of the document. This might be used on the cover page to specify the type of information contained in the document (eg 'User Guide', 'Manual', etc.).

Parameters:

coverType -

setCoverVersion

public void setCoverVersion(java.lang.String coverVersion)

Set The version of the project that appears on the cover page.

Parameters:

coverVersion -

setProjectLogo

public void setProjectLogo(java.lang.String projectLogo)

Set The location of an image file that represents the project logo.

Parameters:

projectLogo -

setProjectName

public void setProjectName(java.lang.String projectName)

Set The name of the project.

Parameters:

projectName -

toString

public java.lang.String toString()

Method toString.

Overrides:

toString in class java.lang.Object

Returns:

String