Serialized Form

Package org.apache.maven.doxia.document

Class org.apache.maven.doxia.document.DocumentAuthor extends java.lang.Object implements Serializable

Serialized Fields

firstName

java.lang.String firstName

The first name of the author.

lastName

java.lang.String lastName

The last name of the author.

initials

java.lang.String initials

The initials of the author.

title

java.lang.String title

The title of the author.

position

java.lang.String position

The position of the author.

email

java.lang.String email

The email address of the author.

phoneNumber

java.lang.String phoneNumber

The telephone number of the author.

faxNumber

java.lang.String faxNumber

The fax number of the author.

companyName

java.lang.String companyName

The name of the company that employs the author.

street

java.lang.String street

The street name of the address of the author.

city

java.lang.String city

The city name of the address of the author.

postalCode

java.lang.String postalCode

The postal code of the address of the author.

country

java.lang.String country

The country of the address of the author.

state

java.lang.String state

The state or province of the address of the author, if applicable.

Class org.apache.maven.doxia.document.DocumentCover extends java.lang.Object implements Serializable

Serialized Fields

coverTitle

java.lang.String coverTitle

The title to appear on the cover.

coverSubTitle

java.lang.String coverSubTitle

a sub-title to appear on the cover.

coverVersion

java.lang.String coverVersion

The version of the project that appears on the cover page.

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.).

coverDate

java.util.Date coverDate

The date to appear on the cover.

authors

java.util.List<E> authors

Field authors.

projectName

java.lang.String projectName

The name of the project.

projectLogo

java.lang.String projectLogo

The location of an image file that represents the project logo.

companyName

java.lang.String companyName

The name of the entity that is responsible for the content of the document, or a copyright holder.

companyLogo

java.lang.String companyLogo

The location of an image file that represents the company logo.

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

title

java.lang.String title

The title of the document.

author

java.lang.String author

A shortcut for 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<E> authors

Field authors.

subject

java.lang.String subject

The subject of the document.

keywords

java.lang.String keywords

Keywords for the document.

keyWords

java.util.List<E> keyWords

Field keyWords.

pageSize

java.lang.String pageSize

The pagesize of the document. At least "US", "USLetter" and "A4" should be supported.

generator

java.lang.String generator

A string that identifies the application or tool that was used to create or last modify the document.

description

java.lang.String description

A brief description of the document.

initialCreator

java.lang.String initialCreator

The name of the person who created the document initially.

creator

java.lang.String creator

The name of the person who last modified the document.

printedBy

java.lang.String printedBy

The name of the person who last printed the document.

creationDate

java.util.Date creationDate

The date and time when the document was created initially.

date

java.util.Date date

The date and time when the document was last modified.

printDate

java.util.Date printDate

The date and time when the document was last printed.

template

DocumentTemplate template

A template that was used to create the document.

hyperlinkBehaviour

DocumentHyperlinkBehaviour hyperlinkBehaviour

The hyperlink-behaviour element specifies the default behavior for hyperlinks in the document.

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.

editingCycles

long editingCycles

The number of editing cycles the document has been through.

editingDuration

long editingDuration

The total time spent editing the document.

documentStatistic

DocumentStatistic documentStatistic

The statistics of the document, for example, the page count, word count, etc.

confidential

boolean confidential

whether the content of the document is in some sense confidential.

draft

boolean draft

whether the content of the document is in some sense preliminary.

Class org.apache.maven.doxia.document.DocumentModel extends java.lang.Object implements Serializable

Serialized Fields

outputName

java.lang.String outputName

The name of the generated document, without extension.

meta

DocumentMeta meta

The Meta information properties.

toc

DocumentTOC toc

The TOC (Table of Contents) information properties.

cover

DocumentCover cover

The meta data to construct a cover page for the document.

modelEncoding

java.lang.String modelEncoding

Field modelEncoding.

Class org.apache.maven.doxia.document.DocumentStatistic extends java.lang.Object implements Serializable

Serialized Fields

pageCount

long pageCount

The number of pages in the document.

tableCount

long tableCount

The number of tabels in the document.

drawCount

long drawCount

The number of drawings in the document.

imageCount

long imageCount

The number of images in the document.

objectCount

long objectCount

The number of objects in the document.

oleObjectCount

long oleObjectCount

The number of ole-objects in the document.

paragraphCount

long paragraphCount

The number of paragraphs in the document.

wordCount

long wordCount

The number of words in the document.

characterCount

long characterCount

The number of characters in the document.

rowCount

long rowCount

The number of rows in the document.

frameCount

long frameCount

The number of frames in the document.

sentenceCount

long sentenceCount

The number of sentences in the document.

syllableCount

long syllableCount

The number of syllables in the document.

nonWhitespaceCharacterCount

long nonWhitespaceCharacterCount

The number of non-whitespace-characters in the document.

Class org.apache.maven.doxia.document.DocumentTemplate extends java.lang.Object implements Serializable

Serialized Fields

href

java.lang.String href

The location of the document template.

title

java.lang.String title

The name of the document template.

date

java.util.Date date

The date and time when the template was last modified, prior to being used to create the current document.

Class org.apache.maven.doxia.document.DocumentTOC extends java.lang.Object implements Serializable

Serialized Fields

name

java.lang.String name

The name to use for the Table of Contents.

depth

int depth

Specifies up to which level toc items are included by default. Defaults to 0 which means all entries are included. A depth of 1 means only top-level elements, 2 includes one level of sub-items, etc. This may be overridden for individual entries by using the collapse attribute of the corresponding toc item.

items

java.util.List<E> items

Field items.

Class org.apache.maven.doxia.document.DocumentTOCItem extends java.lang.Object implements Serializable

Serialized Fields

name

java.lang.String name

The name to use for the toc.

ref

java.lang.String ref

The ref to use for the item.

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<E> items

Field items.

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.module.site.manager

Class org.apache.maven.doxia.module.site.manager.SiteModuleNotFoundException 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

fileName

java.lang.String fileName

The file that caused the ParseException.

lineNumber

int lineNumber

Line number where the parse exception occurred.

columnNumber

int columnNumber

Column 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