Serialized Form

  • Package org.apache.maven.doxia.document

    • Class org.apache.maven.doxia.document.DocumentAuthor

      class DocumentAuthor extends Object implements Serializable
      • Serialized Fields

        • city
          String city
          The city name of the address of the author.
        • companyName
          String companyName
          The name of the company that employs the author.
        • country
          String country
          The country of the address of the author.
        • email
          String email
          The email address of the author.
        • faxNumber
          String faxNumber
          The fax number of the author.
        • firstName
          String firstName
          The first name of the author.
        • initials
          String initials
          The initials of the author.
        • lastName
          String lastName
          The last name of the author.
        • name
          String name
          The full name of the author, usually as a String of "firstName lastName".
          Since:
          1.1.1 .
        • phoneNumber
          String phoneNumber
          The telephone number of the author.
        • position
          String position
          The position of the author.
        • postalCode
          String postalCode
          The postal code of the address of the author.
        • state
          String state
          The state or province of the address of the author, if applicable.
        • street
          String street
          The street name of the address of the author.
        • title
          String title
          The title of the author.
    • Class org.apache.maven.doxia.document.DocumentCover

      class DocumentCover extends Object implements Serializable
      • Serialized Fields

        • author
          String author
          A shortcut for the unique author that appears on the cover page. For more authors, you could use the <authors/> tag.
          Since:
          1.1.1 .
        • authors
          List<DocumentAuthor> authors
          Field authors.
        • companyLogo
          String companyLogo
          The location of an image file that represents the company logo.
        • companyName
          String companyName
          The name of the entity that is responsible for the content of the document, or a copyright holder.
        • coverdate
          String coverdate
          The date as String (recommended format is ISO 8601) to appear on the cover. Only used if coverDate is not set.
          Since:
          1.1.1 .
        • coverDate
          Date coverDate
          The date to appear on the cover. Use the ISO 8601 format "yyyy-MM-dd'T'HH:mm:ss.SSS" in xml.
        • coverSubTitle
          String coverSubTitle
          a sub-title to appear on the cover.
        • coverTitle
          String coverTitle
          The title to appear on the cover.
        • coverType
          String coverType
          The type of the document. This might be used on the cover page to specify the type of information contained in the document (eg 'User Guide', 'Manual', etc.).
        • coverVersion
          String coverVersion
          The version of the project that appears on the cover page.
        • projectLogo
          String projectLogo
          The location of an image file that represents the project logo.
        • projectName
          String projectName
          The name of the project.
    • Class org.apache.maven.doxia.document.DocumentHyperlinkBehaviour

      class DocumentHyperlinkBehaviour extends Object implements Serializable
      • Serialized Fields

        • targetFrame
          String targetFrame
          The name of the default target frame.

          Specifies the name of the default target frame in which to display a document referenced by a hyperlink.

          This attribute can have one of the following values:

          _self
          The referenced document replaces the content of the current frame.
          _blank
          The referenced document is displayed in a new frame.
          _parent
          The referenced document is displayed in the parent frame of the current frame.
          _top
          The referenced document is displayed in the topmost frame, that is the frame that contains the current frame as a child or descendent but is not contained within another frame.
          A frame name
          The referenced document is displayed in the named frame. If the named frame does not exist, a new frame with that name is created.
    • Class org.apache.maven.doxia.document.DocumentMeta

      class DocumentMeta extends Object implements Serializable
      • Serialized Fields

        • author
          String author
          The unique author of the document, usually as a String of "firstName lastName". For more authors, you could use the <authors/> tag.
        • authors
          List<DocumentAuthor> authors
          Field authors.
        • confidential
          boolean confidential
          whether the content of the document is in some sense confidential.
        • creationdate
          String creationdate
          The date as String (recommended format is ISO 8601) when the document was created initially. Only used if creationDate is not set.
          Since:
          1.1.1 .
        • creationDate
          Date creationDate
          The date and time when the document was created initially. Use the ISO 8601 format "yyyy-MM-dd'T'HH:mm:ss.SSS" in xml.
        • creator
          String creator
          The name of the person who last modified the document.
        • date
          Date date
          The date and time when the document was last modified. Use the ISO 8601 format "yyyy-MM-dd'T'HH:mm:ss.SSS" in xml.
        • description
          String description
          A brief description of the document.
        • documentStatistic
          DocumentStatistic documentStatistic
          The statistics of the document, for example, the page count, word count, etc.
        • draft
          boolean draft
          whether the content of the document is in some sense preliminary.
        • editingCycles
          long editingCycles
          The number of editing cycles the document has been through.
        • editingDuration
          long editingDuration
          The total time spent editing the document.
        • generator
          String generator
          A string that identifies the application or tool that was used to create or last modify the document.
        • hyperlinkBehaviour
          DocumentHyperlinkBehaviour hyperlinkBehaviour
          The hyperlink-behaviour element specifies the default behavior for hyperlinks in the document.
        • initialCreator
          String initialCreator
          The name of the person who created the document initially.
        • keywords
          String keywords
          Deprecated.
          use the <keyWords/> tag instead of.
          The keywords for the document, usually as a String of comma separated keywords.
        • keyWords
          List<String> keyWords
          Field keyWords.
        • language
          String language
          The default language of the document. The language is represented by a two or three letter Language Code taken from the ISO 639 standard, optionally followed by a hyphen (-) and a two-letter Country Code taken from the ISO 3166 standard.
        • modifydate
          String modifydate
          The date as String (recommended format is ISO 8601) when the document was last modified. Only used if date is not set.
          Since:
          1.1.1 .
        • pageSize
          String pageSize
          The pagesize of the document. At least "US", "USLetter" and "A4" should be supported.
        • printdate
          String printdate
          The date as String (recommended format is ISO 8601) when the document was last printed. Only used if printDate is not set.
          Since:
          1.1.1 .
        • printDate
          Date printDate
          The date and time when the document was last printed. Use the ISO 8601 format "yyyy-MM-dd'T'HH:mm:ss.SSS" in xml.
        • printedBy
          String printedBy
          The name of the person who last printed the document.
        • subject
          String subject
          The subject of the document.
        • template
          DocumentTemplate template
          A template that was used to create the document.
        • title
          String title
          The title of the document.
    • Class org.apache.maven.doxia.document.DocumentModel

      class DocumentModel extends Object implements Serializable
      • Serialized Fields

        • cover
          DocumentCover cover
          The meta data to construct a cover page for the document.
        • meta
          DocumentMeta meta
          The Meta information properties.
        • modelEncoding
          String modelEncoding
          Field modelEncoding.
        • outputName
          String outputName
          The name of the generated document, without extension.
        • toc
          DocumentTOC toc
          The TOC (Table of Contents) information properties.
    • Class org.apache.maven.doxia.document.DocumentStatistic

      class DocumentStatistic extends Object implements Serializable
      • Serialized Fields

        • characterCount
          long characterCount
          The number of characters in the document.
        • drawCount
          long drawCount
          The number of drawings in the document.
        • frameCount
          long frameCount
          The number of frames in the document.
        • imageCount
          long imageCount
          The number of images in the document.
        • nonWhitespaceCharacterCount
          long nonWhitespaceCharacterCount
          The number of non-whitespace-characters in the document.
        • objectCount
          long objectCount
          The number of objects in the document.
        • oleObjectCount
          long oleObjectCount
          The number of ole-objects in the document.
        • pageCount
          long pageCount
          The number of pages in the document.
        • paragraphCount
          long paragraphCount
          The number of paragraphs in the document.
        • rowCount
          long rowCount
          The number of rows in the document.
        • sentenceCount
          long sentenceCount
          The number of sentences in the document.
        • syllableCount
          long syllableCount
          The number of syllables in the document.
        • tableCount
          long tableCount
          The number of tabels in the document.
        • wordCount
          long wordCount
          The number of words in the document.
    • Class org.apache.maven.doxia.document.DocumentTemplate

      class DocumentTemplate extends Object implements Serializable
      • Serialized Fields

        • date
          Date date
          The date and time when the template was last modified, prior to being used to create the current document. Use the ISO 8601 format "yyyy-MM-dd'T'HH:mm:ss.SSS" in xml.
        • href
          String href
          The location of the document template.
        • modifydate
          String modifydate
          The date as String (recommended format is ISO 8601) when the template was last modified. Only used if date is not set.
          Since:
          1.1.1 .
        • title
          String title
          The name of the document template.
    • Class org.apache.maven.doxia.document.DocumentTOC

      class DocumentTOC extends Object implements Serializable
      • Serialized Fields

        • depth
          int depth
          The level up to which toc items are included by default. Defaults to 0 which means only top-level element entries are included. A depth of 1 includes one level of sub-items (sub-sections), etc. This may be overridden for individual entries by using the collapse attribute of the corresponding toc item.
        • items
          List<DocumentTOCItem> items
          Field items.
        • name
          String name
          The name to use for the Table of Contents.
    • Class org.apache.maven.doxia.document.DocumentTOCItem

      class DocumentTOCItem extends Object implements Serializable
      • Serialized Fields

        • collapse
          boolean collapse
          Whether to show any child elements of a TOCItem, overriding the depth given in DocumentTOC. By default, all children are expanded up to the depth given in DocumentTOC.
        • items
          List<DocumentTOCItem> items
          Field items.
        • name
          String name
          The name to use for the toc.
        • ref
          String ref
          The ref to use for the item.
  • Package org.apache.maven.doxia.macro

  • Package org.apache.maven.doxia.macro.manager

  • Package org.apache.maven.doxia.module.apt

  • Package org.apache.maven.doxia.module.fml.model

  • Package org.apache.maven.doxia.parser

    • Exception org.apache.maven.doxia.parser.ParseException

      class ParseException extends Exception implements Serializable
      serialVersionUID:
      295967936746221567L
      • Serialized Fields

        • columnNumber
          int columnNumber
          Column number where the parse exception occurred.
        • fileName
          String fileName
          The file that caused the ParseException.
        • lineNumber
          int lineNumber
          Line number where the parse exception occurred.
  • Package org.apache.maven.doxia.parser.manager

  • Package org.apache.maven.doxia.parser.module