org.apache.maven.doxia.document
Class DocumentModel

java.lang.Object
  extended by org.apache.maven.doxia.document.DocumentModel
All Implemented Interfaces:
java.io.Serializable

public class DocumentModel
extends java.lang.Object
implements java.io.Serializable

Describes the overall document model.

Version:
$Revision$ $Date$
See Also:
Serialized Form

Constructor Summary
DocumentModel()
           
 
Method Summary
 boolean equals(java.lang.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.
 java.lang.String getModelEncoding()
           
 java.lang.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(java.lang.String modelEncoding)
           
 void setOutputName(java.lang.String outputName)
          Set The name of the generated document, without extension.
 void setToc(DocumentTOC toc)
          Set The TOC (Table of Contents) information properties.
 java.lang.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(java.lang.Object other)
Method equals

Overrides:
equals in class java.lang.Object
Parameters:
other -

getCover

public DocumentCover getCover()
Get The meta data to construct a cover page for the document.


getMeta

public DocumentMeta getMeta()
Get The Meta information properties.


getOutputName

public java.lang.String getOutputName()
Get The name of the generated document, without extension.


getToc

public DocumentTOC getToc()
Get The TOC (Table of Contents) information properties.


hashCode

public int hashCode()
Method hashCode

Overrides:
hashCode in class java.lang.Object

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 -

setOutputName

public void setOutputName(java.lang.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 java.lang.String toString()
Method toString

Overrides:
toString in class java.lang.Object

setModelEncoding

public void setModelEncoding(java.lang.String modelEncoding)

getModelEncoding

public java.lang.String getModelEncoding()


Copyright © 2005-2010 Apache Software Foundation. All Rights Reserved.