org.apache.maven.doxia.document
Class DocumentCover

java.lang.Object
  extended by org.apache.maven.doxia.document.DocumentCover
All Implemented Interfaces:
Serializable

public class DocumentCover
extends Object
implements 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(Object other)
          Method equals.
 String getAllAuthorNames()
           
 String getAuthor()
          Get a shortcut for the unique author that appears on the cover page.
 List<DocumentAuthor> getAuthors()
          Method getAuthors.
 String getCompanyLogo()
          Get the location of an image file that represents the company logo.
 String getCompanyName()
          Get the name of the entity that is responsible for the content of the document, or a copyright holder.
 String getCoverdate()
          Get the date to appear on the cover.
 Date getCoverDate()
          Get the date to appear on the cover.
 String getCoverSubTitle()
          Get a sub-title to appear on the cover.
 String getCoverTitle()
          Get the title to appear on the cover.
 String getCoverType()
          Get the type of the document.
 String getCoverVersion()
          Get the version of the project that appears on the cover page.
 String getProjectLogo()
          Get the location of an image file that represents the project logo.
 String getProjectName()
          Get the name of the project.
 int hashCode()
          Method hashCode.
 void removeAuthor(DocumentAuthor documentAuthor)
          Method removeAuthor.
 void setAuthor(String author)
          Set a shortcut for the unique author that appears on the cover page.
 void setAuthors(List<DocumentAuthor> authors)
          Set the authors that appear on the cover page.
 void setCompanyLogo(String companyLogo)
          Set the location of an image file that represents the company logo.
 void setCompanyName(String companyName)
          Set the name of the entity that is responsible for the content of the document, or a copyright holder.
 void setCoverDate(Date coverDate)
          Set the date to appear on the cover.
 void setCoverdate(String coverdate)
          Set the date as String (recommended format is ISO 8601) to appear on the cover.
 void setCoverSubTitle(String coverSubTitle)
          Set a sub-title to appear on the cover.
 void setCoverTitle(String coverTitle)
          Set the title to appear on the cover.
 void setCoverType(String coverType)
          Set the type of the document.
 void setCoverVersion(String coverVersion)
          Set the version of the project that appears on the cover page.
 void setProjectLogo(String projectLogo)
          Set the location of an image file that represents the project logo.
 void setProjectName(String projectName)
          Set the name of the project.
 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(Object other)
Method equals.

Overrides:
equals in class Object
Parameters:
other -
Returns:
boolean

getAuthor

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

Returns:
String
Since:
1.1.1.

getAuthors

public List<DocumentAuthor> getAuthors()
Method getAuthors.

Returns:
List

getCompanyLogo

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

Returns:
String

getCompanyName

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

Returns:
Date

getCoverSubTitle

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

Returns:
String

getCoverTitle

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

Returns:
String

getCoverType

public 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 String getCoverVersion()
Get the version of the project that appears on the cover page.

Returns:
String

getProjectLogo

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

Returns:
String

getProjectName

public String getProjectName()
Get the name of the project.

Returns:
String

hashCode

public int hashCode()
Method hashCode.

Overrides:
hashCode in class Object
Returns:
int

removeAuthor

public void removeAuthor(DocumentAuthor documentAuthor)
Method removeAuthor.

Parameters:
documentAuthor -

setAuthor

public void setAuthor(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(List<DocumentAuthor> authors)
Set the authors that appear on the cover page. Only used if author is not given.

Parameters:
authors -

setCompanyLogo

public void setCompanyLogo(String companyLogo)
Set the location of an image file that represents the company logo.

Parameters:
companyLogo -

setCompanyName

public void setCompanyName(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(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(String coverSubTitle)
Set a sub-title to appear on the cover.

Parameters:
coverSubTitle -

setCoverTitle

public void setCoverTitle(String coverTitle)
Set the title to appear on the cover.

Parameters:
coverTitle -

setCoverType

public void setCoverType(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(String coverVersion)
Set the version of the project that appears on the cover page.

Parameters:
coverVersion -

setCoverdate

public void setCoverdate(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(String projectLogo)
Set the location of an image file that represents the project logo.

Parameters:
projectLogo -

setProjectName

public void setProjectName(String projectName)
Set the name of the project.

Parameters:
projectName -

toString

public String toString()
Method toString.

Overrides:
toString in class Object
Returns:
String

getAllAuthorNames

public 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 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()


Copyright © 2005-2012 The Apache Software Foundation. All Rights Reserved.