Package 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
-
-
Field Summary
Fields Modifier and Type Field Description private java.lang.String
author
A shortcut for the unique author that appears on the cover page.private java.util.List<DocumentAuthor>
authors
Field authors.private java.lang.String
companyLogo
The location of an image file that represents the company logo.private java.lang.String
companyName
The name of the entity that is responsible for the content of the document, or a copyright holder.private java.lang.String
coverdate
The date as String (recommended format is ISO 8601) to appear on the cover.private java.util.Date
coverDate
The date to appear on the cover.private java.lang.String
coverSubTitle
a sub-title to appear on the cover.private java.lang.String
coverTitle
The title to appear on the cover.private java.lang.String
coverType
The type of the document.private java.lang.String
coverVersion
The version of the project that appears on the cover page.private static java.text.DateFormat
ISO_8601_FORMAT
ISO 8601 date format, i.e.private java.lang.String
projectLogo
The location of an image file that represents the project logo.private java.lang.String
projectName
The name of the project.
-
Constructor Summary
Constructors Constructor Description DocumentCover()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description 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<DocumentAuthor>
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
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<DocumentAuthor> 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.lang.String coverdate)
Set the date as String (recommended format is ISO 8601) to appear on the cover.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.
-
-
-
Field Detail
-
coverTitle
private java.lang.String coverTitle
The title to appear on the cover.
-
coverSubTitle
private java.lang.String coverSubTitle
a sub-title to appear on the cover.
-
coverVersion
private java.lang.String coverVersion
The version of the project that appears on the cover page.
-
coverType
private java.lang.String coverType
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.).
-
coverDate
private java.util.Date coverDate
The date to appear on the cover. Use the ISO 8601 format "yyyy-MM-dd'T'HH:mm:ss.SSS" in xml.
-
coverdate
private java.lang.String coverdate
The date as String (recommended format is ISO 8601) to appear on the cover. Only used ifcoverDate
is not set.- Since:
- 1.1.1 .
-
authors
private java.util.List<DocumentAuthor> authors
Field authors.
-
author
private java.lang.String author
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 .
-
projectName
private java.lang.String projectName
The name of the project.
-
projectLogo
private java.lang.String projectLogo
The location of an image file that represents the project logo.
-
companyName
private java.lang.String companyName
The name of the entity that is responsible for the content of the document, or a copyright holder.
-
companyLogo
private java.lang.String companyLogo
The location of an image file that represents the company logo.
-
ISO_8601_FORMAT
private static final java.text.DateFormat ISO_8601_FORMAT
ISO 8601 date format, i.e.yyyy-MM-dd
-
-
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 classjava.lang.Object
- Parameters:
other
-- Returns:
- boolean
-
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.- Returns:
- String
- Since:
- 1.1.1.
-
getAuthors
public java.util.List<DocumentAuthor> 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. Use the ISO 8601 format "yyyy-MM-dd'T'HH:mm:ss.SSS" in xml.- 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 classjava.lang.Object
- Returns:
- int
-
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<DocumentAuthor> 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 ifcoverDate
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 classjava.lang.Object
- Returns:
- String
-
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 thecoverdate
. - Since:
- 1.1.1
- See Also:
getCoverDate()
-
-