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:
  • Field Details

    • outputName

      private String outputName
      The name of the generated document, without extension.
    • meta

      private DocumentMeta meta
      The Meta information properties.
    • toc

      private DocumentTOC toc
      The TOC (Table of Contents) information properties.
    • cover

      private DocumentCover cover
      The meta data to construct a cover page for the document.
    • modelEncoding

      private String modelEncoding
      Field modelEncoding.
  • Constructor Details

    • DocumentModel

      public DocumentModel()
  • Method Details

    • equals

      public boolean equals(Object other)
      Method equals.
      Overrides:
      equals in class Object
      Parameters:
      other - a other object.
      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 - a cover object.
    • setMeta

      public void setMeta(DocumentMeta meta)
      Set the Meta information properties.
      Parameters:
      meta - a meta object.
    • setModelEncoding

      public void setModelEncoding(String modelEncoding)
      Set the modelEncoding field.
      Parameters:
      modelEncoding - a modelEncoding object.
    • setOutputName

      public void setOutputName(String outputName)
      Set the name of the generated document, without extension.
      Parameters:
      outputName - a outputName object.
    • setToc

      public void setToc(DocumentTOC toc)
      Set the TOC (Table of Contents) information properties.
      Parameters:
      toc - a toc object.
    • toString

      public String toString()
      Method toString.
      Overrides:
      toString in class Object
      Returns:
      String