Package org.apache.maven.doxia.document
Class DocumentCover
java.lang.Object
org.apache.maven.doxia.document.DocumentCover
- All Implemented Interfaces:
Serializable
Contains meta-data information for the document cover page.
- Version:
- $Revision$ $Date$
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate String
A shortcut for the unique author that appears on the cover page.private List<DocumentAuthor>
Field authors.private String
The location of an image file that represents the company logo.private String
The name of the entity that is responsible for the content of the document, or a copyright holder.private String
The date as String (recommended format is ISO 8601) to appear on the cover.private Date
The date to appear on the cover.private String
a sub-title to appear on the cover.private String
The title to appear on the cover.private String
The type of the document.private String
The version of the project that appears on the cover page.private static final DateFormat
ISO 8601 date format, i.e.private String
The location of an image file that represents the project logo.private String
The name of the project. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
addAuthor
(DocumentAuthor documentAuthor) Method addAuthor.boolean
Method equals.Get a shortcut for the unique author that appears on the cover page.Method getAuthors.Get the location of an image file that represents the company logo.Get the name of the entity that is responsible for the content of the document, or a copyright holder.Get the date to appear on the cover.Get the date to appear on the cover.Get a sub-title to appear on the cover.Get the title to appear on the cover.Get the type of the document.Get the version of the project that appears on the cover page.Get the location of an image file that represents the project logo.Get the name of the project.int
hashCode()
Method hashCode.void
removeAuthor
(DocumentAuthor documentAuthor) Method removeAuthor.void
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
(String coverdate) Set the date as String (recommended format is ISO 8601) to appear on the cover.void
setCoverDate
(Date coverDate) Set the date 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.toString()
Method toString.
-
Field Details
-
coverTitle
The title to appear on the cover. -
coverSubTitle
a sub-title to appear on the cover. -
coverVersion
The version of the project that appears on the cover page. -
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
The date to appear on the cover. Use the ISO 8601 format "yyyy-MM-dd'T'HH:mm:ss.SSS" in xml. -
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
Field authors. -
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
The name of the project. -
projectLogo
The location of an image file that represents the project logo. -
companyName
The name of the entity that is responsible for the content of the document, or a copyright holder. -
companyLogo
The location of an image file that represents the company logo. -
ISO_8601_FORMAT
ISO 8601 date format, i.e.yyyy-MM-dd
-
-
Constructor Details
-
DocumentCover
public DocumentCover()
-
-
Method Details
-
addAuthor
Method addAuthor.- Parameters:
documentAuthor
- a documentAuthor object.
-
equals
Method equals. -
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
Method getAuthors.- Returns:
- List
-
getCompanyLogo
Get the location of an image file that represents the company logo.- Returns:
- String
-
getCompanyName
Get the name of the entity that is responsible for the content of the document, or a copyright holder.- Returns:
- String
-
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
Get a sub-title to appear on the cover.- Returns:
- String
-
getCoverTitle
Get the title to appear on the cover.- Returns:
- 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
Get the version of the project that appears on the cover page.- Returns:
- String
-
getProjectLogo
Get the location of an image file that represents the project logo.- Returns:
- String
-
getProjectName
Get the name of the project.- Returns:
- String
-
hashCode
public int hashCode()Method hashCode. -
removeAuthor
Method removeAuthor.- Parameters:
documentAuthor
- a documentAuthor object.
-
setAuthor
Set a shortcut for the unique author that appears on the cover page. For more authors, you could use the <authors/> tag.- Parameters:
author
- a author object.- Since:
- 1.1.1.
-
setAuthors
Set the authors that appear on the cover page. Only used if author is not given.- Parameters:
authors
- a authors object.
-
setCompanyLogo
Set the location of an image file that represents the company logo.- Parameters:
companyLogo
- a companyLogo object.
-
setCompanyName
Set the name of the entity that is responsible for the content of the document, or a copyright holder.- Parameters:
companyName
- a companyName object.
-
setCoverDate
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
- a coverDate object.
-
setCoverSubTitle
Set a sub-title to appear on the cover.- Parameters:
coverSubTitle
- a coverSubTitle object.
-
setCoverTitle
Set the title to appear on the cover.- Parameters:
coverTitle
- a coverTitle object.
-
setCoverType
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
- a coverType object.
-
setCoverVersion
Set the version of the project that appears on the cover page.- Parameters:
coverVersion
- a coverVersion object.
-
setCoverdate
Set the date as String (recommended format is ISO 8601) to appear on the cover. Only used ifcoverDate
is not set.- Parameters:
coverdate
- a coverdate object.- Since:
- 1.1.1.
-
setProjectLogo
Set the location of an image file that represents the project logo.- Parameters:
projectLogo
- a projectLogo object.
-
setProjectName
Set the name of the project.- Parameters:
projectName
- a projectName object.
-
toString
Method toString. -
getAllAuthorNames
- Returns:
getAuthor()
if the unique author name is defined. Otherwise, return all authors full names comma separated.- Since:
- 1.1.1
- See Also:
-
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:
-