- getAddDefaultEntities() - Method in class org.apache.maven.doxia.document.io.xpp3.DocumentXpp3Reader
-
Returns the state of the "add default entities" flag.
- getAllAuthorNames() - Method in class org.apache.maven.doxia.document.DocumentCover
-
- getAllAuthorNames() - Method in class org.apache.maven.doxia.document.DocumentMeta
-
- getAllKeyWords() - Method in class org.apache.maven.doxia.document.DocumentMeta
-
- getAttribute(Object) - Method in class org.apache.maven.doxia.sink.impl.SinkEventAttributeSet
- getAttributeCount() - Method in class org.apache.maven.doxia.sink.impl.SinkEventAttributeSet
- getAttributeNames() - Method in class org.apache.maven.doxia.sink.impl.SinkEventAttributeSet
- getAttributesFromMap(Map<?, ?>) - Static method in class org.apache.maven.doxia.macro.AbstractMacro
-
Convert the Map of macro parameters to an AttributeSet.
- getAttributesFromParser(XmlPullParser) - Method in class org.apache.maven.doxia.parser.AbstractXmlParser
-
Converts the attributes of the current start tag of the given parser to a SinkEventAttributeSet.
- getAttributeString(AttributeSet) - Static method in class org.apache.maven.doxia.sink.impl.SinkUtils
-
Utility method to get an AttributeSet as a String.
- getAuthor() - Method in class org.apache.maven.doxia.document.DocumentCover
-
Get a shortcut for the unique author that appears on the
cover page.
- getAuthor() - Method in class org.apache.maven.doxia.document.DocumentMeta
-
Get the unique author of the document, usually as a String
of "firstName lastName".
- getAuthors() - Method in class org.apache.maven.doxia.document.DocumentCover
-
Method getAuthors.
- getAuthors() - Method in class org.apache.maven.doxia.document.DocumentMeta
-
Method getAuthors.
- getBasedir() - Method in class org.apache.maven.doxia.macro.MacroRequest
-
Returns the current base directory.
- getBasedir() - Method in class org.apache.maven.doxia.parser.AbstractParser
-
- getCellCount() - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
-
Getter for the field cellCount
.
- getCellCount() - Method in class org.apache.maven.doxia.sink.impl.XhtmlBaseSink
-
Getter for the field cellCount
.
- getCellJustif() - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
-
Getter for the field cellJustif
.
- getCellJustif() - Method in class org.apache.maven.doxia.sink.impl.XhtmlBaseSink
-
Getter for the field cellJustif
.
- getCharacterCount() - Method in class org.apache.maven.doxia.document.DocumentStatistic
-
Get the number of characters in the document.
- getChildEntries() - Method in class org.apache.maven.doxia.index.IndexEntry
-
Returns an unmodifiableList of the child entries.
- getCity() - Method in class org.apache.maven.doxia.document.DocumentAuthor
-
Get the city name of the address of the author.
- getColumnNumber() - Method in exception org.apache.maven.doxia.parser.ParseException
-
Getter for the field columnNumber
.
- getCompanyLogo() - Method in class org.apache.maven.doxia.document.DocumentCover
-
Get the location of an image file that represents the
company logo.
- getCompanyName() - Method in class org.apache.maven.doxia.document.DocumentAuthor
-
Get the name of the company that employs the author.
- getCompanyName() - Method in class org.apache.maven.doxia.document.DocumentCover
-
Get the name of the entity that is responsible for the
content of the
document, or a copyright holder.
- getCountry() - Method in class org.apache.maven.doxia.document.DocumentAuthor
-
Get the country of the address of the author.
- getCover() - Method in class org.apache.maven.doxia.document.DocumentModel
-
Get the meta data to construct a cover page for the
document.
- getCoverDate() - Method in class org.apache.maven.doxia.document.DocumentCover
-
Get the date to appear on the cover.
- getCoverdate() - Method in class org.apache.maven.doxia.document.DocumentCover
-
Get the date to appear on the cover.
- getCoverSubTitle() - Method in class org.apache.maven.doxia.document.DocumentCover
-
Get a sub-title to appear on the cover.
- getCoverTitle() - Method in class org.apache.maven.doxia.document.DocumentCover
-
Get the title to appear on the cover.
- getCoverType() - Method in class org.apache.maven.doxia.document.DocumentCover
-
Get the type of the document.
- getCoverVersion() - Method in class org.apache.maven.doxia.document.DocumentCover
-
Get the version of the project that appears on the cover
page.
- getCreationDate() - Method in class org.apache.maven.doxia.document.DocumentMeta
-
Get the date and time when the document was created
initially.
- getCreationdate() - Method in class org.apache.maven.doxia.document.DocumentMeta
-
Get the date and time when the document was created initially.
- getCreator() - Method in class org.apache.maven.doxia.document.DocumentMeta
-
Get the name of the person who last modified the document.
- getDate() - Method in class org.apache.maven.doxia.document.DocumentMeta
-
Get the date and time when the document was last modified.
- getDate() - Method in class org.apache.maven.doxia.document.DocumentTemplate
-
Get the date and time when the template was last modified,
prior
to being used to create the current document.
- getDepth() - Method in class org.apache.maven.doxia.document.DocumentTOC
-
Get the level up to which toc items are included by default.
- getDescription() - Method in class org.apache.maven.doxia.document.DocumentMeta
-
Get a brief description of the document.
- getDestination() - Method in class org.apache.maven.doxia.util.LineBreaker
-
Returns the current destination writer.
- getDocumentStatistic() - Method in class org.apache.maven.doxia.document.DocumentMeta
-
Get the statistics of the document, for example, the page
count,
word count, etc.
- getDrawCount() - Method in class org.apache.maven.doxia.document.DocumentStatistic
-
Get the number of drawings in the document.
- getEditingCycles() - Method in class org.apache.maven.doxia.document.DocumentMeta
-
Get the number of editing cycles the document has been
through.
- getEditingDuration() - Method in class org.apache.maven.doxia.document.DocumentMeta
-
Get the total time spent editing the document.
- getEmail() - Method in class org.apache.maven.doxia.document.DocumentAuthor
-
Get the email address of the author.
- getExtensions() - Method in class org.apache.maven.doxia.parser.module.AbstractParserModule
-
Returns the supported file extensions for a given module.
- getExtensions() - Method in interface org.apache.maven.doxia.parser.module.ParserModule
-
Returns the supported file extensions for a given module.
- getFaxNumber() - Method in class org.apache.maven.doxia.document.DocumentAuthor
-
Get the fax number of the author.
- getFileName() - Method in exception org.apache.maven.doxia.parser.ParseException
-
Getter for the field fileName
.
- getFirstEntry() - Method in class org.apache.maven.doxia.index.IndexEntry
-
Returns the first entry.
- getFirstName() - Method in class org.apache.maven.doxia.document.DocumentAuthor
-
Get the first name of the author.
- getFrameCount() - Method in class org.apache.maven.doxia.document.DocumentStatistic
-
Get the number of frames in the document.
- getFullName() - Method in class org.apache.maven.doxia.document.DocumentAuthor
-
Get the full name of the author.
- getGenerator() - Method in class org.apache.maven.doxia.document.DocumentMeta
-
Get a string that identifies the application or tool that
was
used to create or last modify the document.
- getHref() - Method in class org.apache.maven.doxia.document.DocumentTemplate
-
Get the location of the document template.
- getHtmlTag(String) - Static method in class org.apache.maven.doxia.util.HtmlTools
-
Returns a tag for a defined HTML tag name.
- getHyperlinkBehaviour() - Method in class org.apache.maven.doxia.document.DocumentMeta
-
Get the hyperlink-behaviour element specifies the default
behavior
for hyperlinks in the document.
- getId() - Method in class org.apache.maven.doxia.index.IndexEntry
-
Returns the id.
- getImageAttributes(String) - Static method in class org.apache.maven.doxia.util.DoxiaUtils
-
Determine width and height of an image.
- getImageCount() - Method in class org.apache.maven.doxia.document.DocumentStatistic
-
Get the number of images in the document.
- getInitialCreator() - Method in class org.apache.maven.doxia.document.DocumentMeta
-
Get the name of the person who created the document
initially.
- getInitials() - Method in class org.apache.maven.doxia.document.DocumentAuthor
-
Get the initials of the author.
- getItems() - Method in class org.apache.maven.doxia.document.DocumentTOC
-
Method getItems.
- getItems() - Method in class org.apache.maven.doxia.document.DocumentTOCItem
-
Method getItems.
- getKeyWords() - Method in class org.apache.maven.doxia.document.DocumentMeta
-
Method getKeyWords.
- getKeywords() - Method in class org.apache.maven.doxia.document.DocumentMeta
-
- getLanguage() - Method in class org.apache.maven.doxia.document.DocumentMeta
-
Get the default language of the document.
- getLastEntry() - Method in class org.apache.maven.doxia.index.IndexEntry
-
Returns the last entry.
- getLastName() - Method in class org.apache.maven.doxia.document.DocumentAuthor
-
Get the last name of the author.
- getLineNumber() - Method in exception org.apache.maven.doxia.parser.ParseException
-
Getter for the field lineNumber
.
- getLineNumber() - Method in class org.apache.maven.doxia.util.ByLineReaderSource
-
getLineNumber.
- getLineNumber() - Method in interface org.apache.maven.doxia.util.ByLineSource
-
getLineNumber.
- getLocalEntities() - Method in class org.apache.maven.doxia.parser.AbstractXmlParser
-
Return the defined entities in a local doctype.
- getLog() - Method in class org.apache.maven.doxia.macro.AbstractMacro
-
Returns a logger for this macro.
- getLog() - Method in class org.apache.maven.doxia.parser.AbstractParser
-
Returns the current logger for this parser.
- getLog() - Method in class org.apache.maven.doxia.sink.impl.AbstractSink
-
Returns a logger for this sink.
- getMacro(String) - Method in class org.apache.maven.doxia.macro.manager.DefaultMacroManager
-
Returns the MacroManager that corresponds to the given id.
- getMacro(String) - Method in interface org.apache.maven.doxia.macro.manager.MacroManager
-
Returns the MacroManager that corresponds to the given id.
- getMacroManager() - Method in class org.apache.maven.doxia.parser.AbstractParser
-
- getMeta() - Method in class org.apache.maven.doxia.document.DocumentModel
-
Get the Meta information properties.
- getModelEncoding() - Method in class org.apache.maven.doxia.document.DocumentModel
-
Get the modelEncoding field.
- getModifydate() - Method in class org.apache.maven.doxia.document.DocumentMeta
-
Get the date and time when the document was last modified.
- getModifydate() - Method in class org.apache.maven.doxia.document.DocumentTemplate
-
Get the date and time when the template was last modified.
- getName() - Method in class org.apache.maven.doxia.document.DocumentAuthor
-
Get the full name of the author, usually as a String of
"firstName lastName".
- getName() - Method in class org.apache.maven.doxia.document.DocumentTOC
-
Get the name to use for the Table of Contents.
- getName() - Method in class org.apache.maven.doxia.document.DocumentTOCItem
-
Get the name to use for the toc.
- getName() - Method in class org.apache.maven.doxia.util.ByLineReaderSource
-
getName.
- getName() - Method in interface org.apache.maven.doxia.util.ByLineSource
-
getName.
- getNameSpace() - Method in class org.apache.maven.doxia.sink.impl.AbstractXmlSink
-
Return the default namespace that is prepended to all tags written by this sink.
- getNextEntry() - Method in class org.apache.maven.doxia.index.IndexEntry
-
Returns the next entry.
- getNextLine() - Method in class org.apache.maven.doxia.util.ByLineReaderSource
-
getNextLine.
- getNextLine() - Method in interface org.apache.maven.doxia.util.ByLineSource
-
getNextLine.
- getNonWhitespaceCharacterCount() - Method in class org.apache.maven.doxia.document.DocumentStatistic
-
Get the number of non-whitespace-characters in the document.
- getObjectCount() - Method in class org.apache.maven.doxia.document.DocumentStatistic
-
Get the number of objects in the document.
- getOleObjectCount() - Method in class org.apache.maven.doxia.document.DocumentStatistic
-
Get the number of ole-objects in the document.
- getOutputName() - Method in class org.apache.maven.doxia.document.DocumentModel
-
Get the name of the generated document, without extension.
- getPageCount() - Method in class org.apache.maven.doxia.document.DocumentStatistic
-
Get the number of pages in the document.
- getPageSize() - Method in class org.apache.maven.doxia.document.DocumentMeta
-
Get the pagesize of the document.
- getParagraphCount() - Method in class org.apache.maven.doxia.document.DocumentStatistic
-
Get the number of paragraphs in the document.
- getParameter(String) - Method in class org.apache.maven.doxia.macro.MacroRequest
-
Returns on object from the map of parameters
that corresponds to the given key.
- getParameters() - Method in class org.apache.maven.doxia.macro.MacroRequest
-
Returns the map of parameters.
- getParent() - Method in class org.apache.maven.doxia.index.IndexEntry
-
Returns the parent entry.
- getParser(String) - Method in class org.apache.maven.doxia.DefaultDoxia
-
Return a parser for the given parserId
.
- getParser(String) - Method in interface org.apache.maven.doxia.Doxia
-
Return a parser for the given parserId
.
- getParser() - Method in class org.apache.maven.doxia.macro.MacroRequest
-
getParser.
- getParser(String) - Method in class org.apache.maven.doxia.parser.manager.DefaultParserManager
-
Returns the parser that corresponds to the given id.
- getParser(String) - Method in interface org.apache.maven.doxia.parser.manager.ParserManager
-
Returns the parser that corresponds to the given id.
- getParserId() - Method in class org.apache.maven.doxia.parser.module.AbstractParserModule
-
Returns the parser id for a given module.
- getParserId() - Method in interface org.apache.maven.doxia.parser.module.ParserModule
-
Returns the parser id for a given module.
- getParserModule(String) - Method in class org.apache.maven.doxia.parser.module.DefaultParserModuleManager
-
Returns the ParserModule that corresponds to the given id.
- getParserModule(String) - Method in interface org.apache.maven.doxia.parser.module.ParserModuleManager
-
Returns the ParserModule that corresponds to the given id.
- getParserModules() - Method in class org.apache.maven.doxia.parser.module.DefaultParserModuleManager
-
Returns a collection of ParserModules.
- getParserModules() - Method in interface org.apache.maven.doxia.parser.module.ParserModuleManager
-
Returns a collection of ParserModules.
- getPhoneNumber() - Method in class org.apache.maven.doxia.document.DocumentAuthor
-
Get the telephone number of the author.
- getPosition() - Method in class org.apache.maven.doxia.document.DocumentAuthor
-
Get the position of the author.
- getPostalCode() - Method in class org.apache.maven.doxia.document.DocumentAuthor
-
Get the postal code of the address of the author.
- getPrevEntry() - Method in class org.apache.maven.doxia.index.IndexEntry
-
Returns the previous entry.
- getPrintDate() - Method in class org.apache.maven.doxia.document.DocumentMeta
-
Get the date and time when the document was last printed.
- getPrintdate() - Method in class org.apache.maven.doxia.document.DocumentMeta
-
Get the date and time when the document was last printed.
- getPrintedBy() - Method in class org.apache.maven.doxia.document.DocumentMeta
-
Get the name of the person who last printed the document.
- getProjectLogo() - Method in class org.apache.maven.doxia.document.DocumentCover
-
Get the location of an image file that represents the
project logo.
- getProjectName() - Method in class org.apache.maven.doxia.document.DocumentCover
-
Get the name of the project.
- getRef() - Method in class org.apache.maven.doxia.document.DocumentTOCItem
-
Get the ref to use for the item.
- getResolveParent() - Method in class org.apache.maven.doxia.sink.impl.SinkEventAttributeSet
- getRootEntry() - Method in class org.apache.maven.doxia.index.IndexEntry
-
Returns the root entry.
- getRowCount() - Method in class org.apache.maven.doxia.document.DocumentStatistic
-
Get the number of rows in the document.
- getSectionLevel() - Method in class org.apache.maven.doxia.parser.Xhtml5BaseParser
-
Return the current section level.
- getSectionLevel() - Method in class org.apache.maven.doxia.parser.XhtmlBaseParser
-
Return the current section level.
- getSentenceCount() - Method in class org.apache.maven.doxia.document.DocumentStatistic
-
Get the number of sentences in the document.
- getSourceContent() - Method in class org.apache.maven.doxia.macro.MacroRequest
-
getSourceContent.
- getSourceDirectory() - Method in class org.apache.maven.doxia.parser.module.AbstractParserModule
-
Returns the directory that contains source files for a given module.
- getSourceDirectory() - Method in interface org.apache.maven.doxia.parser.module.ParserModule
-
Returns the directory that contains source files for a given module.
- getState() - Method in class org.apache.maven.doxia.document.DocumentAuthor
-
Get the state or province of the address of the author, if
applicable.
- getStreet() - Method in class org.apache.maven.doxia.document.DocumentAuthor
-
Get the street name of the address of the author.
- getSubject() - Method in class org.apache.maven.doxia.document.DocumentMeta
-
Get the subject of the document.
- getSyllableCount() - Method in class org.apache.maven.doxia.document.DocumentStatistic
-
Get the number of syllables in the document.
- getTableCount() - Method in class org.apache.maven.doxia.document.DocumentStatistic
-
Get the number of tabels in the document.
- getTargetFrame() - Method in class org.apache.maven.doxia.document.DocumentHyperlinkBehaviour
-
Get the name of the default target frame.
- getTemplate() - Method in class org.apache.maven.doxia.document.DocumentMeta
-
Get a template that was used to create the document.
- getText(XmlPullParser) - Method in class org.apache.maven.doxia.parser.AbstractXmlParser
-
getText.
- getTextBuffer() - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
-
To use mainly when playing with the head events.
- getTextBuffer() - Method in class org.apache.maven.doxia.sink.impl.XhtmlBaseSink
-
To use mainly when playing with the head events.
- getTitle() - Method in class org.apache.maven.doxia.document.DocumentAuthor
-
Get the title of the author.
- getTitle() - Method in class org.apache.maven.doxia.document.DocumentMeta
-
Get the title of the document.
- getTitle() - Method in class org.apache.maven.doxia.document.DocumentTemplate
-
Get the name of the document template.
- getTitle() - Method in class org.apache.maven.doxia.index.IndexEntry
-
Returns the title.
- getTitle() - Method in class org.apache.maven.doxia.index.IndexingSink
-
Getter for the field title
.
- getToc() - Method in class org.apache.maven.doxia.document.DocumentModel
-
Get the TOC (Table of Contents) information properties.
- getType() - Method in class org.apache.maven.doxia.parser.AbstractParser
-
- getType() - Method in class org.apache.maven.doxia.parser.AbstractTextParser
-
- getType() - Method in class org.apache.maven.doxia.parser.AbstractXmlParser
-
- getType() - Method in interface org.apache.maven.doxia.parser.Parser
-
- getWordCount() - Method in class org.apache.maven.doxia.document.DocumentStatistic
-
Get the number of words in the document.
- GREATER_THAN - Static variable in interface org.apache.maven.doxia.markup.Markup
-
end character: '<'
- P - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
-
Xhtml tag for p
.
- pageBreak() - Method in class org.apache.maven.doxia.sink.impl.RandomAccessSink
- pageBreak() - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
- pageBreak() - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
- pageBreak() - Method in class org.apache.maven.doxia.sink.impl.XhtmlBaseSink
- paragraph() - Method in class org.apache.maven.doxia.sink.impl.RandomAccessSink
- paragraph(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.RandomAccessSink
- paragraph() - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
- paragraph(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
- paragraph() - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
- paragraph(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
- paragraph() - Method in class org.apache.maven.doxia.sink.impl.XhtmlBaseSink
- paragraph(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.XhtmlBaseSink
- paragraph_() - Method in class org.apache.maven.doxia.sink.impl.RandomAccessSink
- paragraph_() - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
- paragraph_() - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
- paragraph_() - Method in class org.apache.maven.doxia.sink.impl.XhtmlBaseSink
- PARAM - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
-
Xhtml tag for param
.
- parse(Reader, String, Sink) - Method in class org.apache.maven.doxia.DefaultDoxia
-
Parses the given source model using a parser with given id,
and emits Doxia events into the given sink.
- parse(Reader, String, Sink, String) - Method in class org.apache.maven.doxia.DefaultDoxia
-
Parses the given source model using a parser with given id,
and emits Doxia events into the given sink.
- parse(Reader, String, Sink) - Method in interface org.apache.maven.doxia.Doxia
-
Parses the given source model using a parser with given id,
and emits Doxia events into the given sink.
- parse(Reader, String, Sink, String) - Method in interface org.apache.maven.doxia.Doxia
-
Parses the given source model using a parser with given id,
and emits Doxia events into the given sink.
- parse(String, Sink) - Method in class org.apache.maven.doxia.parser.AbstractParser
-
Convenience method to parse an arbitrary string and emit events into the given sink.
- parse(String, Sink, String) - Method in class org.apache.maven.doxia.parser.AbstractParser
-
Convenience method to parse an arbitrary string and emit events into the given sink.
- parse(Reader, Sink) - Method in class org.apache.maven.doxia.parser.AbstractParser
-
Parses the given source model and emits Doxia events into the given sink.
- parse(Reader, Sink, String) - Method in class org.apache.maven.doxia.parser.AbstractXmlParser
-
Parses the given source model and emits Doxia events into the given sink.
- parse(Reader, Sink) - Method in interface org.apache.maven.doxia.parser.Parser
-
Parses the given source model and emits Doxia events into the given sink.
- parse(Reader, Sink, String) - Method in interface org.apache.maven.doxia.parser.Parser
-
Parses the given source model and emits Doxia events into the given sink.
- parse(Reader, Sink, String) - Method in class org.apache.maven.doxia.parser.Xhtml5BaseParser
-
Parses the given source model and emits Doxia events into the given sink.
- parse(Reader, Sink, String) - Method in class org.apache.maven.doxia.parser.XhtmlBaseParser
-
Parses the given source model and emits Doxia events into the given sink.
- parseDate(String) - Static method in class org.apache.maven.doxia.util.DoxiaUtils
-
Parses a string representing a date by trying different date patterns.
- ParseException - Exception in org.apache.maven.doxia.parser
-
Encapsulate a Doxia parse error.
- ParseException(String) - Constructor for exception org.apache.maven.doxia.parser.ParseException
-
Construct a new ParseException
with the specified detail message.
- ParseException(String, Exception) - Constructor for exception org.apache.maven.doxia.parser.ParseException
-
Construct a new ParseException
with the specified detail message and cause.
- ParseException(String, int, int) - Constructor for exception org.apache.maven.doxia.parser.ParseException
-
Construct a new ParseException
with the specified detail message,
line number and column number.
- ParseException(String, Exception, int, int) - Constructor for exception org.apache.maven.doxia.parser.ParseException
-
Construct a new ParseException
with the specified detail message and cause,
line number and column number.
- ParseException(Exception) - Constructor for exception org.apache.maven.doxia.parser.ParseException
-
- ParseException(Exception, int, int) - Constructor for exception org.apache.maven.doxia.parser.ParseException
-
Constructs a new exception with the specified cause, line number and column number.
- ParseException(Exception, String, int) - Constructor for exception org.apache.maven.doxia.parser.ParseException
-
- ParseException(Exception, String, int, int) - Constructor for exception org.apache.maven.doxia.parser.ParseException
-
Construct a new ParseException
with the specified cause,
filename, line number and column number.
- ParseException(Exception, String, String, int, int) - Constructor for exception org.apache.maven.doxia.parser.ParseException
-
Construct a new ParseException
with the specified cause, detail message,
filename, line number and column number.
- Parser - Interface in org.apache.maven.doxia.parser
-
A Parser is responsible for parsing any document in a supported front-end
format, and emitting the standard Doxia events, which can then be consumed
by any Doxia Sink.
- ParserManager - Interface in org.apache.maven.doxia.parser.manager
-
Handles parser lookups.
- ParserModule - Interface in org.apache.maven.doxia.parser.module
-
Provides definitions for a Doxia Parser module.
- ParserModuleManager - Interface in org.apache.maven.doxia.parser.module
-
Handles ParserModule lookups.
- ParserModuleNotFoundException - Exception in org.apache.maven.doxia.parser.module
-
Encapsulate a Doxia exception that indicates that a ParserModule
does not exist or could not be found.
- ParserModuleNotFoundException(String) - Constructor for exception org.apache.maven.doxia.parser.module.ParserModuleNotFoundException
-
Construct a new ParserModuleNotFoundException with the
specified detail message.
- ParserModuleNotFoundException(Throwable) - Constructor for exception org.apache.maven.doxia.parser.module.ParserModuleNotFoundException
-
Constructs a new ParserModuleNotFoundException with the specified cause.
- ParserModuleNotFoundException(String, Throwable) - Constructor for exception org.apache.maven.doxia.parser.module.ParserModuleNotFoundException
-
Construct a new ParserModuleNotFoundException with the specified
detail message and cause.
- ParserNotFoundException - Exception in org.apache.maven.doxia.parser.manager
-
Encapsulate a Doxia exception that indicates that a parser
does not exist or could not be found.
- ParserNotFoundException(String) - Constructor for exception org.apache.maven.doxia.parser.manager.ParserNotFoundException
-
Construct a new ParserNotFoundException with the specified detail message.
- ParserNotFoundException(Throwable) - Constructor for exception org.apache.maven.doxia.parser.manager.ParserNotFoundException
-
Constructs a new exception with the specified cause.
- ParserNotFoundException(String, Throwable) - Constructor for exception org.apache.maven.doxia.parser.manager.ParserNotFoundException
-
Construct a new ParserNotFoundException with the specified
detail message and cause.
- peek() - Method in class org.apache.maven.doxia.index.IndexingSink
-
peek.
- PHRASE - Static variable in class org.apache.maven.doxia.sink.impl.SinkEventAttributeSet.Semantics
-
An unmodifiable attribute set containing only a phrase attribute.
- PICTURE - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
-
Html5 tag for picture
.
- PIPE - Static variable in interface org.apache.maven.doxia.markup.TextMarkup
-
pipe character: '|'
- PipelineSink - Class in org.apache.maven.doxia.sink.impl
-
May be used to invoke the same method on a List of Sinks.
- PipelineSink(List<Sink>) - Constructor for class org.apache.maven.doxia.sink.impl.PipelineSink
-
Constructs a PipelineSink for a given List of Sinks.
- PLUS - Static variable in interface org.apache.maven.doxia.markup.Markup
-
plus character: '+'
- pop() - Method in class org.apache.maven.doxia.index.IndexingSink
-
Removes the IndexEntry at the top of this stack.
- PRE - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
-
Xhtml tag for pre
.
- PROGRESS - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
-
Html5 tag for progress
.
- push(IndexEntry) - Method in class org.apache.maven.doxia.index.IndexingSink
-
Pushes an IndexEntry onto the top of this stack.
- pushNewEntry() - Method in class org.apache.maven.doxia.index.IndexingSink
-
Creates and pushes a new IndexEntry onto the top of this stack.
- S - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
-
Xhtml tag for s
.
- SAMP - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
-
Xhtml tag for samp
.
- SAMPLE - Static variable in class org.apache.maven.doxia.sink.impl.SinkEventAttributeSet.Semantics
-
An unmodifiable attribute set containing only a sample attribute.
- SCRIPT - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
-
Xhtml tag for script
.
- SECTION - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
-
Html5 tag for section
.
- section(int, SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.RandomAccessSink
- section(int, SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
- section(int, SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
- section(int, SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.XhtmlBaseSink
- section1() - Method in class org.apache.maven.doxia.index.IndexingSink
- section1() - Method in class org.apache.maven.doxia.sink.impl.RandomAccessSink
- section1() - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
- section1() - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
- section1() - Method in class org.apache.maven.doxia.sink.impl.XhtmlBaseSink
- section1_() - Method in class org.apache.maven.doxia.index.IndexingSink
- section1_() - Method in class org.apache.maven.doxia.sink.impl.RandomAccessSink
- section1_() - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
- section1_() - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
- section1_() - Method in class org.apache.maven.doxia.sink.impl.XhtmlBaseSink
- section2() - Method in class org.apache.maven.doxia.index.IndexingSink
- section2() - Method in class org.apache.maven.doxia.sink.impl.RandomAccessSink
- section2() - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
- section2() - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
- section2() - Method in class org.apache.maven.doxia.sink.impl.XhtmlBaseSink
- section2_() - Method in class org.apache.maven.doxia.index.IndexingSink
- section2_() - Method in class org.apache.maven.doxia.sink.impl.RandomAccessSink
- section2_() - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
- section2_() - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
- section2_() - Method in class org.apache.maven.doxia.sink.impl.XhtmlBaseSink
- section3() - Method in class org.apache.maven.doxia.index.IndexingSink
- section3() - Method in class org.apache.maven.doxia.sink.impl.RandomAccessSink
- section3() - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
- section3() - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
- section3() - Method in class org.apache.maven.doxia.sink.impl.XhtmlBaseSink
- section3_() - Method in class org.apache.maven.doxia.index.IndexingSink
- section3_() - Method in class org.apache.maven.doxia.sink.impl.RandomAccessSink
- section3_() - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
- section3_() - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
- section3_() - Method in class org.apache.maven.doxia.sink.impl.XhtmlBaseSink
- section4() - Method in class org.apache.maven.doxia.index.IndexingSink
- section4() - Method in class org.apache.maven.doxia.sink.impl.RandomAccessSink
- section4() - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
- section4() - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
- section4() - Method in class org.apache.maven.doxia.sink.impl.XhtmlBaseSink
- section4_() - Method in class org.apache.maven.doxia.index.IndexingSink
- section4_() - Method in class org.apache.maven.doxia.sink.impl.RandomAccessSink
- section4_() - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
- section4_() - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
- section4_() - Method in class org.apache.maven.doxia.sink.impl.XhtmlBaseSink
- section5() - Method in class org.apache.maven.doxia.index.IndexingSink
- section5() - Method in class org.apache.maven.doxia.sink.impl.RandomAccessSink
- section5() - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
- section5() - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
- section5() - Method in class org.apache.maven.doxia.sink.impl.XhtmlBaseSink
- section5_() - Method in class org.apache.maven.doxia.index.IndexingSink
- section5_() - Method in class org.apache.maven.doxia.sink.impl.RandomAccessSink
- section5_() - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
- section5_() - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
- section5_() - Method in class org.apache.maven.doxia.sink.impl.XhtmlBaseSink
- section6() - Method in class org.apache.maven.doxia.sink.impl.RandomAccessSink
- section6() - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
- section6_() - Method in class org.apache.maven.doxia.sink.impl.RandomAccessSink
- section6_() - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
- section_(int) - Method in class org.apache.maven.doxia.sink.impl.RandomAccessSink
- section_(int) - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
- section_(int) - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
- section_(int) - Method in class org.apache.maven.doxia.sink.impl.XhtmlBaseSink
- sectionTitle() - Method in class org.apache.maven.doxia.sink.impl.RandomAccessSink
- sectionTitle(int, SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.RandomAccessSink
- sectionTitle() - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
- sectionTitle(int, SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
- sectionTitle(int, SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
- sectionTitle(int, SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.XhtmlBaseSink
- sectionTitle1() - Method in class org.apache.maven.doxia.index.IndexingSink
- sectionTitle1() - Method in class org.apache.maven.doxia.sink.impl.RandomAccessSink
- sectionTitle1() - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
- sectionTitle1() - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
- sectionTitle1() - Method in class org.apache.maven.doxia.sink.impl.XhtmlBaseSink
- sectionTitle1_() - Method in class org.apache.maven.doxia.index.IndexingSink
-
sectionTitle1_.
- sectionTitle1_() - Method in class org.apache.maven.doxia.sink.impl.RandomAccessSink
- sectionTitle1_() - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
- sectionTitle1_() - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
- sectionTitle1_() - Method in class org.apache.maven.doxia.sink.impl.XhtmlBaseSink
- sectionTitle2() - Method in class org.apache.maven.doxia.index.IndexingSink
- sectionTitle2() - Method in class org.apache.maven.doxia.sink.impl.RandomAccessSink
- sectionTitle2() - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
- sectionTitle2() - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
- sectionTitle2() - Method in class org.apache.maven.doxia.sink.impl.XhtmlBaseSink
- sectionTitle2_() - Method in class org.apache.maven.doxia.index.IndexingSink
-
sectionTitle2_.
- sectionTitle2_() - Method in class org.apache.maven.doxia.sink.impl.RandomAccessSink
- sectionTitle2_() - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
- sectionTitle2_() - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
- sectionTitle2_() - Method in class org.apache.maven.doxia.sink.impl.XhtmlBaseSink
- sectionTitle3() - Method in class org.apache.maven.doxia.index.IndexingSink
- sectionTitle3() - Method in class org.apache.maven.doxia.sink.impl.RandomAccessSink
- sectionTitle3() - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
- sectionTitle3() - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
- sectionTitle3() - Method in class org.apache.maven.doxia.sink.impl.XhtmlBaseSink
- sectionTitle3_() - Method in class org.apache.maven.doxia.index.IndexingSink
-
sectionTitle3_.
- sectionTitle3_() - Method in class org.apache.maven.doxia.sink.impl.RandomAccessSink
- sectionTitle3_() - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
- sectionTitle3_() - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
- sectionTitle3_() - Method in class org.apache.maven.doxia.sink.impl.XhtmlBaseSink
- sectionTitle4() - Method in class org.apache.maven.doxia.index.IndexingSink
- sectionTitle4() - Method in class org.apache.maven.doxia.sink.impl.RandomAccessSink
- sectionTitle4() - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
- sectionTitle4() - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
- sectionTitle4() - Method in class org.apache.maven.doxia.sink.impl.XhtmlBaseSink
- sectionTitle4_() - Method in class org.apache.maven.doxia.index.IndexingSink
-
sectionTitle4_.
- sectionTitle4_() - Method in class org.apache.maven.doxia.sink.impl.RandomAccessSink
- sectionTitle4_() - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
- sectionTitle4_() - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
- sectionTitle4_() - Method in class org.apache.maven.doxia.sink.impl.XhtmlBaseSink
- sectionTitle5() - Method in class org.apache.maven.doxia.index.IndexingSink
- sectionTitle5() - Method in class org.apache.maven.doxia.sink.impl.RandomAccessSink
- sectionTitle5() - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
- sectionTitle5() - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
- sectionTitle5() - Method in class org.apache.maven.doxia.sink.impl.XhtmlBaseSink
- sectionTitle5_() - Method in class org.apache.maven.doxia.index.IndexingSink
-
sectionTitle5_.
- sectionTitle5_() - Method in class org.apache.maven.doxia.sink.impl.RandomAccessSink
- sectionTitle5_() - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
- sectionTitle5_() - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
- sectionTitle5_() - Method in class org.apache.maven.doxia.sink.impl.XhtmlBaseSink
- sectionTitle6() - Method in class org.apache.maven.doxia.sink.impl.RandomAccessSink
- sectionTitle6() - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
- sectionTitle6_() - Method in class org.apache.maven.doxia.sink.impl.RandomAccessSink
- sectionTitle6_() - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
- sectionTitle_() - Method in class org.apache.maven.doxia.sink.impl.RandomAccessSink
- sectionTitle_(int) - Method in class org.apache.maven.doxia.sink.impl.RandomAccessSink
- sectionTitle_() - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
- sectionTitle_(int) - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
- sectionTitle_(int) - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
- sectionTitle_(int) - Method in class org.apache.maven.doxia.sink.impl.XhtmlBaseSink
- SELECT - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
-
Xhtml tag for select
.
- Semantics() - Constructor for class org.apache.maven.doxia.sink.impl.SinkEventAttributeSet.Semantics
-
- SEMICOLON - Static variable in interface org.apache.maven.doxia.markup.Markup
-
semicolon character: ';'
- setAddDefaultEntities(boolean) - Method in class org.apache.maven.doxia.document.io.xpp3.DocumentXpp3Reader
-
Sets the state of the "add default entities" flag.
- setAuthor(String) - Method in class org.apache.maven.doxia.document.DocumentCover
-
Set a shortcut for the unique author that appears on the
cover page.
- setAuthor(String) - Method in class org.apache.maven.doxia.document.DocumentMeta
-
Set the unique author of the document, usually as a String
of "firstName lastName".
- setAuthors(List<DocumentAuthor>) - Method in class org.apache.maven.doxia.document.DocumentCover
-
Set the authors that appear on the cover page.
- setAuthors(List<DocumentAuthor>) - Method in class org.apache.maven.doxia.document.DocumentMeta
-
Set the authors of the document.
- setBasedir(File) - Method in class org.apache.maven.doxia.macro.MacroRequest
-
Sets the current base directory.
- setCacheTimeout(int) - Method in class org.apache.maven.doxia.macro.snippet.SnippetMacro
-
Set the cache timeout.
- setCellCount(int) - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
-
Setter for the field cellCount
.
- setCellCount(int) - Method in class org.apache.maven.doxia.sink.impl.XhtmlBaseSink
-
Setter for the field cellCount
.
- setCellJustif(int[]) - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
-
Setter for the field cellJustif
.
- setCellJustif(int[]) - Method in class org.apache.maven.doxia.sink.impl.XhtmlBaseSink
-
Setter for the field cellJustif
.
- setCharacterCount(long) - Method in class org.apache.maven.doxia.document.DocumentStatistic
-
Set the number of characters in the document.
- setChildEntries(List<IndexEntry>) - Method in class org.apache.maven.doxia.index.IndexEntry
-
Sets the child entries or creates a new ArrayList if entries == null.
- setCity(String) - Method in class org.apache.maven.doxia.document.DocumentAuthor
-
Set the city name of the address of the author.
- setCollapse(boolean) - Method in class org.apache.maven.doxia.document.DocumentTOCItem
-
Set whether to show any child elements of a TOCItem,
overriding
the depth given in DocumentTOC.
- setCollapsibleWhitespace(boolean) - Method in class org.apache.maven.doxia.parser.AbstractXmlParser
-
Specify that text will be collapsed.
- setCompanyLogo(String) - Method in class org.apache.maven.doxia.document.DocumentCover
-
Set the location of an image file that represents the
company logo.
- setCompanyName(String) - Method in class org.apache.maven.doxia.document.DocumentAuthor
-
Set the name of the company that employs the author.
- setCompanyName(String) - Method in class org.apache.maven.doxia.document.DocumentCover
-
Set the name of the entity that is responsible for the
content of the
document, or a copyright holder.
- setConfidential(boolean) - Method in class org.apache.maven.doxia.document.DocumentMeta
-
Set whether the content of the document is in some sense
confidential.
- setCountry(String) - Method in class org.apache.maven.doxia.document.DocumentAuthor
-
Set the country of the address of the author.
- setCover(DocumentCover) - Method in class org.apache.maven.doxia.document.DocumentModel
-
Set the meta data to construct a cover page for the
document.
- setCoverDate(Date) - Method in class org.apache.maven.doxia.document.DocumentCover
-
Set the date to appear on the cover.
- setCoverdate(String) - Method in class org.apache.maven.doxia.document.DocumentCover
-
Set the date as String (recommended format is ISO 8601) to
appear on the cover.
- setCoverSubTitle(String) - Method in class org.apache.maven.doxia.document.DocumentCover
-
Set a sub-title to appear on the cover.
- setCoverTitle(String) - Method in class org.apache.maven.doxia.document.DocumentCover
-
Set the title to appear on the cover.
- setCoverType(String) - Method in class org.apache.maven.doxia.document.DocumentCover
-
Set the type of the document.
- setCoverVersion(String) - Method in class org.apache.maven.doxia.document.DocumentCover
-
Set the version of the project that appears on the cover
page.
- setCreationDate(Date) - Method in class org.apache.maven.doxia.document.DocumentMeta
-
Set the date and time when the document was created
initially.
- setCreationdate(String) - Method in class org.apache.maven.doxia.document.DocumentMeta
-
Set the date as String (recommended format is ISO 8601) when
the document was created initially.
- setCreator(String) - Method in class org.apache.maven.doxia.document.DocumentMeta
-
Set the name of the person who last modified the document.
- setDate(Date) - Method in class org.apache.maven.doxia.document.DocumentMeta
-
Set the date and time when the document was last modified.
- setDate(Date) - Method in class org.apache.maven.doxia.document.DocumentTemplate
-
Set the date and time when the template was last modified,
prior
to being used to create the current document.
- setDepth(int) - Method in class org.apache.maven.doxia.document.DocumentTOC
-
Set the level up to which toc items are included by default.
- setDescription(String) - Method in class org.apache.maven.doxia.document.DocumentMeta
-
Set a brief description of the document.
- setDocumentStatistic(DocumentStatistic) - Method in class org.apache.maven.doxia.document.DocumentMeta
-
Set the statistics of the document, for example, the page
count,
word count, etc.
- setDraft(boolean) - Method in class org.apache.maven.doxia.document.DocumentMeta
-
Set whether the content of the document is in some sense
preliminary.
- setDrawCount(long) - Method in class org.apache.maven.doxia.document.DocumentStatistic
-
Set the number of drawings in the document.
- setEditingCycles(long) - Method in class org.apache.maven.doxia.document.DocumentMeta
-
Set the number of editing cycles the document has been
through.
- setEditingDuration(long) - Method in class org.apache.maven.doxia.document.DocumentMeta
-
Set the total time spent editing the document.
- setEmail(String) - Method in class org.apache.maven.doxia.document.DocumentAuthor
-
Set the email address of the author.
- setEmitComments(boolean) - Method in class org.apache.maven.doxia.parser.AbstractParser
-
When comments are found in source markup, emit comment Doxia events or just ignore?
- setEmitComments(boolean) - Method in interface org.apache.maven.doxia.parser.Parser
-
When comments are found in source markup, emit comment Doxia events or just ignore?
- setFaxNumber(String) - Method in class org.apache.maven.doxia.document.DocumentAuthor
-
Set the fax number of the author.
- setFileComment(String) - Method in class org.apache.maven.doxia.document.io.xpp3.DocumentXpp3Writer
-
Method setFileComment.
- setFirstName(String) - Method in class org.apache.maven.doxia.document.DocumentAuthor
-
Set the first name of the author.
- setFrameCount(long) - Method in class org.apache.maven.doxia.document.DocumentStatistic
-
Set the number of frames in the document.
- setGenerator(String) - Method in class org.apache.maven.doxia.document.DocumentMeta
-
Set a string that identifies the application or tool that
was
used to create or last modify the document.
- setHeadFlag(boolean) - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
-
Setter for the field headFlag
.
- setHeadFlag(boolean) - Method in class org.apache.maven.doxia.sink.impl.XhtmlBaseSink
-
Setter for the field headFlag
.
- setHref(String) - Method in class org.apache.maven.doxia.document.DocumentTemplate
-
Set the location of the document template.
- setHyperlinkBehaviour(DocumentHyperlinkBehaviour) - Method in class org.apache.maven.doxia.document.DocumentMeta
-
Set the hyperlink-behaviour element specifies the default
behavior
for hyperlinks in the document.
- setId(String) - Method in class org.apache.maven.doxia.index.IndexEntry
-
Set the id.
- setIgnorableWhitespace(boolean) - Method in class org.apache.maven.doxia.parser.AbstractXmlParser
-
Specify that whitespace will be ignored.
- setImageCount(long) - Method in class org.apache.maven.doxia.document.DocumentStatistic
-
Set the number of images in the document.
- setInitialCreator(String) - Method in class org.apache.maven.doxia.document.DocumentMeta
-
Set the name of the person who created the document
initially.
- setInitials(String) - Method in class org.apache.maven.doxia.document.DocumentAuthor
-
Set the initials of the author.
- setInsertNewline(boolean) - Method in class org.apache.maven.doxia.sink.impl.AbstractXmlSink
-
Setter for the field insertNewline
.
- setItems(List<DocumentTOCItem>) - Method in class org.apache.maven.doxia.document.DocumentTOC
-
Set tOC item.
- setItems(List<DocumentTOCItem>) - Method in class org.apache.maven.doxia.document.DocumentTOCItem
-
Set a table of content item containing sub-items.
- setKeyWords(List<String>) - Method in class org.apache.maven.doxia.document.DocumentMeta
-
Set a keyword pertaining to the document.
- setKeywords(String) - Method in class org.apache.maven.doxia.document.DocumentMeta
-
- setLanguage(String) - Method in class org.apache.maven.doxia.document.DocumentMeta
-
Set the default language of the document.
- setLastName(String) - Method in class org.apache.maven.doxia.document.DocumentAuthor
-
Set the last name of the author.
- setMeta(DocumentMeta) - Method in class org.apache.maven.doxia.document.DocumentModel
-
Set the Meta information properties.
- setModelEncoding(String) - Method in class org.apache.maven.doxia.document.DocumentModel
-
Set the modelEncoding field.
- setModifydate(String) - Method in class org.apache.maven.doxia.document.DocumentMeta
-
Set the date as String (recommended format is ISO 8601) when
the document was last modified.
- setModifydate(String) - Method in class org.apache.maven.doxia.document.DocumentTemplate
-
Set the date as String (recommended format is ISO 8601) when
the template was last modified.
- setName(String) - Method in class org.apache.maven.doxia.document.DocumentAuthor
-
Set the full name of the author, usually as a String of
"firstName lastName".
- setName(String) - Method in class org.apache.maven.doxia.document.DocumentTOC
-
Set the name to use for the Table of Contents.
- setName(String) - Method in class org.apache.maven.doxia.document.DocumentTOCItem
-
Set the name to use for the toc.
- setNameSpace(String) - Method in class org.apache.maven.doxia.sink.impl.AbstractXmlSink
-
Sets the default namespace that is prepended to all tags written by this sink.
- setNonWhitespaceCharacterCount(long) - Method in class org.apache.maven.doxia.document.DocumentStatistic
-
Set the number of non-whitespace-characters in the document.
- setObjectCount(long) - Method in class org.apache.maven.doxia.document.DocumentStatistic
-
Set the number of objects in the document.
- setOleObjectCount(long) - Method in class org.apache.maven.doxia.document.DocumentStatistic
-
Set the number of ole-objects in the document.
- setOutputName(String) - Method in class org.apache.maven.doxia.document.DocumentModel
-
Set the name of the generated document, without extension.
- setPageCount(long) - Method in class org.apache.maven.doxia.document.DocumentStatistic
-
Set the number of pages in the document.
- setPageSize(String) - Method in class org.apache.maven.doxia.document.DocumentMeta
-
Set the pagesize of the document.
- setParagraphCount(long) - Method in class org.apache.maven.doxia.document.DocumentStatistic
-
Set the number of paragraphs in the document.
- setPhoneNumber(String) - Method in class org.apache.maven.doxia.document.DocumentAuthor
-
Set the telephone number of the author.
- setPosition(String) - Method in class org.apache.maven.doxia.document.DocumentAuthor
-
Set the position of the author.
- setPostalCode(String) - Method in class org.apache.maven.doxia.document.DocumentAuthor
-
Set the postal code of the address of the author.
- setPrintDate(Date) - Method in class org.apache.maven.doxia.document.DocumentMeta
-
Set the date and time when the document was last printed.
- setPrintdate(String) - Method in class org.apache.maven.doxia.document.DocumentMeta
-
Set the date as String (recommended format is ISO 8601) when
the document was last printed.
- setPrintedBy(String) - Method in class org.apache.maven.doxia.document.DocumentMeta
-
Set the name of the person who last printed the document.
- setProjectLogo(String) - Method in class org.apache.maven.doxia.document.DocumentCover
-
Set the location of an image file that represents the
project logo.
- setProjectName(String) - Method in class org.apache.maven.doxia.document.DocumentCover
-
Set the name of the project.
- setRef(String) - Method in class org.apache.maven.doxia.document.DocumentTOCItem
-
Set the ref to use for the item.
- setResolveParent(AttributeSet) - Method in class org.apache.maven.doxia.sink.impl.SinkEventAttributeSet
- setRowCount(long) - Method in class org.apache.maven.doxia.document.DocumentStatistic
-
Set the number of rows in the document.
- setSecondParsing(boolean) - Method in class org.apache.maven.doxia.parser.AbstractParser
-
Set secondParsing
to true, if we need a second parsing.
- setSectionLevel(int) - Method in class org.apache.maven.doxia.parser.Xhtml5BaseParser
-
Set the current section level.
- setSectionLevel(int) - Method in class org.apache.maven.doxia.parser.XhtmlBaseParser
-
Set the current section level.
- setSentenceCount(long) - Method in class org.apache.maven.doxia.document.DocumentStatistic
-
Set the number of sentences in the document.
- setState(String) - Method in class org.apache.maven.doxia.document.DocumentAuthor
-
Set the state or province of the address of the author, if
applicable.
- setStreet(String) - Method in class org.apache.maven.doxia.document.DocumentAuthor
-
Set the street name of the address of the author.
- setSubject(String) - Method in class org.apache.maven.doxia.document.DocumentMeta
-
Set the subject of the document.
- setSyllableCount(long) - Method in class org.apache.maven.doxia.document.DocumentStatistic
-
Set the number of syllables in the document.
- setTableCount(long) - Method in class org.apache.maven.doxia.document.DocumentStatistic
-
Set the number of tabels in the document.
- setTargetFrame(String) - Method in class org.apache.maven.doxia.document.DocumentHyperlinkBehaviour
-
Set the name of the default target frame.
- setTemplate(DocumentTemplate) - Method in class org.apache.maven.doxia.document.DocumentMeta
-
Set a template that was used to create the document.
- setTitle(String) - Method in class org.apache.maven.doxia.document.DocumentAuthor
-
Set the title of the author.
- setTitle(String) - Method in class org.apache.maven.doxia.document.DocumentMeta
-
Set the title of the document.
- setTitle(String) - Method in class org.apache.maven.doxia.document.DocumentTemplate
-
Set the name of the document template.
- setTitle(String) - Method in class org.apache.maven.doxia.index.IndexEntry
-
Sets the title.
- setToc(DocumentTOC) - Method in class org.apache.maven.doxia.document.DocumentModel
-
Set the TOC (Table of Contents) information properties.
- setTrimmableWhitespace(boolean) - Method in class org.apache.maven.doxia.parser.AbstractXmlParser
-
Specify that text will be collapsed.
- setValidate(boolean) - Method in class org.apache.maven.doxia.parser.AbstractXmlParser
-
Specify a flag to validate or not the XML content.
- setVerbatimFlag(boolean) - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
-
Setter for the field verbatimFlag
.
- setVerbatimFlag(boolean) - Method in class org.apache.maven.doxia.sink.impl.XhtmlBaseSink
-
Setter for the field verbatimFlag
.
- setWordCount(long) - Method in class org.apache.maven.doxia.document.DocumentStatistic
-
Set the number of words in the document.
- sidebar() - Method in class org.apache.maven.doxia.sink.impl.RandomAccessSink
- sidebar(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.RandomAccessSink
- sidebar() - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
- sidebar(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
- sidebar() - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
- sidebar(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
- sidebar_() - Method in class org.apache.maven.doxia.sink.impl.RandomAccessSink
- sidebar_() - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
- sidebar_() - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
- SINK_BASE_ATTRIBUTES - Static variable in class org.apache.maven.doxia.sink.impl.SinkUtils
-
The set of base attributes.
- SINK_BR_ATTRIBUTES - Static variable in class org.apache.maven.doxia.sink.impl.SinkUtils
-
The attributes that are supported for the br tag.
- SINK_HR_ATTRIBUTES - Static variable in class org.apache.maven.doxia.sink.impl.SinkUtils
-
The attributes that are supported for the <hr> tag.
- SINK_IMG_ATTRIBUTES - Static variable in class org.apache.maven.doxia.sink.impl.SinkUtils
-
The attributes that are supported for the <img> tag.
- SINK_LINK_ATTRIBUTES - Static variable in class org.apache.maven.doxia.sink.impl.SinkUtils
-
The attributes that are supported for the <a> tag.
- SINK_SECTION_ATTRIBUTES - Static variable in class org.apache.maven.doxia.sink.impl.SinkUtils
-
The attributes that are supported for the section tags, like <p>, <h2>, <div>.
- SINK_TABLE_ATTRIBUTES - Static variable in class org.apache.maven.doxia.sink.impl.SinkUtils
-
The attributes that are supported for the <table> tag.
- SINK_TD_ATTRIBUTES - Static variable in class org.apache.maven.doxia.sink.impl.SinkUtils
-
The attributes that are supported for the <td> and <th> tags.
- SINK_TR_ATTRIBUTES - Static variable in class org.apache.maven.doxia.sink.impl.SinkUtils
-
The attributes that are supported for the <tr> tag.
- SINK_VERBATIM_ATTRIBUTES - Static variable in class org.apache.maven.doxia.sink.impl.SinkUtils
-
The attributes that are supported for the <div> and <pre> tags.
- SinkAdapter - Class in org.apache.maven.doxia.sink.impl
-
Empty implementation of the Sink
interface.
- SinkAdapter() - Constructor for class org.apache.maven.doxia.sink.impl.SinkAdapter
-
- SinkEventAttributeSet - Class in org.apache.maven.doxia.sink.impl
-
Implementation of MutableAttributeSet using a LinkedHashMap.
- SinkEventAttributeSet() - Constructor for class org.apache.maven.doxia.sink.impl.SinkEventAttributeSet
-
Constructs a new, empty SinkEventAttributeSet with default size 5.
- SinkEventAttributeSet(int) - Constructor for class org.apache.maven.doxia.sink.impl.SinkEventAttributeSet
-
Constructs a new, empty SinkEventAttributeSet with the specified initial size.
- SinkEventAttributeSet(String...) - Constructor for class org.apache.maven.doxia.sink.impl.SinkEventAttributeSet
-
Constructs a new SinkEventAttributeSet with the attribute name-value
mappings as given by the specified String array.
- SinkEventAttributeSet(AttributeSet) - Constructor for class org.apache.maven.doxia.sink.impl.SinkEventAttributeSet
-
Constructs a new SinkEventAttributeSet with the same attribute name-value
mappings as in the specified AttributeSet.
- SinkEventAttributeSet.Semantics - Class in org.apache.maven.doxia.sink.impl
-
Attribute sets for the semantic attribute.
- SinkUtils - Class in org.apache.maven.doxia.sink.impl
-
Collection of common utility methods for sinks.
- SLASH - Static variable in interface org.apache.maven.doxia.markup.Markup
-
slash character: '/'
- SMALL - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
-
Xhtml tag for small
.
- SMALL - Static variable in class org.apache.maven.doxia.sink.impl.SinkEventAttributeSet.Semantics
-
An unmodifiable attribute set containing only a small attribute.
- SnippetMacro - Class in org.apache.maven.doxia.macro.snippet
-
A macro that prints out the content of a file or a URL.
- SnippetMacro() - Constructor for class org.apache.maven.doxia.macro.snippet.SnippetMacro
-
- SnippetReader - Class in org.apache.maven.doxia.macro.snippet
-
Utility class for reading snippets.
- SnippetReader(URL, String) - Constructor for class org.apache.maven.doxia.macro.snippet.SnippetReader
-
Constructor.
- SnippetReader(URL) - Constructor for class org.apache.maven.doxia.macro.snippet.SnippetReader
-
Constructor.
- SOURCE - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
-
Html5 tag for source
.
- SPACE - Static variable in interface org.apache.maven.doxia.markup.Markup
-
space character: ' '
- SPAN - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
-
Xhtml tag for span
.
- SsiMacro - Class in org.apache.maven.doxia.macro
-
Deprecated.
- SsiMacro() - Constructor for class org.apache.maven.doxia.macro.SsiMacro
-
Deprecated.
- STAR - Static variable in interface org.apache.maven.doxia.markup.Markup
-
star character: '*'
- STRIKE - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
-
Xhtml tag for strike
.
- STRONG - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
-
Xhtml tag for strong
.
- STRONG - Static variable in class org.apache.maven.doxia.sink.impl.SinkEventAttributeSet.Semantics
-
An unmodifiable attribute set containing only a strong attribute.
- STYLE - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
-
Xhtml tag for style
.
- SUB - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
-
Xhtml tag for sub
.
- SUBSCRIPT - Static variable in class org.apache.maven.doxia.sink.impl.SinkEventAttributeSet.Semantics
-
An unmodifiable attribute set containing only a subscript attribute.
- SUMMARY - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
-
Html5 tag for summary
.
- SUP - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
-
Xhtml tag for sup
.
- SUPERSCRIPT - Static variable in class org.apache.maven.doxia.sink.impl.SinkEventAttributeSet.Semantics
-
An unmodifiable attribute set containing only a superscript attribute.
- SwfMacro - Class in org.apache.maven.doxia.macro
-
Deprecated.
- SwfMacro() - Constructor for class org.apache.maven.doxia.macro.SwfMacro
-
Deprecated.