Package org.apache.maven.doxia.document

Class 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

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private DocumentCover cover
      The meta data to construct a cover page for the document.
      private DocumentMeta meta
      The Meta information properties.
      private java.lang.String modelEncoding
      Field modelEncoding.
      private java.lang.String outputName
      The name of the generated document, without extension.
      private DocumentTOC toc
      The TOC (Table of Contents) information properties.

    • Constructor Summary

      Constructors 
      Constructor Description
      DocumentModel()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      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()
      Get the modelEncoding field.
      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)
      Set the modelEncoding field.
      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

    • Field Detail

      • outputName

        private java.lang.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 java.lang.String modelEncoding
        Field modelEncoding.

    • 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 -
        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 java.lang.String getModelEncoding()
        Get the modelEncoding field.
        Returns:
        String

      • getOutputName

        public java.lang.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 java.lang.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​(java.lang.String modelEncoding)
        Set the modelEncoding field.
        Parameters:
        modelEncoding -

      • 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
        Returns:
        String