Package org.apache.maven.doxia.document
Class DocumentModel
java.lang.Object
org.apache.maven.doxia.document.DocumentModel
- All Implemented Interfaces:
Serializable
Describes the overall document model.
- Version:
- $Revision$ $Date$
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate DocumentCoverThe meta data to construct a cover page for the document.private DocumentMetaThe Meta information properties.private StringField modelEncoding.private StringThe name of the generated document, without extension.private DocumentTOCThe TOC (Table of Contents) information properties. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbooleanMethod equals.getCover()Get the meta data to construct a cover page for the document.getMeta()Get the Meta information properties.Get the modelEncoding field.Get the name of the generated document, without extension.getToc()Get the TOC (Table of Contents) information properties.inthashCode()Method hashCode.voidsetCover(DocumentCover cover) Set the meta data to construct a cover page for the document.voidsetMeta(DocumentMeta meta) Set the Meta information properties.voidsetModelEncoding(String modelEncoding) Set the modelEncoding field.voidsetOutputName(String outputName) Set the name of the generated document, without extension.voidsetToc(DocumentTOC toc) Set the TOC (Table of Contents) information properties.toString()Method toString.
-
Field Details
-
outputName
The name of the generated document, without extension. -
meta
The Meta information properties. -
toc
The TOC (Table of Contents) information properties. -
cover
The meta data to construct a cover page for the document. -
modelEncoding
Field modelEncoding.
-
-
Constructor Details
-
DocumentModel
public DocumentModel()
-
-
Method Details
-
equals
Method equals. -
getCover
Get the meta data to construct a cover page for the document.- Returns:
- DocumentCover
-
getMeta
Get the Meta information properties.- Returns:
- DocumentMeta
-
getModelEncoding
Get the modelEncoding field.- Returns:
- String
-
getOutputName
Get the name of the generated document, without extension.- Returns:
- String
-
getToc
Get the TOC (Table of Contents) information properties.- Returns:
- DocumentTOC
-
hashCode
public int hashCode()Method hashCode. -
setCover
Set the meta data to construct a cover page for the document.- Parameters:
cover- a cover object.
-
setMeta
Set the Meta information properties.- Parameters:
meta- a meta object.
-
setModelEncoding
Set the modelEncoding field.- Parameters:
modelEncoding- a modelEncoding object.
-
setOutputName
Set the name of the generated document, without extension.- Parameters:
outputName- a outputName object.
-
setToc
Set the TOC (Table of Contents) information properties.- Parameters:
toc- a toc object.
-
toString
Method toString.
-