public class DocumentCover
extends java.lang.Object
implements java.io.Serializable
Modifier and Type | Field and 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 and Description |
---|
DocumentCover() |
Modifier and Type | Method and 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.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 |
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.
|
private java.lang.String coverTitle
private java.lang.String coverSubTitle
private java.lang.String coverVersion
private java.lang.String coverType
private java.util.Date coverDate
private java.lang.String coverdate
coverDate
is not set.private java.util.List<DocumentAuthor> authors
private java.lang.String author
private java.lang.String projectName
private java.lang.String projectLogo
private java.lang.String companyName
private java.lang.String companyLogo
private static final java.text.DateFormat ISO_8601_FORMAT
yyyy-MM-dd
public void addAuthor(DocumentAuthor documentAuthor)
documentAuthor
- public boolean equals(java.lang.Object other)
equals
in class java.lang.Object
other
- public java.lang.String getAuthor()
public java.util.List<DocumentAuthor> getAuthors()
public java.lang.String getCompanyLogo()
public java.lang.String getCompanyName()
public java.util.Date getCoverDate()
public java.lang.String getCoverSubTitle()
public java.lang.String getCoverTitle()
public java.lang.String getCoverType()
public java.lang.String getCoverVersion()
public java.lang.String getProjectLogo()
public java.lang.String getProjectName()
public int hashCode()
hashCode
in class java.lang.Object
public void removeAuthor(DocumentAuthor documentAuthor)
documentAuthor
- public void setAuthor(java.lang.String author)
author
- public void setAuthors(java.util.List<DocumentAuthor> authors)
authors
- public void setCompanyLogo(java.lang.String companyLogo)
companyLogo
- public void setCompanyName(java.lang.String companyName)
companyName
- public void setCoverDate(java.util.Date coverDate)
coverDate
- public void setCoverSubTitle(java.lang.String coverSubTitle)
coverSubTitle
- public void setCoverTitle(java.lang.String coverTitle)
coverTitle
- public void setCoverType(java.lang.String coverType)
coverType
- public void setCoverVersion(java.lang.String coverVersion)
coverVersion
- public void setCoverdate(java.lang.String coverdate)
coverDate
is not set.coverdate
- public void setProjectLogo(java.lang.String projectLogo)
projectLogo
- public void setProjectName(java.lang.String projectName)
projectName
- public java.lang.String toString()
toString
in class java.lang.Object
public java.lang.String getAllAuthorNames()
getAuthor()
if the unique author name is defined. Otherwise, return all authors full names
comma separated.getAuthor()
,
getAuthors()
public java.lang.String getCoverdate()
getCoverDate()
if setted, formatted using ISO-8601 English format, otherwise return
the coverdate
.getCoverDate()