Serialized Form
-
Package org.apache.maven.doxia.document
-
Class org.apache.maven.doxia.document.DocumentAuthor extends java.lang.Object implements Serializable
-
Serialized Fields
-
city
java.lang.String city
The city name of the address of the author. -
companyName
java.lang.String companyName
The name of the company that employs the author. -
country
java.lang.String country
The country of the address of the author. -
email
java.lang.String email
The email address of the author. -
faxNumber
java.lang.String faxNumber
The fax number of the author. -
firstName
java.lang.String firstName
The first name of the author. -
initials
java.lang.String initials
The initials of the author. -
lastName
java.lang.String lastName
The last name of the author. -
name
java.lang.String name
The full name of the author, usually as a String of "firstName lastName".- Since:
- 1.1.1 .
-
phoneNumber
java.lang.String phoneNumber
The telephone number of the author. -
position
java.lang.String position
The position of the author. -
postalCode
java.lang.String postalCode
The postal code of the address of the author. -
state
java.lang.String state
The state or province of the address of the author, if applicable. -
street
java.lang.String street
The street name of the address of the author. -
title
java.lang.String title
The title of the author.
-
-
-
Class org.apache.maven.doxia.document.DocumentCover extends java.lang.Object implements Serializable
-
Serialized Fields
-
author
java.lang.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
java.util.List<DocumentAuthor> authors
Field authors. -
companyLogo
java.lang.String companyLogo
The location of an image file that represents the company logo. -
companyName
java.lang.String companyName
The name of the entity that is responsible for the content of the document, or a copyright holder. -
coverdate
java.lang.String coverdate
The date as String (recommended format is ISO 8601) to appear on the cover. Only used ifcoverDate
is not set.- Since:
- 1.1.1 .
-
coverDate
java.util.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
java.lang.String coverSubTitle
a sub-title to appear on the cover. -
coverTitle
java.lang.String coverTitle
The title to appear on the cover. -
coverType
java.lang.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
java.lang.String coverVersion
The version of the project that appears on the cover page. -
projectLogo
java.lang.String projectLogo
The location of an image file that represents the project logo. -
projectName
java.lang.String projectName
The name of the project.
-
-
-
Class org.apache.maven.doxia.document.DocumentHyperlinkBehaviour extends java.lang.Object implements Serializable
-
Serialized Fields
-
targetFrame
java.lang.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 extends java.lang.Object implements Serializable
-
Serialized Fields
-
author
java.lang.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
java.util.List<DocumentAuthor> authors
Field authors. -
confidential
boolean confidential
whether the content of the document is in some sense confidential. -
creationdate
java.lang.String creationdate
The date as String (recommended format is ISO 8601) when the document was created initially. Only used ifcreationDate
is not set.- Since:
- 1.1.1 .
-
creationDate
java.util.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
java.lang.String creator
The name of the person who last modified the document. -
date
java.util.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
java.lang.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
java.lang.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
java.lang.String initialCreator
The name of the person who created the document initially. -
keywords
java.lang.String keywords
Deprecated.use the <keyWords/> tag instead of.The keywords for the document, usually as a String of comma separated keywords. -
keyWords
java.util.List<java.lang.String> keyWords
Field keyWords. -
language
java.lang.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
java.lang.String modifydate
The date as String (recommended format is ISO 8601) when the document was last modified. Only used ifdate
is not set.- Since:
- 1.1.1 .
-
pageSize
java.lang.String pageSize
The pagesize of the document. At least "US", "USLetter" and "A4" should be supported. -
printdate
java.lang.String printdate
The date as String (recommended format is ISO 8601) when the document was last printed. Only used ifprintDate
is not set.- Since:
- 1.1.1 .
-
printDate
java.util.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
java.lang.String printedBy
The name of the person who last printed the document. -
subject
java.lang.String subject
The subject of the document. -
template
DocumentTemplate template
A template that was used to create the document. -
title
java.lang.String title
The title of the document.
-
-
-
Class org.apache.maven.doxia.document.DocumentModel extends java.lang.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
java.lang.String modelEncoding
Field modelEncoding. -
outputName
java.lang.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 extends java.lang.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 extends java.lang.Object implements Serializable
-
Serialized Fields
-
date
java.util.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
java.lang.String href
The location of the document template. -
modifydate
java.lang.String modifydate
The date as String (recommended format is ISO 8601) when the template was last modified. Only used ifdate
is not set.- Since:
- 1.1.1 .
-
title
java.lang.String title
The name of the document template.
-
-
-
Class org.apache.maven.doxia.document.DocumentTOC extends java.lang.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
java.util.List<DocumentTOCItem> items
Field items. -
name
java.lang.String name
The name to use for the Table of Contents.
-
-
-
Class org.apache.maven.doxia.document.DocumentTOCItem extends java.lang.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
java.util.List<DocumentTOCItem> items
Field items. -
name
java.lang.String name
The name to use for the toc. -
ref
java.lang.String ref
The ref to use for the item.
-
-
-
-
Package org.apache.maven.doxia.macro
-
Class org.apache.maven.doxia.macro.MacroExecutionException extends java.lang.Exception implements Serializable
- serialVersionUID:
- -6314856898570018814L
-
-
Package org.apache.maven.doxia.macro.manager
-
Class org.apache.maven.doxia.macro.manager.MacroNotFoundException extends java.lang.Exception implements Serializable
- serialVersionUID:
- 295967936746221567L
-
-
Package org.apache.maven.doxia.parser
-
Class org.apache.maven.doxia.parser.ParseException extends java.lang.Exception implements Serializable
- serialVersionUID:
- 295967936746221567L
-
Serialized Fields
-
columnNumber
int columnNumber
Column number where the parse exception occurred. -
fileName
java.lang.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
-
Class org.apache.maven.doxia.parser.manager.ParserNotFoundException extends java.lang.Exception implements Serializable
- serialVersionUID:
- 295967936746221567L
-
-
Package org.apache.maven.doxia.parser.module
-
Class org.apache.maven.doxia.parser.module.ParserModuleNotFoundException extends java.lang.Exception implements Serializable
-