|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.maven.doxia.document.DocumentCover
public class DocumentCover
Contains meta-data information for the document cover page.
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 |
---|
public DocumentCover()
Method Detail |
---|
public void addAuthor(DocumentAuthor documentAuthor)
documentAuthor
- public boolean equals(Object other)
equals
in class Object
other
-
public String getAuthor()
public List<DocumentAuthor> getAuthors()
public String getCompanyLogo()
public String getCompanyName()
public Date getCoverDate()
public String getCoverSubTitle()
public String getCoverTitle()
public String getCoverType()
public String getCoverVersion()
public String getProjectLogo()
public String getProjectName()
public int hashCode()
hashCode
in class Object
public void removeAuthor(DocumentAuthor documentAuthor)
documentAuthor
- public void setAuthor(String author)
author
- public void setAuthors(List<DocumentAuthor> authors)
authors
- public void setCompanyLogo(String companyLogo)
companyLogo
- public void setCompanyName(String companyName)
companyName
- public void setCoverDate(Date coverDate)
coverDate
- public void setCoverSubTitle(String coverSubTitle)
coverSubTitle
- public void setCoverTitle(String coverTitle)
coverTitle
- public void setCoverType(String coverType)
coverType
- public void setCoverVersion(String coverVersion)
coverVersion
- public void setCoverdate(String coverdate)
coverDate
is not set.
coverdate
- public void setProjectLogo(String projectLogo)
projectLogo
- public void setProjectName(String projectName)
projectName
- public String toString()
toString
in class Object
public String getAllAuthorNames()
getAuthor()
if the unique author name is defined. Otherwise, return all authors full names
comma separated.getAuthor()
,
getAuthors()
public String getCoverdate()
getCoverDate()
if setted, formatted using ISO-8601 English format, otherwise return
the coverdate
.getCoverDate()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |