Serialized Form

Package org.apache.maven.doxia.book

Class org.apache.maven.doxia.book.BookDoxiaException extends Exception implements Serializable

serialVersionUID: 87146681585045106L

Class org.apache.maven.doxia.book.InvalidBookDescriptorException extends BookDoxiaException implements Serializable

serialVersionUID: -5706648416915909753L

Serialized Fields

validationResult

ValidationResult validationResult

ValidationResult.

Package org.apache.maven.doxia.book.model

Class org.apache.maven.doxia.book.model.BookModel extends Object implements Serializable

Serialized Fields

id

String id

Specifies the id of this book. This is a symbolic name for a particular book from this project.

title

String title

Specifies the title of this book.

author

String author

Specifies the author of this book.

date

String date

Specifies the date of this book.

chapters

List<E> chapters

Field chapters.

modelEncoding

String modelEncoding

Field modelEncoding.

Class org.apache.maven.doxia.book.model.Chapter extends Object implements Serializable

Serialized Fields

id

String id

Specifies the id of this chapter. This is a symbolic name for a particular chapter.

title

String title

Specifies the title of this chapter.

sections

List<E> sections

Field sections.

Class org.apache.maven.doxia.book.model.Section extends Object implements Serializable

Serialized Fields

id

String id

Specifies the id of this section. This is a symbolic name for a particular section.

title

String title

Specifies the title of this section.

file

String file

Specifies the file of this section.

Package org.apache.maven.doxia.document

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

Serialized Fields

firstName

String firstName

The first name 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 .

initials

String initials

The initials of the author.

title

String title

The title of the author.

position

String position

The position of the author.

email

String email

The email address of the author.

phoneNumber

String phoneNumber

The telephone number of the author.

faxNumber

String faxNumber

The fax number of the author.

companyName

String companyName

The name of the company that employs the author.

street

String street

The street name of the address of the author.

city

String city

The city name of the address of the author.

postalCode

String postalCode

The postal code of the address of the author.

country

String country

The country of the address of the author.

state

String state

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

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

Serialized Fields

coverTitle

String coverTitle

The title to appear on the cover.

coverSubTitle

String coverSubTitle

a sub-title to appear on the cover.

coverVersion

String coverVersion

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

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

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.

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 .

authors

List<E> authors

Field authors.

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 .

projectName

String projectName

The name of the project.

projectLogo

String projectLogo

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

companyName

String companyName

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

companyLogo

String companyLogo

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

Class org.apache.maven.doxia.document.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 extends Object implements Serializable

Serialized Fields

title

String title

The title of the document.

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

Field authors.

subject

String subject

The subject of the document.

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

Field keyWords.

pageSize

String pageSize

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

generator

String generator

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

description

String description

A brief description of the document.

initialCreator

String initialCreator

The name of the person who created the document initially.

creator

String creator

The name of the person who last modified the document.

printedBy

String printedBy

The name of the person who last printed the document.

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.

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 .

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.

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 .

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.

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 .

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

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 Object implements Serializable

Serialized Fields

outputName

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

String modelEncoding

Field modelEncoding.

Class org.apache.maven.doxia.document.DocumentStatistic extends 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 Object implements Serializable

Serialized Fields

href

String href

The location of the document template.

title

String title

The name of the document template.

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.

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 .

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

Serialized Fields

name

String name

The name to use for the Table of Contents.

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

Field items.

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

Serialized Fields

name

String name

The name to use for the toc.

ref

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

List<E> items

Field items.

Package org.apache.maven.doxia.macro

Class org.apache.maven.doxia.macro.MacroExecutionException extends Exception implements Serializable

serialVersionUID: -6314856898570018814L

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

Class org.apache.maven.doxia.macro.manager.MacroNotFoundException extends Exception implements Serializable

serialVersionUID: 295967936746221567L

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

Class org.apache.maven.doxia.module.apt.AptParseException extends ParseException implements Serializable

serialVersionUID: 1694654412921168623L

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

Class org.apache.maven.doxia.module.fml.model.Faq extends Object implements Serializable

Serialized Fields

id

String id

The FAQ identifier.

question

String question

The question.

answer

String answer

The answer.

Class org.apache.maven.doxia.module.fml.model.Faqs extends Object implements Serializable

Serialized Fields

title

String title

The title name of this FAQ.

toplink

boolean toplink

Boolean to generate optionally [top] links.

parts

List<E> parts

Field parts.

modelEncoding

String modelEncoding

Field modelEncoding.

Class org.apache.maven.doxia.module.fml.model.Part extends Object implements Serializable

Serialized Fields

id

String id

The identifier of the part.

title

String title

The title of the FAQ part.

faqs

List<E> faqs

Field faqs.

Package org.apache.maven.doxia.module.site.manager

Class org.apache.maven.doxia.module.site.manager.SiteModuleNotFoundException extends Exception implements Serializable

serialVersionUID: 295967936746221567L

Package org.apache.maven.doxia.parser

Class org.apache.maven.doxia.parser.ParseException extends Exception implements Serializable

serialVersionUID: 295967936746221567L

Serialized Fields

fileName

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 Exception implements Serializable

serialVersionUID: 295967936746221567L