Skip navigation links
A B C D E F G H I J K L M N O P Q R S T U V W X 

A

A - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
HTML5 tag for a.
ABBR - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
HTML5 tag for abbr.
ABBREVIATION - Static variable in class org.apache.maven.doxia.sink.impl.SinkEventAttributeSet.Semantics
An unmodifiable attribute set containing only an abbreviation attribute.
AbstractLocator - Class in org.apache.maven.doxia.sink.impl
 
AbstractLocator(String) - Constructor for class org.apache.maven.doxia.sink.impl.AbstractLocator
 
AbstractMacro - Class in org.apache.maven.doxia.macro
Abstract base class to execute Macro.
AbstractMacro() - Constructor for class org.apache.maven.doxia.macro.AbstractMacro
 
AbstractParser - Class in org.apache.maven.doxia.parser
An abstract base class that defines some convenience methods for parsers.
AbstractParser() - Constructor for class org.apache.maven.doxia.parser.AbstractParser
 
AbstractParserModule - Class in org.apache.maven.doxia.parser.module
An abstract base class that implements the ParserModule interface.
AbstractParserModule() - Constructor for class org.apache.maven.doxia.parser.module.AbstractParserModule
Constructor with null.
AbstractParserModule(String) - Constructor for class org.apache.maven.doxia.parser.module.AbstractParserModule
Constructor with same value for everything: source directory and file extension equal parserId.
AbstractParserModule(String, String) - Constructor for class org.apache.maven.doxia.parser.module.AbstractParserModule
Constructor with same value for parser id and source directory.
AbstractParserModule(String, String, String...) - Constructor for class org.apache.maven.doxia.parser.module.AbstractParserModule
Constructor for AbstractParserModule.
AbstractSink - Class in org.apache.maven.doxia.sink.impl
An abstract base class that defines some convenience methods for sinks.
AbstractSink() - Constructor for class org.apache.maven.doxia.sink.impl.AbstractSink
 
AbstractTextParser - Class in org.apache.maven.doxia.parser
An abstract class that defines some convenience methods for Text parsers.
AbstractTextParser() - Constructor for class org.apache.maven.doxia.parser.AbstractTextParser
 
AbstractTextSink - Class in org.apache.maven.doxia.sink.impl
An abstract Sink for text markup syntax.
AbstractTextSink() - Constructor for class org.apache.maven.doxia.sink.impl.AbstractTextSink
 
AbstractTextSinkFactory - Class in org.apache.maven.doxia.sink.impl
An abstract SinkFactory for Text markup syntax.
AbstractTextSinkFactory() - Constructor for class org.apache.maven.doxia.sink.impl.AbstractTextSinkFactory
 
AbstractXmlParser - Class in org.apache.maven.doxia.parser
An abstract class that defines some convenience methods for XML parsers.
AbstractXmlParser() - Constructor for class org.apache.maven.doxia.parser.AbstractXmlParser
 
AbstractXmlParser.CachedFileEntityResolver - Class in org.apache.maven.doxia.parser
Implementation of the callback mechanism EntityResolver.
AbstractXmlSink - Class in org.apache.maven.doxia.sink.impl
An abstract Sink for xml markup syntax.
AbstractXmlSink() - Constructor for class org.apache.maven.doxia.sink.impl.AbstractXmlSink
 
AbstractXmlSinkFactory - Class in org.apache.maven.doxia.sink.impl
An abstract SinkFactory for XML markup syntax.
AbstractXmlSinkFactory() - Constructor for class org.apache.maven.doxia.sink.impl.AbstractXmlSinkFactory
 
addAttribute(Object, Object) - Method in class org.apache.maven.doxia.sink.impl.SinkEventAttributeSet
Adds an attribute with the given name and value.
addAttributes(AttributeSet) - Method in class org.apache.maven.doxia.sink.impl.SinkEventAttributeSet
ADDRESS - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
HTML5 tag for address.
address() - Method in class org.apache.maven.doxia.sink.impl.AbstractSink
 
address(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
address(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
 
address(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
address_() - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
address_() - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
 
address_() - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
addSink(Sink) - Method in class org.apache.maven.doxia.sink.impl.PipelineSink
Deprecated.
Add a Sink to the List of Sinks.
addSinkHook() - Method in class org.apache.maven.doxia.sink.impl.RandomAccessSink
Deprecated.
By calling this method a sink reference is added at the current position.
addSinkWrapperFactory(SinkWrapperFactory) - Method in class org.apache.maven.doxia.parser.AbstractParser
 
addSinkWrapperFactory(SinkWrapperFactory) - Method in interface org.apache.maven.doxia.parser.Parser
Registers a given SinkWrapperFactory with the parser used in subsequent calls of parse(...)
anchor(String, SinkEventAttributes) - Method in class org.apache.maven.doxia.index.IndexingSink
 
anchor(String) - Method in class org.apache.maven.doxia.sink.impl.AbstractSink
 
anchor(String, SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
anchor(String, SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
 
anchor(String, SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.UniqueAnchorNamesValidator
 
anchor(String, SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
anchor_() - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
anchor_() - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
 
anchor_() - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
ANNOTATION - Static variable in class org.apache.maven.doxia.sink.impl.SinkEventAttributeSet.Semantics
An unmodifiable attribute set containing only an annotation attribute.
AREA - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
HTML5 tag for area.
ARTICLE - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
HTML5 tag for article.
article() - Method in class org.apache.maven.doxia.sink.impl.AbstractSink
 
article(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
article(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
 
article(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
article_() - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
article_() - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
 
article_() - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
ASIDE - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
HTML5 tag for aside.
AUDIO - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
HTML5 tag for audio.
author() - Method in class org.apache.maven.doxia.sink.impl.AbstractSink
 
author(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
author(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
 
author_() - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
author_() - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
 

B

B - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
HTML5 tag for b.
BANG - Static variable in interface org.apache.maven.doxia.markup.XmlMarkup
bang character: '!'
BASE - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
HTML5 tag for base.
baseEndTag(XmlPullParser, Sink) - Method in class org.apache.maven.doxia.parser.Xhtml1BaseParser
 
baseEndTag(XmlPullParser, Sink) - Method in class org.apache.maven.doxia.parser.Xhtml5BaseParser
Goes through a common list of possible html end tags.
baseEndTag(String, SinkEventAttributeSet, Sink) - Method in class org.apache.maven.doxia.parser.Xhtml5BaseParser
 
baseStartTag(XmlPullParser, Sink) - Method in class org.apache.maven.doxia.parser.Xhtml1BaseParser
Translates obsolete XHTML 1.0 attributes/elements to valid XHTML5 ones before calling the underlying Xhtml5BaseParser.
baseStartTag(XmlPullParser, Sink) - Method in class org.apache.maven.doxia.parser.Xhtml5BaseParser
Goes through a common list of possible html5 start tags.
baseStartTag(String, SinkEventAttributeSet, Sink) - Method in class org.apache.maven.doxia.parser.Xhtml5BaseParser
 
BDI - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
HTML5 tag for bdi.
BDO - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
HTML5 tag for bdo.
BIDIRECTIONAL_ISOLATION - Static variable in class org.apache.maven.doxia.sink.impl.SinkEventAttributeSet.Semantics
An unmodifiable attribute set containing only a bidirectionalIsolation attribute.
BIDIRECTIONAL_OVERRIDE - Static variable in class org.apache.maven.doxia.sink.impl.SinkEventAttributeSet.Semantics
An unmodifiable attribute set containing only a bidirectionalOverride attribute.
BLOCKQUOTE - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
HTML5 tag for blockquote.
blockquote() - Method in class org.apache.maven.doxia.sink.impl.AbstractSink
 
blockquote(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
blockquote(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
 
blockquote(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
blockquote_() - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
blockquote_() - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
 
blockquote_() - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
BODY - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
HTML5 tag for body.
body() - Method in class org.apache.maven.doxia.sink.impl.AbstractSink
 
body(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
body(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
 
body_() - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
body_() - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
 
bold() - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
BOLD - Static variable in class org.apache.maven.doxia.sink.impl.SinkEventAttributeSet
An unmodifiable attribute set containing only a bold attribute.
BOLD - Static variable in class org.apache.maven.doxia.sink.impl.SinkEventAttributeSet.Semantics
An unmodifiable attribute set containing only a bold attribute.
bold() - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
 
bold() - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
bold_() - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
bold_() - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
 
bold_() - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
BR - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
HTML5 tag for br.
BufferingSinkProxyFactory - Class in org.apache.maven.doxia.sink.impl
Buffers all method calls on the proxied Sink until its Sink.flush() is called.
BufferingSinkProxyFactory() - Constructor for class org.apache.maven.doxia.sink.impl.BufferingSinkProxyFactory
 
BufferingSinkProxyFactory.BufferingSink - Interface in org.apache.maven.doxia.sink.impl
 
BUTTON - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
HTML5 tag for button.
ByLineReaderSource - Class in org.apache.maven.doxia.util
ByLineSource default implementation
ByLineReaderSource(Reader) - Constructor for class org.apache.maven.doxia.util.ByLineReaderSource
Creates the ByLineReaderSource.
ByLineReaderSource(Reader, String) - Constructor for class org.apache.maven.doxia.util.ByLineReaderSource
Constructor for ByLineReaderSource.
ByLineSource - Interface in org.apache.maven.doxia.util
The token are the new lines :)

C

CachedFileEntityResolver() - Constructor for class org.apache.maven.doxia.parser.AbstractXmlParser.CachedFileEntityResolver
 
cacheSnippet(URL, String, String) - Method in class org.apache.maven.doxia.macro.snippet.SnippetMacro
Puts the given snippet into the cache.
CANVAS - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
HTML5 tag for canvas.
CAPTION - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
HTML5 tag for caption.
castAsBufferingSink(Sink) - Static method in class org.apache.maven.doxia.sink.impl.BufferingSinkProxyFactory
 
CDATA - Static variable in interface org.apache.maven.doxia.markup.XmlMarkup
CDATA.
CDATA_TYPE - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
A CDATA type event.
CENTER - Static variable in class org.apache.maven.doxia.sink.impl.SinkEventAttributeSet
An unmodifiable attribute set containing only a center attribute.
CITATION - Static variable in class org.apache.maven.doxia.sink.impl.SinkEventAttributeSet.Semantics
An unmodifiable attribute set containing only a citation attribute.
CITE - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
HTML5 tag for cite.
clone() - Method in class org.apache.maven.doxia.sink.impl.SinkEventAttributeSet
close() - Method in class org.apache.maven.doxia.index.IndexingSink
 
close() - Method in class org.apache.maven.doxia.sink.impl.RandomAccessSink
Deprecated.
Close all sinks
close() - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
close() - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
 
close() - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
close() - Method in class org.apache.maven.doxia.util.ByLineReaderSource
close the source.
close() - Method in interface org.apache.maven.doxia.util.ByLineSource
close the source.
close() - Method in class org.apache.maven.doxia.util.LineBreaker
Close the writer.
CODE - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
HTML5 tag for code.
CODE - Static variable in class org.apache.maven.doxia.sink.impl.SinkEventAttributeSet.Semantics
An unmodifiable attribute set containing only a code attribute.
COL - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
HTML5 tag for col.
COLGROUP - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
HTML5 tag for colgroup.
COLON - Static variable in interface org.apache.maven.doxia.markup.Markup
colon character: ':'
COMMAND - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
HTML5 tag for command.
comment(String) - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
comment(String) - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
 
comment(String) - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
compare(SinkWrapperFactory, SinkWrapperFactory) - Method in class org.apache.maven.doxia.sink.impl.SinkWrapperFactoryComparator
 
consecutiveSections(int, Sink, SinkEventAttributeSet) - Method in class org.apache.maven.doxia.parser.Xhtml5BaseParser
containsAttribute(Object, Object) - Method in class org.apache.maven.doxia.sink.impl.SinkEventAttributeSet
containsAttributes(AttributeSet) - Method in class org.apache.maven.doxia.sink.impl.SinkEventAttributeSet
content() - Method in class org.apache.maven.doxia.sink.impl.AbstractSink
 
content(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
content(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
 
content(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
content(String) - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
Write HTML escaped text to output.
content_() - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
content_() - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
 
content_() - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
contentStack - Variable in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
Keep track of the main and div tags for content events.
copyAttributes() - Method in class org.apache.maven.doxia.sink.impl.SinkEventAttributeSet
CreateAnchorsForIndexEntries - Class in org.apache.maven.doxia.sink.impl
Sink wrapper which emits anchors for each entry detected by the underlying IndexingSink.
CreateAnchorsForIndexEntries(Sink) - Constructor for class org.apache.maven.doxia.sink.impl.CreateAnchorsForIndexEntries
 
CreateAnchorsForIndexEntriesFactory - Class in org.apache.maven.doxia.sink.impl
 
CreateAnchorsForIndexEntriesFactory() - Constructor for class org.apache.maven.doxia.sink.impl.CreateAnchorsForIndexEntriesFactory
 
createSink(Writer, String) - Method in class org.apache.maven.doxia.sink.impl.AbstractTextSinkFactory
Create a text Sink for a given encoding.
createSink(File, String) - Method in class org.apache.maven.doxia.sink.impl.AbstractTextSinkFactory
createSink(File, String, String) - Method in class org.apache.maven.doxia.sink.impl.AbstractTextSinkFactory
createSink(OutputStream) - Method in class org.apache.maven.doxia.sink.impl.AbstractTextSinkFactory
createSink(OutputStream, String) - Method in class org.apache.maven.doxia.sink.impl.AbstractTextSinkFactory
createSink(Writer, String, String) - Method in class org.apache.maven.doxia.sink.impl.AbstractXmlSinkFactory
Create a text Sink for a given encoding and for a given language identifier.
createWrapper(Sink) - Method in class org.apache.maven.doxia.sink.impl.BufferingSinkProxyFactory
 
createWrapper(Sink) - Method in class org.apache.maven.doxia.sink.impl.CreateAnchorsForIndexEntriesFactory
 
createWrapper(Sink) - Method in interface org.apache.maven.doxia.sink.impl.SinkWrapperFactory
By default all wrappers just delegate each method to the wrapped sink's method.
createWrapper(Sink) - Method in class org.apache.maven.doxia.sink.impl.UniqueAnchorNamesValidatorFactory
 

D

DATA - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
HTML5 tag for data.
data(String) - Method in class org.apache.maven.doxia.sink.impl.AbstractSink
 
data(String, SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
data(String, SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
 
data(String, SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
data_() - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
data_() - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
 
data_() - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
DATALIST - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
HTML5 tag for datalist.
date() - Method in class org.apache.maven.doxia.sink.impl.AbstractSink
 
date(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
date(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
 
date_() - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
date_() - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
 
DD - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
HTML5 tag for dd.
DEFAULT_MAX_LINE_LENGTH - Static variable in class org.apache.maven.doxia.util.LineBreaker
The default maximal line length.
DefaultDoxia - Class in org.apache.maven.doxia
Simple implementation of the Doxia interface: uses a ParserManager to lookup a parser.
DefaultDoxia() - Constructor for class org.apache.maven.doxia.DefaultDoxia
 
DefaultMacroManager - Class in org.apache.maven.doxia.macro.manager
Default implementation of MacroManager
DefaultMacroManager() - Constructor for class org.apache.maven.doxia.macro.manager.DefaultMacroManager
 
DefaultParserManager - Class in org.apache.maven.doxia.parser.manager
Simple implementation of the ParserManager interface.
DefaultParserManager() - Constructor for class org.apache.maven.doxia.parser.manager.DefaultParserManager
 
DefaultParserModuleManager - Class in org.apache.maven.doxia.parser.module
Simple implementation of the ParserModuleManager interface.
DefaultParserModuleManager() - Constructor for class org.apache.maven.doxia.parser.module.DefaultParserModuleManager
 
definedTerm() - Method in class org.apache.maven.doxia.sink.impl.AbstractSink
 
definedTerm(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
definedTerm(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
 
definedTerm(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
definedTerm_() - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
definedTerm_() - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
 
definedTerm_() - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
definition() - Method in class org.apache.maven.doxia.sink.impl.AbstractSink
 
definition(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
DEFINITION - Static variable in class org.apache.maven.doxia.sink.impl.SinkEventAttributeSet.Semantics
An unmodifiable attribute set containing only a definition attribute.
definition(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
 
definition(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
definition_() - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
definition_() - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
 
definition_() - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
definitionList() - Method in class org.apache.maven.doxia.sink.impl.AbstractSink
 
definitionList(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
definitionList(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
 
definitionList(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
definitionList_() - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
definitionList_() - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
 
definitionList_() - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
definitionListItem() - Method in class org.apache.maven.doxia.sink.impl.AbstractSink
 
definitionListItem(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
definitionListItem(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
 
definitionListItem_() - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
definitionListItem_() - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
 
DEL - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
HTML5 tag for del.
DELETE - Static variable in class org.apache.maven.doxia.sink.impl.SinkEventAttributeSet.Semantics
An unmodifiable attribute set containing only a delete attribute.
DETAILS - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
HTML5 tag for details.
DFN - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
HTML5 tag for dfn.
DIALOG - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
HTML5 tag for dialog.
DIV - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
HTML5 tag for div.
division() - Method in class org.apache.maven.doxia.sink.impl.AbstractSink
 
division(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
division(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
 
division(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
division_() - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
division_() - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
 
division_() - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
DL - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
HTML5 tag for dl.
DOCTYPE_START - Static variable in interface org.apache.maven.doxia.markup.XmlMarkup
DOCTYPE start.
Doxia - Interface in org.apache.maven.doxia
Basic interface of the Doxia framework.
DoxiaUtils - Class in org.apache.maven.doxia.util
General Doxia utility methods.
doxiaVersion() - Static method in class org.apache.maven.doxia.parser.AbstractParser
The current Doxia version.
DT - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
HTML5 tag for dt.

E

EchoMacro - Class in org.apache.maven.doxia.macro
A simple macro that prints out the key and value of some supplied parameters.
EchoMacro() - Constructor for class org.apache.maven.doxia.macro.EchoMacro
 
EM - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
HTML5 tag for em.
EMBED - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
HTML5 tag for embed.
emitHeadingSections(int, Sink, boolean) - Method in class org.apache.maven.doxia.parser.Xhtml5BaseParser
Make sure sections are nested consecutively and correctly inserted for the given heading level
EMPHASIS - Static variable in class org.apache.maven.doxia.sink.impl.SinkEventAttributeSet.Semantics
An unmodifiable attribute set containing only an emphasis attribute.
encodeId(String) - Static method in class org.apache.maven.doxia.util.DoxiaUtils
Construct a valid Doxia id.
encodeURL(String) - Static method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
Forward to HtmlTools.encodeURL(text).
encodeURL(String) - Static method in class org.apache.maven.doxia.util.HtmlTools
Encode an url
ENTITY_CACHE - Static variable in class org.apache.maven.doxia.parser.AbstractXmlParser.CachedFileEntityResolver
Map with systemId as key and the content of systemId as byte[].
ENTITY_START - Static variable in interface org.apache.maven.doxia.markup.XmlMarkup
ENTITY start.
ENTITY_TYPE - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
An HTML entity.
EOL - Static variable in interface org.apache.maven.doxia.macro.Macro
The vm line separator
EOL - Static variable in interface org.apache.maven.doxia.markup.Markup
The vm line separator
EQUAL - Static variable in interface org.apache.maven.doxia.markup.Markup
equal character: '='
equals(Object) - Method in class org.apache.maven.doxia.index.IndexEntry
 
equals(Object) - Method in class org.apache.maven.doxia.sink.impl.SinkEventAttributeSet
error(SAXParseException) - Method in class org.apache.maven.doxia.util.XmlValidator.MessagesErrorHandler
escapeHTML(String) - Static method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
Forward to HtmlTools.escapeHTML(text).
escapeHTML(String) - Static method in class org.apache.maven.doxia.util.HtmlTools
Escape special HTML characters in a String in xml mode.
escapeHTML(String, boolean) - Static method in class org.apache.maven.doxia.util.HtmlTools
Escape special HTML characters in a String.
EventCapturingSinkProxy - Class in org.apache.maven.doxia.sink.impl
A proxy for a Sink which captures all event/method names called on it.
execute(Sink, MacroRequest) - Method in class org.apache.maven.doxia.macro.EchoMacro
Execute the current macro using the given MacroRequest, and emit events into the given sink.
execute(Sink, MacroRequest) - Method in interface org.apache.maven.doxia.macro.Macro
Execute the current macro using the given MacroRequest, and emit events into the given sink.
execute(Sink, MacroRequest) - Method in class org.apache.maven.doxia.macro.snippet.SnippetMacro
Execute the current macro using the given MacroRequest, and emit events into the given sink.
execute(Sink, MacroRequest) - Method in class org.apache.maven.doxia.macro.toc.TocMacro
Execute the current macro using the given MacroRequest, and emit events into the given sink.
executeMacro(String, MacroRequest, Sink) - Method in class org.apache.maven.doxia.parser.AbstractParser
Execute a macro on the given sink.

F

fatalError(SAXParseException) - Method in class org.apache.maven.doxia.util.XmlValidator.MessagesErrorHandler
FIELDSET - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
HTML5 tag for fieldset.
FIGCAPTION - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
HTML5 tag for figcaption.
FIGURE - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
HTML5 tag for figure.
figure() - Method in class org.apache.maven.doxia.sink.impl.AbstractSink
 
figure(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
figure(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
 
figure(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
figure_() - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
figure_() - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
 
figure_() - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
figureCaption() - Method in class org.apache.maven.doxia.sink.impl.AbstractSink
 
figureCaption(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
figureCaption(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
 
figureCaption(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
figureCaption_() - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
figureCaption_() - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
 
figureCaption_() - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
figureGraphics(String) - Method in class org.apache.maven.doxia.sink.impl.AbstractSink
 
figureGraphics(String, SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
figureGraphics(String, SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
 
figureGraphics(String, SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
filterAttributes(AttributeSet, String[]) - Static method in class org.apache.maven.doxia.sink.impl.SinkUtils
Filters the given AttributeSet.
flush() - Method in class org.apache.maven.doxia.sink.impl.RandomAccessSink
Deprecated.
Flush all sinks
flush() - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
flush() - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
 
flush() - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
flush() - Method in class org.apache.maven.doxia.util.LineBreaker
Write out the current StringBuilder and flush the writer.
FOOTER - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
HTML5 tag for footer.
footer() - Method in class org.apache.maven.doxia.sink.impl.AbstractSink
 
footer(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
footer(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
 
footer(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
footer_() - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
footer_() - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
 
footer_() - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
FORM - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
HTML5 tag for form.
formatLocation(Locator) - Static method in class org.apache.maven.doxia.sink.impl.AbstractSink
Creates a string with line/column information.

G

getAddDefaultEntities() - Method in class org.apache.maven.doxia.parser.AbstractXmlParser
 
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.
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
Deprecated.
this does not work in multi-module builds, see DOXIA-373
getBufferedSink() - Method in interface org.apache.maven.doxia.sink.impl.BufferingSinkProxyFactory.BufferingSink
 
getCellCount() - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
Getter for the field cellCount.
getCellJustif() - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
Getter for the field cellJustif.
getChildEntries() - Method in class org.apache.maven.doxia.index.IndexEntry
Returns an unmodifiableList of the child entries.
getColumnNumber() - Method in exception org.apache.maven.doxia.parser.ParseException
Getter for the field columnNumber.
getDefaultHandler() - Method in class org.apache.maven.doxia.util.XmlValidator
 
getDestination() - Method in class org.apache.maven.doxia.util.LineBreaker
Returns the current destination writer.
getDocumentLocator() - Method in class org.apache.maven.doxia.sink.impl.AbstractSink
 
getDocumentLocator() - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
 
getEntityResolver() - Method in class org.apache.maven.doxia.util.XmlValidator
 
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.
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.
getHtmlTag(String) - Static method in class org.apache.maven.doxia.util.HtmlTools
Returns a tag for a defined HTML tag name.
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.
getLastEntry() - Method in class org.apache.maven.doxia.index.IndexEntry
Returns the last entry.
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.
getLocationLogPrefix() - Method in class org.apache.maven.doxia.sink.impl.AbstractSink
 
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
Gets the current MacroManager.
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.
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.
getPrevEntry() - Method in class org.apache.maven.doxia.index.IndexEntry
Returns the previous entry.
getPriority() - Method in class org.apache.maven.doxia.sink.impl.BufferingSinkProxyFactory
 
getPriority() - Method in class org.apache.maven.doxia.sink.impl.CreateAnchorsForIndexEntriesFactory
 
getPriority() - Method in interface org.apache.maven.doxia.sink.impl.SinkWrapperFactory
Determines the order of sink wrappers.
getPriority() - Method in class org.apache.maven.doxia.sink.impl.UniqueAnchorNamesValidatorFactory
 
getReference() - Method in class org.apache.maven.doxia.sink.impl.AbstractLocator
 
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.
getRootEntry() - Method in class org.apache.maven.doxia.index.IndexingSink
This should only be called once the sink is closed.
getSectionLevel() - Method in class org.apache.maven.doxia.parser.Xhtml5BaseParser
Return the current section level.
getSinkWrapperFactories() - Method in class org.apache.maven.doxia.parser.AbstractParser
Returns all sink wrapper factories (both registered automatically and manually).
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.
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.
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.
getType() - Method in class org.apache.maven.doxia.index.IndexEntry
Returns the type of this entry.
getType() - Method in class org.apache.maven.doxia.parser.AbstractParser
The parser type value could be Parser.UNKNOWN_TYPE, Parser.TXT_TYPE or Parser.XML_TYPE.
getType() - Method in class org.apache.maven.doxia.parser.AbstractTextParser
The parser type value could be Parser.UNKNOWN_TYPE, Parser.TXT_TYPE or Parser.XML_TYPE.
getType() - Method in class org.apache.maven.doxia.parser.AbstractXmlParser
The parser type value could be Parser.UNKNOWN_TYPE, Parser.TXT_TYPE or Parser.XML_TYPE.
getType() - Method in interface org.apache.maven.doxia.parser.Parser
The parser type value could be Parser.UNKNOWN_TYPE, Parser.TXT_TYPE or Parser.XML_TYPE.
getVerbatimMode() - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
 
getWrappedSink(Sink) - Method in class org.apache.maven.doxia.parser.AbstractParser
Creates a sink pipeline built from all registered SinkWrapperFactory objects.
getWrappedSink() - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
 
getXmlReader() - Method in class org.apache.maven.doxia.util.XmlValidator
 
GREATER_THAN - Static variable in interface org.apache.maven.doxia.markup.Markup
end character: '<'

H

H1 - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
HTML5 tag for h1.
H2 - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
HTML5 tag for h2.
H3 - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
HTML5 tag for h3.
H4 - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
HTML5 tag for h4.
H5 - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
HTML5 tag for h5.
H6 - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
HTML5 tag for h6.
handleCdsect(XmlPullParser, Sink) - Method in class org.apache.maven.doxia.parser.AbstractXmlParser
Handles CDATA sections.
handleCdsect(XmlPullParser, Sink) - Method in class org.apache.maven.doxia.parser.Xhtml5BaseParser
Handles CDATA sections.
handleComment(XmlPullParser, Sink) - Method in class org.apache.maven.doxia.parser.AbstractXmlParser
Handles comments.
handleComment(XmlPullParser, Sink) - Method in class org.apache.maven.doxia.parser.Xhtml5BaseParser
Handles comments.
handleEndTag(XmlPullParser, Sink) - Method in class org.apache.maven.doxia.parser.AbstractXmlParser
Goes through the possible end tags.
handleEndTag(XmlPullParser, Sink) - Method in class org.apache.maven.doxia.parser.Xhtml5BaseParser
Goes through the possible end tags.
handleEntity(XmlPullParser, Sink) - Method in class org.apache.maven.doxia.parser.AbstractXmlParser
Handles entities.
handleStartTag(XmlPullParser, Sink) - Method in class org.apache.maven.doxia.parser.AbstractXmlParser
Goes through the possible start tags.
handleStartTag(XmlPullParser, Sink) - Method in class org.apache.maven.doxia.parser.Xhtml5BaseParser
Goes through the possible start tags.
handleText(XmlPullParser, Sink) - Method in class org.apache.maven.doxia.parser.AbstractXmlParser
Handles text events.
handleText(XmlPullParser, Sink) - Method in class org.apache.maven.doxia.parser.Xhtml5BaseParser
Handles text events.
handleUnknown(XmlPullParser, Sink, int) - Method in class org.apache.maven.doxia.parser.AbstractXmlParser
Handles an unknown event.
handleUnknown(String, SinkEventAttributeSet, Sink, int) - Method in class org.apache.maven.doxia.parser.AbstractXmlParser
 
hasAnchor() - Method in class org.apache.maven.doxia.index.IndexEntry
Returns if the entry's id already has an anchor in the underlying document.
hashCode() - Method in class org.apache.maven.doxia.index.IndexEntry
 
hashCode() - Method in class org.apache.maven.doxia.sink.impl.SinkEventAttributeSet
HEAD - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
HTML5 tag for head.
head() - Method in class org.apache.maven.doxia.sink.impl.AbstractSink
 
head(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
head(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
 
head_() - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
head_() - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
 
HEADER - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
HTML5 tag for header.
header() - Method in class org.apache.maven.doxia.sink.impl.AbstractSink
 
header(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
header(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
 
header(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
header_() - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
header_() - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
 
header_() - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
HGROUP - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
HTML5 tag for hgroup.
HIGHLIGHT - Static variable in class org.apache.maven.doxia.sink.impl.SinkEventAttributeSet.Semantics
An unmodifiable attribute set containing only a highlight attribute.
horizontalRule() - Method in class org.apache.maven.doxia.sink.impl.AbstractSink
 
horizontalRule(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
horizontalRule(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
 
horizontalRule(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
HR - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
HTML5 tag for hr.
HTML - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
HTML5 tag for html.
HtmlMarkup - Interface in org.apache.maven.doxia.markup
List of Html tags.
HtmlTools - Class in org.apache.maven.doxia.util
The HtmlTools class defines methods to HTML handling.

I

I - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
HTML5 tag for i.
IFRAME - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
HTML5 tag for iframe.
IMG - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
HTML5 tag for img.
IndexEntry - Class in org.apache.maven.doxia.index
Representing the index tree within a document with the most important metadata per entry.
IndexEntry(String) - Constructor for class org.apache.maven.doxia.index.IndexEntry
Constructor for root entry.
IndexEntry(IndexEntry, String) - Constructor for class org.apache.maven.doxia.index.IndexEntry
Constructor.
IndexEntry(IndexEntry, String, IndexEntry.Type) - Constructor for class org.apache.maven.doxia.index.IndexEntry
Constructor.
IndexEntry.Type - Enum in org.apache.maven.doxia.index
 
IndexingSink - Class in org.apache.maven.doxia.index
A sink wrapper for populating an index tree for particular elements in a document.
IndexingSink(IndexEntry) - Constructor for class org.apache.maven.doxia.index.IndexingSink
Deprecated.
legacy constructor, use IndexingSink(Sink) with SinkAdapter as argument and call IndexingSink.getRootEntry() to retrieve the index tree afterwards.
IndexingSink(Sink) - Constructor for class org.apache.maven.doxia.index.IndexingSink
 
init() - Method in class org.apache.maven.doxia.parser.AbstractParser
Initialize the parser.
init() - Method in class org.apache.maven.doxia.parser.Xhtml5BaseParser
Initialize the parser.
init() - Method in class org.apache.maven.doxia.sink.impl.AbstractSink
This is called in AbstractSink.head() or in Sink.close(), and can be used to set the sink into a clear state so it can be re-used.
init() - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
This is called in AbstractSink.head() or in Sink.close(), and can be used to set the sink into a clear state so it can be re-used.
initXmlParser(XmlPullParser) - Method in class org.apache.maven.doxia.parser.AbstractXmlParser
Initializes the parser with custom entities or other options.
initXmlParser(XmlPullParser) - Method in class org.apache.maven.doxia.parser.Xhtml5BaseParser
Initializes the parser with custom entities or other options.
inline() - Method in class org.apache.maven.doxia.sink.impl.AbstractSink
 
inline(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
inline(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
 
inline(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
inline_() - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
inline_() - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
 
inline_() - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
inlineStack - Variable in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
Keep track of the closing tags for inline events.
INPUT - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
HTML5 tag for input.
INS - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
HTML5 tag for ins.
INSERT - Static variable in class org.apache.maven.doxia.sink.impl.SinkEventAttributeSet.Semantics
An unmodifiable attribute set containing only an insert attribute.
invoke(Object, Method, Object[]) - Method in class org.apache.maven.doxia.sink.impl.EventCapturingSinkProxy
 
invoke(Object, Method, Object[]) - Method in class org.apache.maven.doxia.sink.impl.PipelineSink
Deprecated.
Invoke a Method on this PipelineSink.
isCollapsibleWhitespace() - Method in class org.apache.maven.doxia.parser.AbstractXmlParser
isCollapsibleWhitespace.
isDefined(Object) - Method in class org.apache.maven.doxia.sink.impl.SinkEventAttributeSet
isDemarcator(String, String, String) - Static method in class org.apache.maven.doxia.macro.snippet.SnippetReader
Determines if the given line is a demarcator.
isEmitAnchorsForIndexableEntries() - Method in class org.apache.maven.doxia.parser.AbstractParser
 
isEmitAnchorsForIndexableEntries() - Method in interface org.apache.maven.doxia.parser.Parser
Returns whether anchors are automatically generated for each index entry found by IndexingSink or not.
isEmitComments() - Method in class org.apache.maven.doxia.parser.AbstractParser
isEmitComments.
isEmitComments() - Method in interface org.apache.maven.doxia.parser.Parser
Does the parser emit Doxia comments event when comments found in source?
isEmpty() - Method in class org.apache.maven.doxia.sink.impl.SinkEventAttributeSet
Checks whether the set of attribs is empty.
isEnd(String, String) - Method in class org.apache.maven.doxia.macro.snippet.SnippetReader
Determines if the given line is an end demarcator.
isEqual(AttributeSet) - Method in class org.apache.maven.doxia.sink.impl.SinkEventAttributeSet
isExternalLink(String) - Static method in class org.apache.maven.doxia.util.DoxiaUtils
Checks if the given string corresponds to an external URI, ie is not a link within the same document nor a relative link to another document (a local link) of the same site.
isHeadFlag() - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
isHeadFlag.
isIgnorableWhitespace() - Method in class org.apache.maven.doxia.parser.AbstractXmlParser
isIgnorableWhitespace.
isInternalLink(String) - Static method in class org.apache.maven.doxia.util.DoxiaUtils
Checks if the given string corresponds to an internal link, ie it is a link to an anchor within the same document.
isInternalParameter(String) - Static method in class org.apache.maven.doxia.macro.MacroRequest
isInternalParameter.
isLocalLink(String) - Static method in class org.apache.maven.doxia.util.DoxiaUtils
Checks if the given string corresponds to a relative link to another document within the same site, ie it is neither an internal nor an external link.
isScriptBlock() - Method in class org.apache.maven.doxia.parser.Xhtml5BaseParser
Checks if we are currently inside a <script> tag.
isSecondParsing() - Method in class org.apache.maven.doxia.parser.AbstractParser
Indicates if we are currently parsing a second time.
isStart(String, String) - Method in class org.apache.maven.doxia.macro.snippet.SnippetReader
Determines if the given line is a start demarcator.
isTrimmableWhitespace() - Method in class org.apache.maven.doxia.parser.AbstractXmlParser
isTrimmableWhitespace.
isValidate() - Method in class org.apache.maven.doxia.parser.AbstractXmlParser
isValidate.
isValidate() - Method in class org.apache.maven.doxia.util.XmlValidator
 
isValidId(String) - Static method in class org.apache.maven.doxia.util.DoxiaUtils
Determines if the specified text is a valid id according to the rules laid out in DoxiaUtils.encodeId(String).
isVerbatim() - Method in class org.apache.maven.doxia.parser.Xhtml5BaseParser
Checks if we are currently inside a <pre> tag.
isVerbatim() - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
 
italic() - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
ITALIC - Static variable in class org.apache.maven.doxia.sink.impl.SinkEventAttributeSet
An unmodifiable attribute set containing only an italic attribute.
ITALIC - Static variable in class org.apache.maven.doxia.sink.impl.SinkEventAttributeSet.Semantics
An unmodifiable attribute set containing only an italic attribute.
italic() - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
 
italic() - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
italic_() - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
italic_() - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
 
italic_() - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink

J

JUSTIFY - Static variable in class org.apache.maven.doxia.sink.impl.SinkEventAttributeSet
An unmodifiable attribute set containing only a justify attribute.

K

KBD - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
HTML5 tag for kbd.
KEYBOARD - Static variable in class org.apache.maven.doxia.sink.impl.SinkEventAttributeSet.Semantics
An unmodifiable attribute set containing only a keyboard attribute.
KEYGEN - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
HTML5 tag for keygen.

L

LABEL - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
HTML5 tag for label.
LEFT - Static variable in class org.apache.maven.doxia.sink.impl.SinkEventAttributeSet
An unmodifiable attribute set containing only a left attribute.
LEFT_CURLY_BRACKET - Static variable in interface org.apache.maven.doxia.markup.Markup
left curly bracket character: '{'
LEFT_SQUARE_BRACKET - Static variable in interface org.apache.maven.doxia.markup.Markup
left square bracket character: '['
LEGEND - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
HTML5 tag for legend.
LESS_THAN - Static variable in interface org.apache.maven.doxia.markup.Markup
start character: '>'
LI - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
HTML5 tag for li.
LINE_THROUGH - Static variable in class org.apache.maven.doxia.sink.impl.SinkEventAttributeSet.Semantics
An unmodifiable attribute set containing only a line-through attribute.
lineBreak() - Method in class org.apache.maven.doxia.sink.impl.AbstractSink
 
lineBreak(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
lineBreak(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
 
lineBreak(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
LineBreaker - Class in org.apache.maven.doxia.util
Allows to specify the line-length of an output writer.
LineBreaker(Writer) - Constructor for class org.apache.maven.doxia.util.LineBreaker
Constructs a new LineBreaker with DEFAULT_MAX_LINE_LENGTH.
LineBreaker(Writer, int) - Constructor for class org.apache.maven.doxia.util.LineBreaker
Constructs a new LineBreaker with the given max line length.
lineBreakOpportunity() - Method in class org.apache.maven.doxia.sink.impl.AbstractSink
 
lineBreakOpportunity(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
lineBreakOpportunity(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
 
lineBreakOpportunity(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
LINETHROUGH - Static variable in class org.apache.maven.doxia.sink.impl.SinkEventAttributeSet
An unmodifiable attribute set containing only a linethrough attribute.
LINK - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
HTML5 tag for link.
link(String) - Method in class org.apache.maven.doxia.sink.impl.AbstractSink
 
link(String, SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
link(String, SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
 
link(String, SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
The default style class for external link is externalLink.
link_() - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
link_() - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
 
link_() - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
list() - Method in class org.apache.maven.doxia.sink.impl.AbstractSink
 
list(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
list(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
 
list(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
list_() - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
list_() - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
 
list_() - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
listItem() - Method in class org.apache.maven.doxia.sink.impl.AbstractSink
 
listItem(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
listItem(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
 
listItem(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
listItem_() - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
listItem_() - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
 
listItem_() - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink

M

Macro - Interface in org.apache.maven.doxia.macro
Base interface of a macro.
MacroExecutionException - Exception in org.apache.maven.doxia.macro
Wrap an exception that occurs during the execution of a Doxia macro.
MacroExecutionException(Throwable) - Constructor for exception org.apache.maven.doxia.macro.MacroExecutionException
Construct a new MacroExecutionException with the specified cause.
MacroExecutionException(String) - Constructor for exception org.apache.maven.doxia.macro.MacroExecutionException
Construct a new MacroExecutionException with the specified detail message.
MacroExecutionException(String, Throwable) - Constructor for exception org.apache.maven.doxia.macro.MacroExecutionException
Construct a new MacroExecutionException with the specified detail message and cause.
MacroManager - Interface in org.apache.maven.doxia.macro.manager
Handles MacroManager lookups.
MacroNotFoundException - Exception in org.apache.maven.doxia.macro.manager
Encapsulate an exception that indicates that a Macro does not exist or could not be found.
MacroNotFoundException(String) - Constructor for exception org.apache.maven.doxia.macro.manager.MacroNotFoundException
Construct a new MacroNotFoundException with the specified detail message.
MacroNotFoundException(Throwable) - Constructor for exception org.apache.maven.doxia.macro.manager.MacroNotFoundException
Constructs a new MacroNotFoundException with the specified cause.
MacroNotFoundException(String, Throwable) - Constructor for exception org.apache.maven.doxia.macro.manager.MacroNotFoundException
Construct a new MacroNotFoundException with the specified detail message and cause.
MacroRequest - Class in org.apache.maven.doxia.macro
MacroRequest class.
MacroRequest(String, AbstractParser, Map<String, Object>, File) - Constructor for class org.apache.maven.doxia.macro.MacroRequest
Constructor for MacroRequest.
MAIN - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
HTML5 tag for main.
MAP - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
HTML5 tag for map.
MARK - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
HTML5 tag for mark.
Markup - Interface in org.apache.maven.doxia.markup
List of constants used by all markup syntax.
MENU - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
HTML5 tag for menu.
MENUITEM - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
HTML5 tag for menuitem.
MessagesErrorHandler() - Constructor for class org.apache.maven.doxia.util.XmlValidator.MessagesErrorHandler
 
META - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
HTML5 tag for meta.
METER - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
HTML5 tag for meter.
MINUS - Static variable in interface org.apache.maven.doxia.markup.Markup
minus character: '-'
monospaced() - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
MONOSPACED - Static variable in class org.apache.maven.doxia.sink.impl.SinkEventAttributeSet
An unmodifiable attribute set containing only a monospaced attribute.
MONOSPACED - Static variable in class org.apache.maven.doxia.sink.impl.SinkEventAttributeSet.Semantics
An unmodifiable attribute set containing only a monospaced attribute.
monospaced() - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
 
monospaced() - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
monospaced_() - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
monospaced_() - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
 
monospaced_() - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink

N

NAV - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
HTML5 tag for nav.
navigation() - Method in class org.apache.maven.doxia.sink.impl.AbstractSink
 
navigation(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
navigation(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
 
navigation(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
navigation_() - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
navigation_() - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
 
navigation_() - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
newInstance(Sink, List<String>) - Static method in class org.apache.maven.doxia.sink.impl.EventCapturingSinkProxy
 
newInstance(List<Sink>) - Static method in class org.apache.maven.doxia.sink.impl.PipelineSink
Deprecated.
Returns an instance of a PipelineSink as a Sink.
nonBreakingSpace() - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
nonBreakingSpace() - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
 
nonBreakingSpace() - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
NOSCRIPT - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
HTML5 tag for noscript.
numberedList(int) - Method in class org.apache.maven.doxia.sink.impl.AbstractSink
 
numberedList(int, SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
numberedList(int, SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
 
numberedList(int, SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
The default list style depends on the numbering.
numberedList_() - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
numberedList_() - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
 
numberedList_() - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
numberedListItem() - Method in class org.apache.maven.doxia.sink.impl.AbstractSink
 
numberedListItem(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
numberedListItem(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
 
numberedListItem(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
numberedListItem_() - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
numberedListItem_() - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
 
numberedListItem_() - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink

O

OBJECT - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
HTML5 tag for object.
OL - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
HTML5 tag for ol.
onIndexEntry(IndexEntry) - Method in class org.apache.maven.doxia.index.IndexingSink
Called at the beginning of each entry (once all metadata about it is collected).
onIndexEntry(IndexEntry) - Method in class org.apache.maven.doxia.sink.impl.CreateAnchorsForIndexEntries
 
onSection(int, SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
Starts a section.
onSection_(int) - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
Ends a section.
onSectionTitle(int, SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
Starts a section title.
onSectionTitle_(int) - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
Ends a section title.
OPTGROUP - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
HTML5 tag for optgroup.
OPTION - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
HTML5 tag for option.
org.apache.maven.doxia - package org.apache.maven.doxia
Maven Doxia API.
org.apache.maven.doxia.index - package org.apache.maven.doxia.index
 
org.apache.maven.doxia.macro - package org.apache.maven.doxia.macro
 
org.apache.maven.doxia.macro.manager - package org.apache.maven.doxia.macro.manager
 
org.apache.maven.doxia.macro.snippet - package org.apache.maven.doxia.macro.snippet
 
org.apache.maven.doxia.macro.toc - package org.apache.maven.doxia.macro.toc
 
org.apache.maven.doxia.markup - package org.apache.maven.doxia.markup
 
org.apache.maven.doxia.parser - package org.apache.maven.doxia.parser
 
org.apache.maven.doxia.parser.manager - package org.apache.maven.doxia.parser.manager
 
org.apache.maven.doxia.parser.module - package org.apache.maven.doxia.parser.module
 
org.apache.maven.doxia.sink.impl - package org.apache.maven.doxia.sink.impl
 
org.apache.maven.doxia.util - package org.apache.maven.doxia.util
 
OUTPUT - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
HTML5 tag for output.
OVERLINE - Static variable in class org.apache.maven.doxia.sink.impl.SinkEventAttributeSet
An unmodifiable attribute set containing only an overline attribute.

P

P - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
HTML5 tag for p.
pageBreak() - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
pageBreak() - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
 
pageBreak() - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
paragraph() - Method in class org.apache.maven.doxia.sink.impl.AbstractSink
 
paragraph(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
paragraph(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
 
paragraph(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
paragraph_() - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
paragraph_() - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
 
paragraph_() - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
PARAM - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
HTML5 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.
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(Exception) - Constructor for exception org.apache.maven.doxia.parser.ParseException
Construct a new ParseException with the specified cause.
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, 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, 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(String, Exception, 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
Deprecated.
Use the SinkWrapper approach which doesn't require the use of dynamic proxies.
PipelineSink(List<Sink>) - Constructor for class org.apache.maven.doxia.sink.impl.PipelineSink
Deprecated.
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
HTML5 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.

Q

Q - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
HTML5 tag for q.
QUOTE - Static variable in interface org.apache.maven.doxia.markup.Markup
double quote character: '\"'
QUOTE - Static variable in class org.apache.maven.doxia.sink.impl.SinkEventAttributeSet.Semantics
An unmodifiable attribute set containing only a quote attribute.

R

RandomAccessSink - Class in org.apache.maven.doxia.sink.impl
Deprecated.
Use BufferingSinkProxyFactory instead which buffers on the (higher) Sink API level which usually is less memory intense than buffering the output stream which is done by this class. Also it doesn't require dynamically creating new sinks leveraging a SinkFactory.
RandomAccessSink(SinkFactory, OutputStream) - Constructor for class org.apache.maven.doxia.sink.impl.RandomAccessSink
Deprecated.
Constructor for RandomAccessSink.
RandomAccessSink(SinkFactory, OutputStream, String) - Constructor for class org.apache.maven.doxia.sink.impl.RandomAccessSink
Deprecated.
Constructor for RandomAccessSink.
RandomAccessSink(SinkFactory, File, String) - Constructor for class org.apache.maven.doxia.sink.impl.RandomAccessSink
Deprecated.
Constructor for RandomAccessSink.
RandomAccessSink(SinkFactory, File, String, String) - Constructor for class org.apache.maven.doxia.sink.impl.RandomAccessSink
Deprecated.
Constructor for RandomAccessSink.
rawText(String) - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
rawText(String) - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
 
rawText(String) - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
RB - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
HTML5 tag for rb.
readSnippet(String) - Method in class org.apache.maven.doxia.macro.snippet.SnippetReader
Reads the snippet with given id.
removeAttribute(Object) - Method in class org.apache.maven.doxia.sink.impl.SinkEventAttributeSet
removeAttributes(Enumeration<?>) - Method in class org.apache.maven.doxia.sink.impl.SinkEventAttributeSet
removeAttributes(AttributeSet) - Method in class org.apache.maven.doxia.sink.impl.SinkEventAttributeSet
resetTextBuffer() - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
Reset the text buffer.
resolveEntity(String, String) - Method in class org.apache.maven.doxia.parser.AbstractXmlParser.CachedFileEntityResolver
RIGHT - Static variable in class org.apache.maven.doxia.sink.impl.SinkEventAttributeSet
An unmodifiable attribute set containing only a right attribute.
RIGHT_CURLY_BRACKET - Static variable in interface org.apache.maven.doxia.markup.Markup
right curly bracket character: '}'
RIGHT_SQUARE_BRACKET - Static variable in interface org.apache.maven.doxia.markup.Markup
right square bracket character: ']'
RP - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
HTML5 tag for rp.
RT - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
HTML5 tag for rt.
RTC - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
HTML5 tag for rtc.
RUBY - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
HTML5 tag for ruby.
RUBY - Static variable in class org.apache.maven.doxia.sink.impl.SinkEventAttributeSet.Semantics
An unmodifiable attribute set containing only a ruby attribute.
RUBY_BASE - Static variable in class org.apache.maven.doxia.sink.impl.SinkEventAttributeSet.Semantics
An unmodifiable attribute set containing only a rubyBase attribute.
RUBY_PARANTHESES - Static variable in class org.apache.maven.doxia.sink.impl.SinkEventAttributeSet.Semantics
An unmodifiable attribute set containing only a rubyParentheses attribute.
RUBY_TEXT - Static variable in class org.apache.maven.doxia.sink.impl.SinkEventAttributeSet.Semantics
An unmodifiable attribute set containing only a rubyText attribute.
RUBY_TEXT_CONTAINER - Static variable in class org.apache.maven.doxia.sink.impl.SinkEventAttributeSet.Semantics
An unmodifiable attribute set containing only a rubyTextContainer attribute.

S

S - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
HTML5 tag for s.
SAMP - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
HTML5 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
HTML5 tag for script.
section(int, SinkEventAttributes) - Method in class org.apache.maven.doxia.index.IndexingSink
 
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.SinkAdapter
section(int, SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
 
section(int, SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
section1() - Method in class org.apache.maven.doxia.sink.impl.AbstractSink
 
section1_() - Method in class org.apache.maven.doxia.sink.impl.AbstractSink
 
section2() - Method in class org.apache.maven.doxia.sink.impl.AbstractSink
 
section2_() - Method in class org.apache.maven.doxia.sink.impl.AbstractSink
 
section3() - Method in class org.apache.maven.doxia.sink.impl.AbstractSink
 
section3_() - Method in class org.apache.maven.doxia.sink.impl.AbstractSink
 
section4() - Method in class org.apache.maven.doxia.sink.impl.AbstractSink
 
section4_() - Method in class org.apache.maven.doxia.sink.impl.AbstractSink
 
section5() - Method in class org.apache.maven.doxia.sink.impl.AbstractSink
 
section5_() - Method in class org.apache.maven.doxia.sink.impl.AbstractSink
 
section6() - Method in class org.apache.maven.doxia.sink.impl.AbstractSink
 
section6_() - Method in class org.apache.maven.doxia.sink.impl.AbstractSink
 
section_(int) - Method in class org.apache.maven.doxia.index.IndexingSink
 
section_(int) - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
section_(int) - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
 
section_(int) - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
sectionTitle() - Method in class org.apache.maven.doxia.sink.impl.AbstractSink
 
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.SinkWrapper
 
sectionTitle(int, SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
sectionTitle1() - Method in class org.apache.maven.doxia.sink.impl.AbstractSink
 
sectionTitle1_() - Method in class org.apache.maven.doxia.sink.impl.AbstractSink
 
sectionTitle2() - Method in class org.apache.maven.doxia.sink.impl.AbstractSink
 
sectionTitle2_() - Method in class org.apache.maven.doxia.sink.impl.AbstractSink
 
sectionTitle3() - Method in class org.apache.maven.doxia.sink.impl.AbstractSink
 
sectionTitle3_() - Method in class org.apache.maven.doxia.sink.impl.AbstractSink
 
sectionTitle4() - Method in class org.apache.maven.doxia.sink.impl.AbstractSink
 
sectionTitle4_() - Method in class org.apache.maven.doxia.sink.impl.AbstractSink
 
sectionTitle5() - Method in class org.apache.maven.doxia.sink.impl.AbstractSink
 
sectionTitle5_() - Method in class org.apache.maven.doxia.sink.impl.AbstractSink
 
sectionTitle6() - Method in class org.apache.maven.doxia.sink.impl.AbstractSink
 
sectionTitle6_() - Method in class org.apache.maven.doxia.sink.impl.AbstractSink
 
sectionTitle_(int) - Method in class org.apache.maven.doxia.index.IndexingSink
 
sectionTitle_() - Method in class org.apache.maven.doxia.sink.impl.AbstractSink
 
sectionTitle_(int) - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
sectionTitle_(int) - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
 
sectionTitle_(int) - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
SELECT - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
HTML5 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.parser.AbstractXmlParser
 
setAnchor(boolean) - Method in class org.apache.maven.doxia.index.IndexEntry
Set if the entry's id already has an anchor in the underlying 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.
setCellJustif(int[]) - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
Setter for the field cellJustif.
setChildEntries(List<IndexEntry>) - Method in class org.apache.maven.doxia.index.IndexEntry
Sets the child entries or creates a new ArrayList if entries == null.
setCollapsibleWhitespace(boolean) - Method in class org.apache.maven.doxia.parser.AbstractXmlParser
Specify that text will be collapsed.
setDefaultHandler(DefaultHandler) - Method in class org.apache.maven.doxia.util.XmlValidator
 
setDocumentLocator(Locator) - Method in class org.apache.maven.doxia.sink.impl.AbstractSink
 
setDocumentLocator(Locator) - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
 
setEmitAnchorsForIndexableEntries(boolean) - Method in class org.apache.maven.doxia.parser.AbstractParser
 
setEmitAnchorsForIndexableEntries(boolean) - Method in interface org.apache.maven.doxia.parser.Parser
Determines whether to automatically generate anchors for each index entry found by IndexingSink or not.
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?
setEntityResolver(EntityResolver) - Method in class org.apache.maven.doxia.util.XmlValidator
 
setHeadFlag(boolean) - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
Setter for the field headFlag.
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.
setInsertNewline(boolean) - Method in class org.apache.maven.doxia.sink.impl.AbstractXmlSink
Setter for the field insertNewline.
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.
setResolveParent(AttributeSet) - Method in class org.apache.maven.doxia.sink.impl.SinkEventAttributeSet
setSecondParsing(boolean) - Method in class org.apache.maven.doxia.parser.AbstractParser
Set secondParsing to true, if this represents a secondary parsing of the same source.
setSectionLevel(int) - Method in class org.apache.maven.doxia.parser.Xhtml5BaseParser
Set the current section level.
setTitle(String) - Method in class org.apache.maven.doxia.index.IndexEntry
Sets the title.
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.
setValidate(boolean) - Method in class org.apache.maven.doxia.util.XmlValidator
 
setVerbatimMode(Xhtml5BaseSink.VerbatimMode) - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
Setter for the field verbatimMode.
setWrappedSink(Sink) - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
 
sidebar() - Method in class org.apache.maven.doxia.sink.impl.AbstractSink
 
sidebar(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
sidebar(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
 
sidebar(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
sidebar_() - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
sidebar_() - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
 
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.
SinkWrapper - Class in org.apache.maven.doxia.sink.impl
By default a SinkWrapper just delegates each method to the wrapped sink's method.
SinkWrapper(Sink) - Constructor for class org.apache.maven.doxia.sink.impl.SinkWrapper
 
SinkWrapperFactory - Interface in org.apache.maven.doxia.sink.impl
A factory for a sink wrapping another sink.
SinkWrapperFactoryComparator - Class in org.apache.maven.doxia.sink.impl
Sorts the given SinkWrapperFactorys so that the one with the highest priority comes first (i.e.
SinkWrapperFactoryComparator() - Constructor for class org.apache.maven.doxia.sink.impl.SinkWrapperFactoryComparator
 
SLASH - Static variable in interface org.apache.maven.doxia.markup.Markup
slash character: '/'
SMALL - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
HTML5 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 (source code) 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.
SOURCE - Static variable in class org.apache.maven.doxia.sink.impl.SinkEventAttributeSet
An unmodifiable attribute set containing only a source attribute.
SPACE - Static variable in interface org.apache.maven.doxia.markup.Markup
space character: ' '
SPAN - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
HTML5 tag for span.
STAR - Static variable in interface org.apache.maven.doxia.markup.Markup
star character: '*'
STRONG - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
HTML5 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
HTML5 tag for style.
SUB - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
HTML5 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
HTML5 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.
SVG - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
HTML5 tag for svg.

T

TABLE - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
HTML5 tag for table.
table() - Method in class org.apache.maven.doxia.sink.impl.AbstractSink
 
table(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
table(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
 
table(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
table_() - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
table_() - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
 
table_() - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
tableAttributes - Variable in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
used to store attributes passed to table().
tableCaption() - Method in class org.apache.maven.doxia.sink.impl.AbstractSink
 
tableCaption(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
tableCaption(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
 
tableCaption(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
tableCaption_() - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
tableCaption_() - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
 
tableCaption_() - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
tableCell() - Method in class org.apache.maven.doxia.sink.impl.AbstractSink
 
tableCell(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
tableCell(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
 
tableCell(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
tableCell_() - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
tableCell_() - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
 
tableCell_() - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
tableHeaderCell() - Method in class org.apache.maven.doxia.sink.impl.AbstractSink
 
tableHeaderCell(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
tableHeaderCell(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
 
tableHeaderCell(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
tableHeaderCell_() - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
tableHeaderCell_() - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
 
tableHeaderCell_() - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
tableRow() - Method in class org.apache.maven.doxia.sink.impl.AbstractSink
 
tableRow(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
tableRow(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
 
tableRow(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
Rows are striped with two colors by adding the class a or b.
tableRow_() - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
tableRow_() - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
 
tableRow_() - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
tableRows() - Method in class org.apache.maven.doxia.sink.impl.AbstractSink
 
tableRows(int[], boolean) - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
tableRows(int[], boolean) - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
 
tableRows(int[], boolean) - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
The default style class is bodyTable.
tableRows_() - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
tableRows_() - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
 
tableRows_() - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
TAG_TYPE_END - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
An end HTML tag.
TAG_TYPE_SIMPLE - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
A simple HTML tag.
TAG_TYPE_START - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
A start HTML tag.
TBODY - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
HTML5 tag for tbody.
TD - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
HTML5 tag for td.
TEMPLATE - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
HTML5 tag for template.
text(String, SinkEventAttributes) - Method in class org.apache.maven.doxia.index.IndexingSink
 
text(String) - Method in class org.apache.maven.doxia.sink.impl.AbstractSink
 
text(String, SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
text(String, SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
 
text(String, SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
TEXTAREA - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
HTML5 tag for textarea.
TextMarkup - Interface in org.apache.maven.doxia.markup
List of constants used by Text markup syntax.
TFOOT - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
HTML5 tag for tfoot.
TH - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
HTML5 tag for th.
THEAD - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
HTML5 tag for thead.
TIME - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
HTML5 tag for time.
time(String) - Method in class org.apache.maven.doxia.sink.impl.AbstractSink
 
time(String, SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
time(String, SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
 
time(String, SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
time_() - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
time_() - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
 
time_() - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
title(SinkEventAttributes) - Method in class org.apache.maven.doxia.index.IndexingSink
 
TITLE - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
HTML5 tag for title.
title() - Method in class org.apache.maven.doxia.sink.impl.AbstractSink
 
title(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
title(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
 
title_() - Method in class org.apache.maven.doxia.index.IndexingSink
 
title_() - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
title_() - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
 
toChars(int) - Static method in class org.apache.maven.doxia.util.HtmlTools
Converts the given code point to an equivalent character array.
TocMacro - Class in org.apache.maven.doxia.macro.toc
Macro to display a Table Of Content in a given Sink.
TocMacro() - Constructor for class org.apache.maven.doxia.macro.toc.TocMacro
 
toString() - Method in class org.apache.maven.doxia.index.IndexEntry
Returns a string representation of the object.
toString(int) - Method in class org.apache.maven.doxia.index.IndexEntry
Returns a string representation of all objects to the given depth.
toString() - Method in class org.apache.maven.doxia.sink.impl.SinkEventAttributeSet
TR - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
HTML5 tag for tr.
TRACK - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
HTML5 tag for track.
TXT_TYPE - Static variable in interface org.apache.maven.doxia.parser.Parser
Text parser type

U

U - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
HTML5 tag for u.
UL - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
HTML5 tag for ul.
UNDERLINE - Static variable in class org.apache.maven.doxia.sink.impl.SinkEventAttributeSet
An unmodifiable attribute set containing only an underline attribute.
unescapeHTML(String) - Static method in class org.apache.maven.doxia.util.HtmlTools
Unescapes HTML entities in a string in non xml mode.
unescapeHTML(String, boolean) - Static method in class org.apache.maven.doxia.util.HtmlTools
Unescapes HTML entities in a string.
unget(String) - Method in class org.apache.maven.doxia.util.ByLineReaderSource
unget.
unget(String) - Method in interface org.apache.maven.doxia.util.ByLineSource
unget.
ungetLine() - Method in class org.apache.maven.doxia.util.ByLineReaderSource
ungetLine.
ungetLine() - Method in interface org.apache.maven.doxia.util.ByLineSource
ungetLine.
unifyEOLs(String) - Static method in class org.apache.maven.doxia.sink.impl.AbstractSink
Parses the given String and replaces all occurrences of '\n', '\r' and '\r\n' with the system EOL.
UniqueAnchorNamesValidator - Class in org.apache.maven.doxia.sink.impl
Validates that each anchor name only appears once per document.
UniqueAnchorNamesValidator(Sink) - Constructor for class org.apache.maven.doxia.sink.impl.UniqueAnchorNamesValidator
 
UniqueAnchorNamesValidatorFactory - Class in org.apache.maven.doxia.sink.impl
 
UniqueAnchorNamesValidatorFactory() - Constructor for class org.apache.maven.doxia.sink.impl.UniqueAnchorNamesValidatorFactory
 
unknown(String, Object[], SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
unknown(String, Object[], SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
 
unknown(String, Object[], SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
Add an unknown event.
UNKNOWN_TYPE - Static variable in interface org.apache.maven.doxia.parser.Parser
Unknown parser type
unmodifiable() - Method in class org.apache.maven.doxia.sink.impl.SinkEventAttributeSet
Replace this AttributeSet by an unmodifiable view of itself.

V

validAnchor(String) - Method in class org.apache.maven.doxia.parser.Xhtml5BaseParser
Checks if the given id is a valid Doxia id and if not, returns a transformed one.
validate(String) - Method in class org.apache.maven.doxia.util.XmlValidator
Validate an XML content with SAX.
valueOf(String) - Static method in enum org.apache.maven.doxia.index.IndexEntry.Type
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.apache.maven.doxia.sink.impl.Xhtml5BaseSink.VerbatimMode
Returns the enum constant of this type with the specified name.
values() - Static method in enum org.apache.maven.doxia.index.IndexEntry.Type
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.apache.maven.doxia.sink.impl.Xhtml5BaseSink.VerbatimMode
Returns an array containing the constants of this enum type, in the order they are declared.
VAR - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
HTML5 tag for var.
VARIABLE - Static variable in class org.apache.maven.doxia.sink.impl.SinkEventAttributeSet.Semantics
An unmodifiable attribute set containing only a variable attribute.
verbatim() - Method in class org.apache.maven.doxia.parser.Xhtml5BaseParser
Start verbatim mode.
verbatim() - Method in class org.apache.maven.doxia.sink.impl.AbstractSink
 
verbatim(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
verbatim(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
 
verbatim(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
Depending on whether the decoration attribute is "source" or not, this leads to either emitting {@code
verbatim_() - Method in class org.apache.maven.doxia.parser.Xhtml5BaseParser
Stop verbatim mode.
verbatim_() - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
verbatim_() - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
 
verbatim_() - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
verbatimContent(String) - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
Write HTML escaped text to output.
VIDEO - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
HTML5 tag for video.

W

warning(SAXParseException) - Method in class org.apache.maven.doxia.util.XmlValidator.MessagesErrorHandler
WBR - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
HTML5 tag for wbr.
write(String) - Method in class org.apache.maven.doxia.sink.impl.AbstractXmlSink
Write a text to the sink.
write(String) - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
Write a text to the sink.
write(String) - Method in class org.apache.maven.doxia.util.LineBreaker
Writes the given text to the writer.
write(String, boolean) - Method in class org.apache.maven.doxia.util.LineBreaker
Writes the given text to the writer.
writeEndTag(HTML.Tag) - Method in class org.apache.maven.doxia.sink.impl.AbstractXmlSink
Ends a Tag without writing an EOL.
writeEndTag(HTML.Tag) - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
Ends a Tag without writing an EOL.
writeEOL() - Method in class org.apache.maven.doxia.sink.impl.AbstractXmlSink
Writes a system EOL.
writeSimpleTag(HTML.Tag) - Method in class org.apache.maven.doxia.sink.impl.AbstractXmlSink
Starts a simple Tag.
writeSimpleTag(HTML.Tag, MutableAttributeSet) - Method in class org.apache.maven.doxia.sink.impl.AbstractXmlSink
Starts a simple Tag with attributes.
writeStartTag(HTML.Tag) - Method in class org.apache.maven.doxia.sink.impl.AbstractXmlSink
Starts a Tag.
writeStartTag(HTML.Tag, MutableAttributeSet) - Method in class org.apache.maven.doxia.sink.impl.AbstractXmlSink
Starts a Tag with attributes.
writeStartTag(HTML.Tag, MutableAttributeSet, boolean) - Method in class org.apache.maven.doxia.sink.impl.AbstractXmlSink
Starts a Tag with attributes.
writeStartTag(HTML.Tag, MutableAttributeSet, boolean) - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
Starts a Tag with attributes.

X

Xhtml1BaseParser - Class in org.apache.maven.doxia.parser
Acts as bridge between legacy parsers relying on XHTML 1.0 Transitional (based on HTML4) and the Xhtml5BaseParser only supporting (X)HTML5 elements/attributes.
Xhtml1BaseParser() - Constructor for class org.apache.maven.doxia.parser.Xhtml1BaseParser
 
Xhtml5BaseParser - Class in org.apache.maven.doxia.parser
Common base parser for xhtml5 events.
Xhtml5BaseParser() - Constructor for class org.apache.maven.doxia.parser.Xhtml5BaseParser
 
Xhtml5BaseSink - Class in org.apache.maven.doxia.sink.impl
Abstract base xhtml5 sink implementation.
Xhtml5BaseSink(Writer) - Constructor for class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
Constructor, initialize the PrintWriter.
Xhtml5BaseSink.VerbatimMode - Enum in org.apache.maven.doxia.sink.impl
 
XML_NAMESPACE - Static variable in interface org.apache.maven.doxia.markup.XmlMarkup
XML namespace: "http://www.w3.org/2001/XMLSchema-instance"
XML_TYPE - Static variable in interface org.apache.maven.doxia.parser.Parser
XML parser type
XmlMarkup - Interface in org.apache.maven.doxia.markup
List of constants used by Xml markup syntax.
XmlValidator - Class in org.apache.maven.doxia.util
A class to validate xml documents.
XmlValidator() - Constructor for class org.apache.maven.doxia.util.XmlValidator
 
XmlValidator.MessagesErrorHandler - Class in org.apache.maven.doxia.util
Convenience class to beautify SAXParseException messages.
A B C D E F G H I J K L M N O P Q R S T U V W X 
Skip navigation links

Copyright © 2005–2024 The Apache Software Foundation. All rights reserved.