org.apache.maven.doxia.document
Class DocumentCover

java.lang.Object
  extended by 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.lang.String getAllAuthorNames()
           
 java.lang.String getAuthor()
          Get A shortcut for the unique author that appears on the cover page.
 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.lang.String getCoverdate()
          Get the date to appear on the cover.
 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 getModelEncoding()
           
 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 setAuthor(java.lang.String author)
          Set A shortcut for the unique author that appears on the cover page.
 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 setCoverdate(java.lang.String coverdate)
          Set The date as String (recommended format is ISO 8601) 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 setModelEncoding(java.lang.String modelEncoding)
           
 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 -

getAuthor

public java.lang.String getAuthor()
Get A shortcut for the unique author that appears on the cover page. For more authors, you could use the <authors/> tag.

Since:
1.1.1

getAuthors

public java.util.List getAuthors()
Method getAuthors


getCompanyLogo

public java.lang.String getCompanyLogo()
Get The location of an image file that represents the company logo.


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.


getCoverDate

public java.util.Date getCoverDate()
Get The date to appear on the cover. Use the ISO 8601 format "yyyy-MM-dd'T'HH:mm:ss.SSS" in xml.


getCoverSubTitle

public java.lang.String getCoverSubTitle()
Get a sub-title to appear on the cover.


getCoverTitle

public java.lang.String getCoverTitle()
Get The title to appear on the cover.


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.).


getCoverVersion

public java.lang.String getCoverVersion()
Get The version of the project that appears on the cover page.


getProjectLogo

public java.lang.String getProjectLogo()
Get The location of an image file that represents the project logo.


getProjectName

public java.lang.String getProjectName()
Get The name of the project.


hashCode

public int hashCode()
Method hashCode

Overrides:
hashCode in class java.lang.Object

removeAuthor

public void removeAuthor(DocumentAuthor documentAuthor)
Method removeAuthor

Parameters:
documentAuthor -

setAuthor

public void setAuthor(java.lang.String author)
Set A shortcut for the unique author that appears on the cover page. For more authors, you could use the <authors/> tag.

Parameters:
author -
Since:
1.1.1

setAuthors

public void setAuthors(java.util.List authors)
Set The authors that appear on the cover page. Only used if author is not given.

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. Use the ISO 8601 format "yyyy-MM-dd'T'HH:mm:ss.SSS" in xml.

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 -

setCoverdate

public void setCoverdate(java.lang.String coverdate)
Set The date as String (recommended format is ISO 8601) to appear on the cover. Only used if coverDate is not set.

Parameters:
coverdate -
Since:
1.1.1

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

getAllAuthorNames

public java.lang.String getAllAuthorNames()
Returns:
getAuthor() if the unique author name is defined. Otherwise, return all authors full names comma separated.
Since:
1.1.1
See Also:
getAuthor(), getAuthors()

getCoverdate

public java.lang.String getCoverdate()
Get the date to appear on the cover.

Returns:
the getCoverDate() if setted, formatted using ISO-8601 English format, otherwise return the coverdate.
Since:
1.1.1
See Also:
getCoverDate()

setModelEncoding

public void setModelEncoding(java.lang.String modelEncoding)

getModelEncoding

public java.lang.String getModelEncoding()


Copyright © 2005-2010 Apache Software Foundation. All Rights Reserved.