org.apache.maven.doxia.document

Class DocumentModel

java.lang.Object

org.apache.maven.doxia.document.DocumentModel

All Implemented Interfaces:

Serializable

public class DocumentModel
extends Object
implements Serializable

Describes the overall document model.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DocumentModel()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object other) Method equals.
DocumentCover	getCover() Get the meta data to construct a cover page for the document.
DocumentMeta	getMeta() Get the Meta information properties.
String	getModelEncoding() Get the modelEncoding field.
String	getOutputName() Get the name of the generated document, without extension.
DocumentTOC	getToc() Get the TOC (Table of Contents) information properties.
int	hashCode() Method hashCode.
void	setCover(DocumentCover cover) Set the meta data to construct a cover page for the document.
void	setMeta(DocumentMeta meta) Set the Meta information properties.
void	setModelEncoding(String modelEncoding) Set the modelEncoding field.
void	setOutputName(String outputName) Set the name of the generated document, without extension.
void	setToc(DocumentTOC toc) Set the TOC (Table of Contents) information properties.
String	toString() Method toString.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DocumentModel

public DocumentModel()

Method Detail

equals

public boolean equals(Object other)

Method equals.

Overrides:

equals in class Object

Parameters:

other -

Returns:

boolean

getCover

public DocumentCover getCover()

Get the meta data to construct a cover page for the document.

Returns:

DocumentCover

getMeta

public DocumentMeta getMeta()

Get the Meta information properties.

Returns:

DocumentMeta

getModelEncoding

public String getModelEncoding()

Get the modelEncoding field.

Returns:

String

getOutputName

public String getOutputName()

Get the name of the generated document, without extension.

Returns:

String

getToc

public DocumentTOC getToc()

Get the TOC (Table of Contents) information properties.

Returns:

DocumentTOC

hashCode

public int hashCode()

Method hashCode.

Overrides:

hashCode in class Object

Returns:

int

setCover

public void setCover(DocumentCover cover)

Set the meta data to construct a cover page for the document.

Parameters:

cover -

setMeta

public void setMeta(DocumentMeta meta)

Set the Meta information properties.

Parameters:

meta -

setModelEncoding

public void setModelEncoding(String modelEncoding)

Set the modelEncoding field.

Parameters:

modelEncoding -

setOutputName

public void setOutputName(String outputName)

Set the name of the generated document, without extension.

Parameters:

outputName -

setToc

public void setToc(DocumentTOC toc)

Set the TOC (Table of Contents) information properties.

Parameters:

toc -

toString

public String toString()

Method toString.

Overrides:

toString in class Object

Returns:

String