Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
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.
- ABBRV - Static variable in interface org.apache.maven.doxia.sink.SinkEventAttributes
-
Specifies an abbreviated version of the content in an element.
- 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
- AbstractXhtml5Sink - Class in org.apache.maven.doxia.module.xhtml5
-
Abstract AbstractXhtml5Sink class.
- AbstractXhtml5Sink() - Constructor for class org.apache.maven.doxia.module.xhtml5.AbstractXhtml5Sink
- 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
. - AbstractXmlParser.XmlPullParserLocator - Class in org.apache.maven.doxia.parser
- 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
- addDefaultEntities - Variable in class org.apache.maven.doxia.parser.AbstractXmlParser
-
If set the parser will be loaded with all single characters from the XHTML specification.
- addDTDEntities(XmlPullParser, String) - Method in class org.apache.maven.doxia.parser.AbstractXmlParser
-
Handle entities defined in external doctypes as the following:
- addEntity(XmlPullParser, String, String) - Method in class org.apache.maven.doxia.parser.AbstractXmlParser
- addFaq(Faq) - Method in class org.apache.maven.doxia.module.fml.model.Part
-
Method addFaq.
- addLocalEntities(XmlPullParser, String) - Method in class org.apache.maven.doxia.parser.AbstractXmlParser
-
Handle entities defined in a local doctype as the following:
- addPart(Part) - Method in class org.apache.maven.doxia.module.fml.model.Faqs
-
Method addPart.
- address() - Method in class org.apache.maven.doxia.sink.impl.AbstractSink
- address() - Method in interface org.apache.maven.doxia.sink.Sink
-
Starts an address element.
- address(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
-
Starts an address element.
- address(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
- address(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
-
Starts an address element.
- address(SinkEventAttributes) - Method in interface org.apache.maven.doxia.sink.Sink
-
Starts an address element.
- 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.SinkAdapter
-
Ends an address element.
- address_() - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
- address_() - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
-
Ends an address element.
- address_() - Method in interface org.apache.maven.doxia.sink.Sink
-
Ends an address element.
- 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 ofparse(...)
- ALIGN - Static variable in interface org.apache.maven.doxia.sink.SinkEventAttributes
-
Specifies the alignment of the event element within its parent element.
- ALL_TAGS - Static variable in class org.apache.maven.doxia.util.HtmlTools
- ALT - Static variable in interface org.apache.maven.doxia.sink.SinkEventAttributes
-
Defines a short description of the event element.
- ALTERNATE_FILE_EXTENSION - Static variable in class org.apache.maven.doxia.module.markdown.MarkdownParserModule
-
Alternate extension for Markdown files.
- anchor(String) - Method in class org.apache.maven.doxia.sink.impl.AbstractSink
- anchor(String) - Method in interface org.apache.maven.doxia.sink.Sink
-
Starts an element which defines an anchor.
- anchor(String, SinkEventAttributes) - Method in class org.apache.maven.doxia.index.IndexingSink
- anchor(String, SinkEventAttributes) - Method in class org.apache.maven.doxia.module.apt.AptSink
- anchor(String, SinkEventAttributes) - Method in class org.apache.maven.doxia.module.markdown.MarkdownSink
-
Starts an element which defines an anchor.
- anchor(String, SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
-
Starts an element which defines an anchor.
- 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
-
Starts an element which defines an anchor.
- anchor(String, SinkEventAttributes) - Method in interface org.apache.maven.doxia.sink.Sink
-
Starts an element which defines an anchor.
- anchor_() - Method in class org.apache.maven.doxia.module.apt.AptSink
-
Ends an anchor element.
- anchor_() - Method in class org.apache.maven.doxia.module.markdown.MarkdownSink
- anchor_() - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
-
Ends an anchor element.
- anchor_() - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
- anchor_() - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
-
Ends an anchor element.
- anchor_() - Method in interface org.apache.maven.doxia.sink.Sink
-
Ends an anchor element.
- ANCHOR_END_MARKUP - Static variable in interface org.apache.maven.doxia.module.apt.AptMarkup
-
Syntax for the anchor end: "}"
- ANCHOR_END_MARKUP - Static variable in interface org.apache.maven.doxia.module.markdown.MarkdownMarkup
-
Syntax for the anchor end: "\"></a>"
- ANCHOR_START_MARKUP - Static variable in interface org.apache.maven.doxia.module.apt.AptMarkup
-
Syntax for the anchor start: "{"
- ANCHOR_START_MARKUP - Static variable in interface org.apache.maven.doxia.module.markdown.MarkdownMarkup
-
Syntax for the anchor start: "<a id=\""
- ANNOTATION - Static variable in class org.apache.maven.doxia.sink.impl.SinkEventAttributeSet.Semantics
-
An unmodifiable attribute set containing only an annotation attribute.
- answer - Variable in class org.apache.maven.doxia.module.fml.model.Faq
-
The answer.
- ANSWER_TAG - Static variable in interface org.apache.maven.doxia.module.fml.FmlMarkup
-
Fml tag for
answer
- apply(LinkResolverBasicContext) - Method in class org.apache.maven.doxia.module.markdown.FlexmarkDoxiaLinkResolver.Factory
- AptMarkup - Interface in org.apache.maven.doxia.module.apt
-
This interface defines all markups and syntaxes used by the APT format.
- AptParseException - Exception Class in org.apache.maven.doxia.module.apt
-
Wraps an exception when parsing apt source documents.
- AptParseException(Exception) - Constructor for exception class org.apache.maven.doxia.module.apt.AptParseException
-
Construct a new AptParseException with the cause.
- AptParseException(String) - Constructor for exception class org.apache.maven.doxia.module.apt.AptParseException
-
Construct a new AptParseException with the specified detail message.
- AptParseException(String, Exception) - Constructor for exception class org.apache.maven.doxia.module.apt.AptParseException
-
Construct a new AptParseException with the specified detail message and cause.
- AptParseException(String, Exception, int, int) - Constructor for exception class org.apache.maven.doxia.module.apt.AptParseException
-
Construct a new AptParseException with the specified detail message and cause.
- AptParseException(String, Exception, String, int, int) - Constructor for exception class org.apache.maven.doxia.module.apt.AptParseException
-
Construct a new AptParseException with the specified cause, detail message, filename, line number and column number.
- AptParser - Class in org.apache.maven.doxia.module.apt
-
The APT parser.
- AptParser() - Constructor for class org.apache.maven.doxia.module.apt.AptParser
- AptParser.AptSourceLocator - Class in org.apache.maven.doxia.module.apt
- AptParser.Block - Class in org.apache.maven.doxia.module.apt
-
A block of an apt source document.
- AptParser.Comment - Class in org.apache.maven.doxia.module.apt
-
A Comment Block.
- AptParser.DefinitionListItem - Class in org.apache.maven.doxia.module.apt
-
A DefinitionListItem Block.
- AptParser.Figure - Class in org.apache.maven.doxia.module.apt
-
A Figure Block.
- AptParser.HorizontalRule - Class in org.apache.maven.doxia.module.apt
-
A HorizontalRule Block.
- AptParser.ListBreak - Class in org.apache.maven.doxia.module.apt
-
A ListBreak Block.
- AptParser.ListItem - Class in org.apache.maven.doxia.module.apt
-
A ListItem Block.
- AptParser.MacroBlock - Class in org.apache.maven.doxia.module.apt
-
A MacroBlock Block.
- AptParser.NumberedListItem - Class in org.apache.maven.doxia.module.apt
-
A NumberedListItem Block.
- AptParser.PageBreak - Class in org.apache.maven.doxia.module.apt
-
A PageBreak Block.
- AptParser.Paragraph - Class in org.apache.maven.doxia.module.apt
-
A Paragraph Block.
- AptParser.Section - Class in org.apache.maven.doxia.module.apt
-
A Section Block.
- AptParser.Section1 - Class in org.apache.maven.doxia.module.apt
-
A Section1 Block.
- AptParser.Section2 - Class in org.apache.maven.doxia.module.apt
-
A Section2 Block.
- AptParser.Section3 - Class in org.apache.maven.doxia.module.apt
-
A Section3 Block.
- AptParser.Section4 - Class in org.apache.maven.doxia.module.apt
-
A Section4 Block.
- AptParser.Section5 - Class in org.apache.maven.doxia.module.apt
-
A Section5 Block.
- AptParser.Table - Class in org.apache.maven.doxia.module.apt
-
A Table Block.
- AptParser.Title - Class in org.apache.maven.doxia.module.apt
-
A Title Block.
- AptParser.Verbatim - Class in org.apache.maven.doxia.module.apt
-
A Verbatim Block.
- AptParserModule - Class in org.apache.maven.doxia.module.apt
-
AptParserModule class.
- AptParserModule() - Constructor for class org.apache.maven.doxia.module.apt.AptParserModule
-
Default constructor.
- AptReaderSource - Class in org.apache.maven.doxia.module.apt
-
Reader for apt source documents.
- AptReaderSource(Reader) - Constructor for class org.apache.maven.doxia.module.apt.AptReaderSource
-
Constructor: initialize reader.
- AptReaderSource(Reader, String) - Constructor for class org.apache.maven.doxia.module.apt.AptReaderSource
-
Constructor: initialize reader.
- AptSink - Class in org.apache.maven.doxia.module.apt
-
APT generator implementation.
- AptSink(Writer) - Constructor for class org.apache.maven.doxia.module.apt.AptSink
-
Constructor, initialize the Writer and the variables.
- AptSinkFactory - Class in org.apache.maven.doxia.module.apt
-
APT implementation of the Sink factory.
- AptSinkFactory() - Constructor for class org.apache.maven.doxia.module.apt.AptSinkFactory
- aptSource - Variable in class org.apache.maven.doxia.module.apt.AptParser.AptSourceLocator
- AptSource - Interface in org.apache.maven.doxia.module.apt
-
An interface to read apt source documents.
- AptSourceLocator(AptSource, String) - Constructor for class org.apache.maven.doxia.module.apt.AptParser.AptSourceLocator
- AptUtils - Class in org.apache.maven.doxia.module.apt
-
A collection of utility methods for dealing with APT documents.
- AptUtils() - Constructor for class org.apache.maven.doxia.module.apt.AptUtils
- AREA - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
-
HTML5 tag for
area
. - args - Variable in class org.apache.maven.doxia.sink.impl.BufferingSinkProxyFactory.MethodWithArguments
- article() - Method in class org.apache.maven.doxia.sink.impl.AbstractSink
- article() - Method in interface org.apache.maven.doxia.sink.Sink
-
Starts an article within a document.
- article(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
-
Starts an article within a document.
- article(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
- article(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
-
Starts an article within a document.
- article(SinkEventAttributes) - Method in interface org.apache.maven.doxia.sink.Sink
-
Starts an article within a document.
- 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.SinkAdapter
-
Ends the article element.
- article_() - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
- article_() - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
-
Ends the article element.
- article_() - Method in interface org.apache.maven.doxia.sink.Sink
-
Ends the article element.
- ASCII - Static variable in class org.apache.maven.doxia.util.HtmlTools
- asCssString(AttributeSet) - Static method in class org.apache.maven.doxia.sink.impl.SinkUtils
- ASIDE - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
-
HTML5 tag for
aside
. - attribs - Variable in class org.apache.maven.doxia.sink.impl.SinkEventAttributeSet
- ATTRIBUTE_MAPPING_TABLE - Static variable in class org.apache.maven.doxia.parser.Xhtml1BaseParser
-
All obsolete attributes in a map with key = affected element name, value = collection if
Xhtml1BaseParser.AttributeMapping
s - AttributeMapping(String, String, UnaryOperator<String>, Xhtml1BaseParser.AttributeMapping.MergeSemantics) - Constructor for class org.apache.maven.doxia.parser.Xhtml1BaseParser.AttributeMapping
- AttributeMapping(String, String, Xhtml1BaseParser.AttributeMapping.MergeSemantics) - Constructor for class org.apache.maven.doxia.parser.Xhtml1BaseParser.AttributeMapping
- 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() - Method in interface org.apache.maven.doxia.sink.Sink
-
Starts an author element.
- author(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
-
Starts an author element.
- author(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
- author(SinkEventAttributes) - Method in interface org.apache.maven.doxia.sink.Sink
-
Starts an author element.
- author_() - Method in class org.apache.maven.doxia.module.apt.AptSink
-
Ends an author element.
- author_() - Method in class org.apache.maven.doxia.module.markdown.MarkdownSink
- author_() - Method in class org.apache.maven.doxia.module.xdoc.XdocSink
-
Ends an author element.
- author_() - Method in class org.apache.maven.doxia.module.xhtml5.Xhtml5Sink
-
Ends an author element.
- author_() - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
-
Ends an author element.
- author_() - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
- author_() - Method in interface org.apache.maven.doxia.sink.Sink
-
Ends an author element.
- AUTHOR_TAG - Static variable in interface org.apache.maven.doxia.module.xdoc.XdocMarkup
-
Xdoc tag for
author
- authors - Variable in class org.apache.maven.doxia.module.apt.AptSink
-
authors.
- authors - Variable in class org.apache.maven.doxia.module.markdown.MarkdownSink
-
author.
- automaticallyRegisteredSinkWrapperFactories - Variable in class org.apache.maven.doxia.parser.AbstractParser
- AXIS - Static variable in interface org.apache.maven.doxia.sink.SinkEventAttributes
-
Defines a name for a cell.
B
- B - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
-
HTML5 tag for
b
. - BACKSLASH - Static variable in interface org.apache.maven.doxia.module.apt.AptMarkup
-
APT backslash markup char: '\\'
- BACKSLASH - Static variable in interface org.apache.maven.doxia.module.markdown.MarkdownMarkup
-
backslash markup char: '\\'
- 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
. - basedir - Variable in class org.apache.maven.doxia.macro.MacroRequest
-
The current base directory.
- baseEndTag(String, SinkEventAttributeSet, Sink) - Method in class org.apache.maven.doxia.parser.Xhtml5BaseParser
- baseEndTag(XmlPullParser, Sink) - Method in class org.apache.maven.doxia.module.markdown.MarkdownParser.MarkdownHtmlParser
- 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.
- baseStartTag(String, SinkEventAttributeSet, Sink) - Method in class org.apache.maven.doxia.parser.Xhtml5BaseParser
- baseStartTag(XmlPullParser, Sink) - Method in class org.apache.maven.doxia.module.markdown.MarkdownParser.MarkdownHtmlParser
- 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.
- 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
. - BGCOLOR - Static variable in interface org.apache.maven.doxia.sink.SinkEventAttributes
-
Specifies the background color of an event element.
- 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.
- BLANK_LINE - Static variable in interface org.apache.maven.doxia.module.markdown.MarkdownMarkup
- block - Variable in class org.apache.maven.doxia.module.apt.AptParser
-
a block of AptSource.
- Block(int, int) - Constructor for class org.apache.maven.doxia.module.apt.AptParser.Block
-
Constructor.
- Block(int, int, String) - Constructor for class org.apache.maven.doxia.module.apt.AptParser.Block
-
Constructor.
- blockFileName - Variable in class org.apache.maven.doxia.module.apt.AptParser
-
blockFileName.
- blockLineNumber - Variable in class org.apache.maven.doxia.module.apt.AptParser
-
blockLineNumber.
- blockquote() - Method in class org.apache.maven.doxia.sink.impl.AbstractSink
- blockquote() - Method in interface org.apache.maven.doxia.sink.Sink
-
Starts a blockquote element.
- blockquote(SinkEventAttributes) - Method in class org.apache.maven.doxia.module.markdown.MarkdownSink
- blockquote(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
-
Starts a blockquote element.
- blockquote(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
- blockquote(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
-
Starts a blockquote element.
- blockquote(SinkEventAttributes) - Method in interface org.apache.maven.doxia.sink.Sink
-
Starts a blockquote element.
- BLOCKQUOTE - Enum constant in enum org.apache.maven.doxia.module.markdown.MarkdownSink.ElementContext
- BLOCKQUOTE - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
-
HTML5 tag for
blockquote
. - blockquote_() - Method in class org.apache.maven.doxia.module.markdown.MarkdownSink
- blockquote_() - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
-
Ends an blockquote element.
- blockquote_() - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
- blockquote_() - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
-
Ends an blockquote element.
- blockquote_() - Method in interface org.apache.maven.doxia.sink.Sink
-
Ends an blockquote element.
- BLOCKQUOTE_START_MARKUP - Static variable in interface org.apache.maven.doxia.module.markdown.MarkdownMarkup
-
Syntax for the blockquote start: "> "
- body() - Method in class org.apache.maven.doxia.sink.impl.AbstractSink
- body() - Method in interface org.apache.maven.doxia.sink.Sink
-
Starts the body of a document.
- body(SinkEventAttributes) - Method in class org.apache.maven.doxia.module.markdown.MarkdownSink
- body(SinkEventAttributes) - Method in class org.apache.maven.doxia.module.xdoc.XdocSink
-
Starts the body of a document.
- body(SinkEventAttributes) - Method in class org.apache.maven.doxia.module.xhtml5.Xhtml5Sink
-
Starts the body of a document.
- body(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
-
Starts the body of a document.
- body(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
- body(SinkEventAttributes) - Method in interface org.apache.maven.doxia.sink.Sink
-
Starts the body of a document.
- BODY - Enum constant in enum org.apache.maven.doxia.module.markdown.MarkdownSink.ElementContext
- BODY - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
-
HTML5 tag for
body
. - body_() - Method in class org.apache.maven.doxia.module.markdown.MarkdownSink
- body_() - Method in class org.apache.maven.doxia.module.xdoc.XdocSink
-
Ends the body element.
- body_() - Method in class org.apache.maven.doxia.module.xhtml5.Xhtml5Sink
-
Ends the body element.
- body_() - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
-
Ends the body element.
- body_() - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
- body_() - Method in interface org.apache.maven.doxia.sink.Sink
-
Ends the body element.
- BODYTABLEBORDER_CLASS_PATTERN - Static variable in class org.apache.maven.doxia.parser.Xhtml5BaseParser
-
Used to identify if a class string contains `bodyTableBorder`
- bold() - Method in class org.apache.maven.doxia.module.apt.AptSink
-
Starts a bold element.
- bold() - Method in class org.apache.maven.doxia.module.markdown.MarkdownSink
- bold() - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
-
Starts a bold element.
- bold() - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
- bold() - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
-
Starts a bold element.
- bold() - Method in interface org.apache.maven.doxia.sink.Sink
-
Starts a bold element.
- 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.module.apt.AptSink
-
Ends a bold element.
- bold_() - Method in class org.apache.maven.doxia.module.markdown.MarkdownSink
- bold_() - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
-
Ends a bold element.
- bold_() - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
- bold_() - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
-
Ends a bold element.
- bold_() - Method in interface org.apache.maven.doxia.sink.Sink
-
Ends a bold element.
- BOLD_END_MARKUP - Static variable in interface org.apache.maven.doxia.module.apt.AptMarkup
-
Syntax for the bold style end: ">>"
- BOLD_END_MARKUP - Static variable in interface org.apache.maven.doxia.module.markdown.MarkdownMarkup
-
Syntax for the bold style end: "**"
- BOLD_START_MARKUP - Static variable in interface org.apache.maven.doxia.module.apt.AptMarkup
-
Syntax for the bold style start: "<<"
- BOLD_START_MARKUP - Static variable in interface org.apache.maven.doxia.module.markdown.MarkdownMarkup
-
Syntax for the bold style start: "**"
- BORDER - Static variable in interface org.apache.maven.doxia.sink.SinkEventAttributes
-
Defines a border around an event element.
- BR - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
-
HTML5 tag for
br
. - buffer - Variable in class org.apache.maven.doxia.module.apt.AptSink
-
A buffer that holds the current text when headerFlag or bufferFlag set to
true
. - buffer - Variable in class org.apache.maven.doxia.module.fml.FmlParser
-
Used to collect text events.
- buffer - Variable in class org.apache.maven.doxia.module.markdown.MarkdownSink
-
A buffer that holds the current text when headerFlag or bufferFlag set to
true
. - bufferedInvocations - Variable in class org.apache.maven.doxia.sink.impl.BufferingSinkProxyFactory.BufferingSinkProxy
- bufferFlag - Variable in class org.apache.maven.doxia.module.apt.AptSink
-
bufferFlag.
- BufferingSinkProxy(Sink) - Constructor for class org.apache.maven.doxia.sink.impl.BufferingSinkProxyFactory.BufferingSinkProxy
- 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
- BufferingSinkProxyFactory.BufferingSinkProxy - Class in org.apache.maven.doxia.sink.impl
- BufferingSinkProxyFactory.MethodWithArguments - Class in org.apache.maven.doxia.sink.impl
- bufferingWriter - Variable in class org.apache.maven.doxia.module.markdown.MarkdownSink
-
A temporary writer used to buffer the last two lines
- buildRowLine() - Method in class org.apache.maven.doxia.module.apt.AptSink
-
Construct a table row.
- 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
- cache - Static variable in class org.apache.maven.doxia.macro.snippet.SnippetMacro
-
Holds the cache.
- 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
. - capturedEventNames - Variable in class org.apache.maven.doxia.sink.impl.EventCapturingSinkProxy
- capturedSinkEventNames - Variable in class org.apache.maven.doxia.parser.Xhtml5BaseParser
- 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.
- cellCount - Variable in class org.apache.maven.doxia.module.apt.AptSink
-
number of cells in a table.
- cellCount - Variable in class org.apache.maven.doxia.module.markdown.MarkdownSink
-
number of cells in a table.
- cellCountStack - Variable in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
-
Stack of current table cell.
- cellJustif - Variable in class org.apache.maven.doxia.module.apt.AptSink
-
justification of table cells.
- cellJustif - Variable in class org.apache.maven.doxia.module.markdown.MarkdownSink
-
justification of table cells per column.
- cellJustifStack - Variable in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
-
Stack of alignment int[] of table cells.
- CELLPADDING - Static variable in interface org.apache.maven.doxia.sink.SinkEventAttributes
-
Specifies the space between cell walls and contents.
- CELLSPACING - Static variable in interface org.apache.maven.doxia.sink.SinkEventAttributes
-
Specifies the space between cells.
- CENTER - Static variable in class org.apache.maven.doxia.sink.impl.SinkEventAttributeSet
-
An unmodifiable attribute set containing only a center attribute.
- charAt(String, int, int) - Static method in class org.apache.maven.doxia.module.apt.AptParser
-
Returns the character at position i of the given string.
- CHARSET - Static variable in interface org.apache.maven.doxia.sink.SinkEventAttributes
-
Specifies the character encoding of text associated with an event element.
- childEntries - Variable in class org.apache.maven.doxia.index.IndexEntry
-
The child entries.
- 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
. - CLASS - Static variable in interface org.apache.maven.doxia.sink.SinkEventAttributes
-
The class of the event element.
- 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.module.apt.AptReaderSource
-
Closes the reader associated with this AptReaderSource.
- close() - Method in class org.apache.maven.doxia.module.apt.AptSink
-
Close the writer or the stream, if needed.
- close() - Method in class org.apache.maven.doxia.module.markdown.LastTwoLinesBufferingWriter
- close() - Method in class org.apache.maven.doxia.module.markdown.MarkdownSink
- close() - Method in class org.apache.maven.doxia.module.xdoc.XdocSink
-
close.
- 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 the writer or the stream, if needed.
- close() - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
- close() - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
-
Close the writer or the stream, if needed.
- close() - Method in interface org.apache.maven.doxia.sink.Sink
-
Close the writer or the stream, if needed.
- 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.
- closeOpenHeadingSections(int, Sink) - Method in class org.apache.maven.doxia.parser.Xhtml5BaseParser
-
Close open heading sections.
- closeOpenSections(int, Sink) - Method in class org.apache.maven.doxia.module.xdoc.XdocParser
-
Close open h2, h3, h4, h5 sections.
- 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.
- CODE_BLOCK - Enum constant in enum org.apache.maven.doxia.module.markdown.MarkdownSink.ElementContext
- CODE_SPAN - Enum constant in enum org.apache.maven.doxia.module.markdown.MarkdownSink.ElementContext
- 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
. - collapsibleWhitespace - Variable in class org.apache.maven.doxia.parser.AbstractXmlParser
- COLON - Static variable in interface org.apache.maven.doxia.markup.Markup
-
colon character: ':'
- COLSPAN - Static variable in interface org.apache.maven.doxia.sink.SinkEventAttributes
-
Indicates the number of columns a cell should span.
- columnNumber - Variable in exception class org.apache.maven.doxia.parser.ParseException
-
Column number where the parse exception occurred.
- COMMAND - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
-
HTML5 tag for
command
. - comment(String) - Method in class org.apache.maven.doxia.module.apt.AptSink
-
Add a comment.
- comment(String) - Method in class org.apache.maven.doxia.module.markdown.MarkdownSink
- comment(String) - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
-
Add a comment.
- comment(String) - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
- comment(String) - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
-
Add a comment.
- comment(String) - Method in interface org.apache.maven.doxia.sink.Sink
-
Add a comment.
- Comment(String) - Constructor for class org.apache.maven.doxia.module.apt.AptParser.Comment
-
Constructor.
- COMMENT - Static variable in interface org.apache.maven.doxia.module.apt.AptMarkup
-
APT comment markup char: '~'
- COMMENT_BLOCK - Static variable in class org.apache.maven.doxia.module.apt.AptParser
-
Comment event id.
- COMMENT_END - Static variable in interface org.apache.maven.doxia.module.markdown.MarkdownMarkup
- COMMENT_START - Static variable in interface org.apache.maven.doxia.module.markdown.MarkdownMarkup
- compare(SinkWrapperFactory, SinkWrapperFactory) - Method in class org.apache.maven.doxia.sink.impl.SinkWrapperFactoryComparator
- consecutiveSections(int, Sink) - Method in class org.apache.maven.doxia.module.xdoc.XdocParser
- consecutiveSections(int, Sink, SinkEventAttributeSet) - Method in class org.apache.maven.doxia.parser.Xhtml5BaseParser
-
Deprecated.
- CONTAINER_BLOCK - Enum constant in enum org.apache.maven.doxia.module.markdown.MarkdownSink.ElementContext.Type
-
Is supposed to start on a new line, and must have a prefix (for nested blocks)
- 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() - Method in interface org.apache.maven.doxia.sink.Sink
-
Start the main content section between the header and the footer within the sections and/or body.
- content(String) - Method in class org.apache.maven.doxia.module.apt.AptSink
-
Write Apt escaped text to output.
- content(String) - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
-
Write HTML escaped text to output.
- content(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
-
Start the main content section between the header and the footer within the sections and/or body.
- content(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
- content(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
-
Start the main content section between the header and the footer within the sections and/or body.
- content(SinkEventAttributes) - Method in interface org.apache.maven.doxia.sink.Sink
-
Start the main content section between the header and the footer within the sections and/or body.
- content_() - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
-
Ends a main content section.
- content_() - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
- content_() - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
-
Ends a main content section.
- content_() - Method in interface org.apache.maven.doxia.sink.Sink
-
Ends a main content section.
- contentStack - Variable in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
-
Keep track of the main and div tags for content events.
- COORDS - Static variable in interface org.apache.maven.doxia.sink.SinkEventAttributes
-
May be used in conjunction with
SinkEventAttributes.SHAPE
. - copyAttributes() - Method in class org.apache.maven.doxia.sink.impl.SinkEventAttributeSet
- coreOutputStream - Variable in class org.apache.maven.doxia.sink.impl.RandomAccessSink
-
Deprecated.
- coreSink - Variable in class org.apache.maven.doxia.sink.impl.RandomAccessSink
-
Deprecated.
- 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(File, String) - Method in class org.apache.maven.doxia.sink.impl.AbstractTextSinkFactory
-
Create a
Sink
into a file. - createSink(File, String) - Method in interface org.apache.maven.doxia.sink.SinkFactory
-
Create a
Sink
into a file. - createSink(File, String, String) - Method in class org.apache.maven.doxia.sink.impl.AbstractTextSinkFactory
-
Create a
Sink
into a file using a specified encoding. - createSink(File, String, String) - Method in interface org.apache.maven.doxia.sink.SinkFactory
-
Create a
Sink
into a file using a specified encoding. - createSink(OutputStream) - Method in class org.apache.maven.doxia.sink.impl.AbstractTextSinkFactory
-
Create a
Sink
into an OutputStream. - createSink(OutputStream) - Method in interface org.apache.maven.doxia.sink.SinkFactory
-
Create a
Sink
into an OutputStream. - createSink(OutputStream, String) - Method in class org.apache.maven.doxia.sink.impl.AbstractTextSinkFactory
-
Create a
Sink
into an OutputStream using a specified encoding. - createSink(OutputStream, String) - Method in interface org.apache.maven.doxia.sink.SinkFactory
-
Create a
Sink
into an OutputStream using a specified encoding. - createSink(Writer, String) - Method in class org.apache.maven.doxia.module.apt.AptSinkFactory
-
Create a text Sink for a given encoding.
- createSink(Writer, String) - Method in class org.apache.maven.doxia.module.markdown.MarkdownSinkFactory
-
Create a text Sink for a given encoding.
- createSink(Writer, String) - Method in class org.apache.maven.doxia.module.xdoc.XdocSinkFactory
-
Create a text Sink for a given encoding.
- createSink(Writer, String) - Method in class org.apache.maven.doxia.module.xhtml5.Xhtml5SinkFactory
-
Create a text Sink for a given encoding.
- createSink(Writer, String) - Method in class org.apache.maven.doxia.sink.impl.AbstractTextSinkFactory
-
Create a text Sink for a given encoding.
- createSink(Writer, String, String) - Method in class org.apache.maven.doxia.module.xdoc.XdocSinkFactory
-
Create a text Sink for a given encoding and for a given language identifier.
- createSink(Writer, String, String) - Method in class org.apache.maven.doxia.module.xhtml5.Xhtml5SinkFactory
-
Create a text Sink for a given encoding and for a given language identifier.
- 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
- currentFaq - Variable in class org.apache.maven.doxia.module.fml.FmlParser
-
Collect a single faq.
- currentLine - Variable in class org.apache.maven.doxia.module.markdown.LastTwoLinesBufferingWriter
- currentPart - Variable in class org.apache.maven.doxia.module.fml.FmlParser
-
Collect a part.
- currentSink - Variable in class org.apache.maven.doxia.sink.impl.RandomAccessSink
-
Deprecated.
D
- data(String) - Method in class org.apache.maven.doxia.sink.impl.AbstractSink
- data(String) - Method in interface org.apache.maven.doxia.sink.Sink
-
Starts a data element which groups together other elements representing microformats.
- data(String, SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
-
Starts a data element which groups together other elements representing microformats.
- 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
-
Starts a data element which groups together other elements representing microformats.
- data(String, SinkEventAttributes) - Method in interface org.apache.maven.doxia.sink.Sink
-
Starts a data element which groups together other elements representing microformats.
- DATA - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
-
HTML5 tag for
data
. - data_() - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
-
Ends an data element.
- data_() - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
- data_() - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
-
Ends an data element.
- data_() - Method in interface org.apache.maven.doxia.sink.Sink
-
Ends an data element.
- DATALIST - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
-
HTML5 tag for
datalist
. - date - Variable in class org.apache.maven.doxia.module.apt.AptSink
-
date.
- date - Variable in class org.apache.maven.doxia.module.markdown.MarkdownSink
-
date.
- date() - Method in class org.apache.maven.doxia.sink.impl.AbstractSink
- date() - Method in interface org.apache.maven.doxia.sink.Sink
-
Starts the date element.
- date(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
-
Starts the date element.
- date(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
- date(SinkEventAttributes) - Method in interface org.apache.maven.doxia.sink.Sink
-
Starts the date element.
- date_() - Method in class org.apache.maven.doxia.module.apt.AptSink
-
Ends the date element.
- date_() - Method in class org.apache.maven.doxia.module.markdown.MarkdownSink
- date_() - Method in class org.apache.maven.doxia.module.xdoc.XdocSink
-
Ends the date element.
- date_() - Method in class org.apache.maven.doxia.module.xhtml5.Xhtml5Sink
-
Ends the date element.
- date_() - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
-
Ends the date element.
- date_() - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
- date_() - Method in interface org.apache.maven.doxia.sink.Sink
-
Ends the date element.
- DATE_PARSE_POSITION - Static variable in class org.apache.maven.doxia.util.DoxiaUtils
- DATE_PARSER - Static variable in class org.apache.maven.doxia.util.DoxiaUtils
- DATE_PATTERNS - Static variable in class org.apache.maven.doxia.util.DoxiaUtils
- DATE_TAG - Static variable in interface org.apache.maven.doxia.module.xdoc.XdocMarkup
-
Xdoc tag for
date
- DATETIME - Static variable in interface org.apache.maven.doxia.sink.SinkEventAttributes
-
Specifies a machine readable date/time for the time element.
- DD - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
-
HTML5 tag for
dd
. - debug - Variable in class org.apache.maven.doxia.macro.snippet.SnippetMacro
-
Debug.
- DECORATION - Static variable in interface org.apache.maven.doxia.sink.SinkEventAttributes
-
Specifies a decoration for an element.
- DEFAULT_DEPTH - Static variable in class org.apache.maven.doxia.macro.toc.TocMacro
-
The default end depth.
- 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
- defaultHandler - Variable in class org.apache.maven.doxia.util.XmlValidator
- 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
- DEFINED_TERM - Enum constant in enum org.apache.maven.doxia.index.IndexEntry.Type
- definedTerm() - Method in class org.apache.maven.doxia.sink.impl.AbstractSink
- definedTerm() - Method in interface org.apache.maven.doxia.sink.Sink
-
Starts a definition term element within a definition list.
- definedTerm(SinkEventAttributes) - Method in class org.apache.maven.doxia.module.apt.AptSink
- definedTerm(SinkEventAttributes) - Method in class org.apache.maven.doxia.module.markdown.MarkdownSink
- definedTerm(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
-
Starts a definition term element within a definition list.
- definedTerm(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
- definedTerm(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
-
Starts a definition term element within a definition list.
- definedTerm(SinkEventAttributes) - Method in interface org.apache.maven.doxia.sink.Sink
-
Starts a definition term element within a definition list.
- definedTerm_() - Method in class org.apache.maven.doxia.module.apt.AptSink
-
Ends a definition term element within a definition list.
- definedTerm_() - Method in class org.apache.maven.doxia.module.markdown.MarkdownSink
- definedTerm_() - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
-
Ends a definition term element within a definition list.
- definedTerm_() - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
- definedTerm_() - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
-
Ends a definition term element within a definition list.
- definedTerm_() - Method in interface org.apache.maven.doxia.sink.Sink
-
Ends a definition term element within a definition list.
- definition() - Method in class org.apache.maven.doxia.sink.impl.AbstractSink
- definition() - Method in interface org.apache.maven.doxia.sink.Sink
-
Starts a definition element within a definition list.
- definition(SinkEventAttributes) - Method in class org.apache.maven.doxia.module.apt.AptSink
- definition(SinkEventAttributes) - Method in class org.apache.maven.doxia.module.markdown.MarkdownSink
- definition(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
-
Starts a definition element within a definition list.
- definition(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
- definition(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
-
Starts a definition element within a definition list.
- definition(SinkEventAttributes) - Method in interface org.apache.maven.doxia.sink.Sink
-
Starts a definition element within a definition list.
- DEFINITION - Static variable in class org.apache.maven.doxia.sink.impl.SinkEventAttributeSet.Semantics
-
An unmodifiable attribute set containing only a definition attribute.
- definition_() - Method in class org.apache.maven.doxia.module.apt.AptSink
-
Ends a definition element within a definition list.
- definition_() - Method in class org.apache.maven.doxia.module.markdown.MarkdownSink
- definition_() - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
-
Ends a definition element within a definition list.
- definition_() - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
- definition_() - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
-
Ends a definition element within a definition list.
- definition_() - Method in interface org.apache.maven.doxia.sink.Sink
-
Ends a definition element within a definition list.
- DEFINITION_LIST_ITEM - Static variable in class org.apache.maven.doxia.module.apt.AptParser
-
Definition list event id
- definitionList() - Method in class org.apache.maven.doxia.sink.impl.AbstractSink
- definitionList() - Method in interface org.apache.maven.doxia.sink.Sink
-
Starts a definition list element.
- definitionList(SinkEventAttributes) - Method in class org.apache.maven.doxia.module.apt.AptSink
- definitionList(SinkEventAttributes) - Method in class org.apache.maven.doxia.module.markdown.MarkdownSink
- definitionList(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
-
Starts a definition list.
- definitionList(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
- definitionList(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
-
Starts a definition list.
- definitionList(SinkEventAttributes) - Method in interface org.apache.maven.doxia.sink.Sink
-
Starts a definition list.
- definitionList_() - Method in class org.apache.maven.doxia.module.apt.AptSink
-
Ends a definition list element.
- definitionList_() - Method in class org.apache.maven.doxia.module.markdown.MarkdownSink
- definitionList_() - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
-
Ends a definition list element.
- definitionList_() - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
- definitionList_() - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
-
Ends a definition list element.
- definitionList_() - Method in interface org.apache.maven.doxia.sink.Sink
-
Ends a definition list element.
- definitionListItem() - Method in class org.apache.maven.doxia.sink.impl.AbstractSink
- definitionListItem() - Method in interface org.apache.maven.doxia.sink.Sink
-
Starts a list item element within a definition list.
- definitionListItem(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
-
Starts a list item element within a definition list.
- definitionListItem(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
- definitionListItem(SinkEventAttributes) - Method in interface org.apache.maven.doxia.sink.Sink
-
Starts a list item element within a definition list.
- DefinitionListItem(int, String) - Constructor for class org.apache.maven.doxia.module.apt.AptParser.DefinitionListItem
-
Constructor.
- definitionListItem_() - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
-
Ends a list item element within a definition list.
- definitionListItem_() - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
- definitionListItem_() - Method in interface org.apache.maven.doxia.sink.Sink
-
Ends a list item element within a definition list.
- DEL - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
-
HTML5 tag for
del
. - delegate - Variable in class org.apache.maven.doxia.sink.impl.BufferingSinkProxyFactory.BufferingSinkProxy
- delegate - Variable in class org.apache.maven.doxia.sink.impl.SinkWrapper
- DELETE - Static variable in class org.apache.maven.doxia.sink.impl.SinkEventAttributeSet.Semantics
-
An unmodifiable attribute set containing only a delete attribute.
- destination - Variable in class org.apache.maven.doxia.util.LineBreaker
-
The destination writer.
- 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() - Method in interface org.apache.maven.doxia.sink.Sink
-
Starts a division element grouping together other elements.
- division(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
-
Starts a division element grouping together other elements.
- division(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
- division(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
-
Starts a division element grouping together other elements.
- division(SinkEventAttributes) - Method in interface org.apache.maven.doxia.sink.Sink
-
Starts a division element grouping together other elements.
- division_() - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
-
Ends a division element.
- division_() - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
- division_() - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
-
Ends a division element.
- division_() - Method in interface org.apache.maven.doxia.sink.Sink
-
Ends a division element.
- divStack - Variable in class org.apache.maven.doxia.parser.Xhtml5BaseParser
-
Used to keep track of closing tags for content events
- 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.
- DOCUMENT_TAG - Static variable in interface org.apache.maven.doxia.module.xdoc.XdocMarkup
-
Xdoc tag for
document
- doGetTraversedLink(String, int, int) - Method in class org.apache.maven.doxia.module.apt.AptParser
-
Parse the given text.
- doTraverseText(String, int, int, Sink) - Method in class org.apache.maven.doxia.module.apt.AptParser
-
Parse the given text.
- Doxia - Interface in org.apache.maven.doxia
-
Basic interface of the Doxia framework.
- DOXIA_VERSION - Static variable in class org.apache.maven.doxia.parser.AbstractParser
- DoxiaUtils - Class in org.apache.maven.doxia.util
-
General Doxia utility methods.
- DoxiaUtils() - Constructor for class org.apache.maven.doxia.util.DoxiaUtils
- 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
- ELEMENT_MAPPING_TABLE - Static variable in class org.apache.maven.doxia.parser.Xhtml1BaseParser
-
All obsolete elements in a map with key = obsolete element name, value = non-obsolete replacement element name
- ELEMENT_TYPE_PATTERN - Static variable in class org.apache.maven.doxia.util.XmlValidator.MessagesErrorHandler
- ElementContext(String, MarkdownSink.ElementContext.Type, UnaryOperator<String>) - Constructor for enum org.apache.maven.doxia.module.markdown.MarkdownSink.ElementContext
- ElementContext(String, MarkdownSink.ElementContext.Type, UnaryOperator<String>, boolean) - Constructor for enum org.apache.maven.doxia.module.markdown.MarkdownSink.ElementContext
- ElementContext(String, MarkdownSink.ElementContext.Type, UnaryOperator<String>, boolean, String) - Constructor for enum org.apache.maven.doxia.module.markdown.MarkdownSink.ElementContext
- ElementContext(String, MarkdownSink.ElementContext.Type, UnaryOperator<String>, boolean, String, boolean) - Constructor for enum org.apache.maven.doxia.module.markdown.MarkdownSink.ElementContext
- elementContextStack - Variable in class org.apache.maven.doxia.module.markdown.MarkdownSink
-
The context of the surrounding elements as stack (LIFO)
- EM - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
-
HTML5 tag for
em
. - EMAIL - Static variable in interface org.apache.maven.doxia.sink.SinkEventAttributes
-
An electronic mail address.
- EMBED - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
-
HTML5 tag for
embed
. - emitAnchors - Variable in class org.apache.maven.doxia.parser.AbstractParser
- emitComments - Variable in class org.apache.maven.doxia.parser.AbstractParser
-
Emit Doxia comment events when parsing comments?
- 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.
- EmptyLocator - Class in org.apache.maven.doxia.sink
- EmptyLocator() - Constructor for class org.apache.maven.doxia.sink.EmptyLocator
- 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
- encoding - Variable in class org.apache.maven.doxia.macro.snippet.SnippetReader
-
The encoding of the source.
- encoding - Variable in class org.apache.maven.doxia.module.xdoc.XdocSink
- encoding - Variable in class org.apache.maven.doxia.module.xhtml5.Xhtml5Sink
- encoding - Variable in class org.apache.maven.doxia.sink.impl.RandomAccessSink
-
Deprecated.
- endBlock(boolean) - Method in class org.apache.maven.doxia.module.markdown.MarkdownSink
- endContext(MarkdownSink.ElementContext) - Method in class org.apache.maven.doxia.module.markdown.MarkdownSink
- endOffset - Variable in class org.apache.maven.doxia.module.markdown.YamlFrontMatterVisitor
- endTableCell() - Method in class org.apache.maven.doxia.module.apt.AptSink
-
Ends a table cell.
- endTableCell() - Method in class org.apache.maven.doxia.module.markdown.MarkdownSink
-
Ends a table cell.
- ensureBeginningOfLine() - Method in class org.apache.maven.doxia.module.markdown.MarkdownSink
-
Ensures that the
MarkdownSink.writer
is currently at the beginning of a new line. - ensureBlankLine() - Method in class org.apache.maven.doxia.module.markdown.MarkdownSink
-
Ensures that the
MarkdownSink.writer
is either at the beginning or preceded by a blank line. - entities - Variable in class org.apache.maven.doxia.parser.AbstractXmlParser
- 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.
- entityResolver - Variable in class org.apache.maven.doxia.util.XmlValidator
- EOL - Static variable in interface org.apache.maven.doxia.macro.Macro
-
The vm line separator
- EOL - Static variable in class org.apache.maven.doxia.macro.snippet.SnippetReader
-
System-dependent EOL.
- EOL - Static variable in interface org.apache.maven.doxia.markup.Markup
-
The vm line separator
- EOL - Static variable in class org.apache.maven.doxia.util.LineBreaker
-
The system dependent EOL.
- EOL - Static variable in class org.apache.maven.doxia.util.XmlValidator.MessagesErrorHandler
- 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.module.fml.model.Faq
-
Method equals.
- equals(Object) - Method in class org.apache.maven.doxia.module.fml.model.Faqs
-
Method equals.
- equals(Object) - Method in class org.apache.maven.doxia.module.fml.model.Part
-
Method equals.
- equals(Object) - Method in class org.apache.maven.doxia.sink.impl.SinkEventAttributeSet
- error(SAXParseException) - Method in class org.apache.maven.doxia.util.XmlValidator.MessagesErrorHandler
- escape(String) - Method in enum org.apache.maven.doxia.module.markdown.MarkdownSink.ElementContext
-
Must be called for each inline text to be emitted directly within this context (not relevant for nested context)
- escapeAPT(String) - Static method in class org.apache.maven.doxia.module.apt.AptSink
-
Escape special characters in a text in APT:
- escapeAttributeValues(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
- escapeForMacro(String) - Method in class org.apache.maven.doxia.module.apt.AptParser.MacroBlock
-
escapeForMacro
- escapeForMacro(String) - Method in class org.apache.maven.doxia.module.xhtml5.Xhtml5Parser
-
escapeForMacro
- escapeForTableCell(String) - Static method in class org.apache.maven.doxia.module.markdown.MarkdownSink
-
Escapes the pipe character according to GFM Table Extension in addition to the regular markdown escaping.
- escapeFunction - Variable in enum org.apache.maven.doxia.module.markdown.MarkdownSink.ElementContext
-
The function to call to escape the given text.
- 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.
- escapeMarkdown(String) - Static method in class org.apache.maven.doxia.module.markdown.MarkdownSink
-
First use XML escaping (leveraging the predefined entities, for browsers) afterwards escape special characters in a text with a leading backslash (for markdown parsers)
- evenTableRow - Variable in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
-
Used to style successive table rows differently.
- EventCapturingSinkProxy - Class in org.apache.maven.doxia.sink.impl
-
A proxy for a Sink which captures all event/method names called on it.
- EventCapturingSinkProxy(Sink, List<String>) - Constructor for class org.apache.maven.doxia.sink.impl.EventCapturingSinkProxy
- 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.
- expectedBlock(int) - Method in class org.apache.maven.doxia.module.apt.AptParser
-
Checks that the current block is of the expected type.
- extensions - Variable in class org.apache.maven.doxia.parser.module.AbstractParserModule
-
The supported file extensions.
F
- Factory() - Constructor for class org.apache.maven.doxia.module.markdown.FlexmarkDoxiaLinkResolver.Factory
- Faq - Class in org.apache.maven.doxia.module.fml.model
-
A Faq.
- Faq() - Constructor for class org.apache.maven.doxia.module.fml.model.Faq
- FAQ_TAG - Static variable in interface org.apache.maven.doxia.module.fml.FmlMarkup
-
Fml tag for
faq
- faqs - Variable in class org.apache.maven.doxia.module.fml.FmlParser
-
Collect a faqs model.
- faqs - Variable in class org.apache.maven.doxia.module.fml.model.Part
-
Field faqs.
- Faqs - Class in org.apache.maven.doxia.module.fml.model
-
The
<faqs>
element is the root of the FML descriptor. - Faqs() - Constructor for class org.apache.maven.doxia.module.fml.model.Faqs
- FAQS_TAG - Static variable in interface org.apache.maven.doxia.module.fml.FmlMarkup
-
Fml tag for
faqs
- 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() - Method in class org.apache.maven.doxia.sink.impl.AbstractSink
- figure() - Method in interface org.apache.maven.doxia.sink.Sink
-
Starts a basic image embedding element.
- figure(SinkEventAttributes) - Method in class org.apache.maven.doxia.module.markdown.MarkdownSink
- figure(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
-
Starts a basic image embedding element.
- figure(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
- figure(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
-
Starts a basic image embedding element.
- figure(SinkEventAttributes) - Method in interface org.apache.maven.doxia.sink.Sink
-
Starts a basic image embedding element.
- Figure(int, String) - Constructor for class org.apache.maven.doxia.module.apt.AptParser.Figure
-
Constructor.
- FIGURE - Enum constant in enum org.apache.maven.doxia.index.IndexEntry.Type
- FIGURE - Enum constant in enum org.apache.maven.doxia.module.markdown.MarkdownSink.ElementContext
- FIGURE - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
-
HTML5 tag for
figure
. - FIGURE - Static variable in class org.apache.maven.doxia.module.apt.AptParser
-
Figure event id
- figure_() - Method in class org.apache.maven.doxia.module.markdown.MarkdownSink
- figure_() - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
-
Ends a basic image embedding element.
- figure_() - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
- figure_() - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
-
Ends a basic image embedding element.
- figure_() - Method in interface org.apache.maven.doxia.sink.Sink
-
Ends a basic image embedding element.
- figureCaption() - Method in class org.apache.maven.doxia.sink.impl.AbstractSink
- figureCaption() - Method in interface org.apache.maven.doxia.sink.Sink
-
Starts a caption of an image element.
- figureCaption(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
-
Starts a figure caption.
- figureCaption(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
- figureCaption(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
-
Starts a figure caption.
- figureCaption(SinkEventAttributes) - Method in interface org.apache.maven.doxia.sink.Sink
-
Starts a figure caption.
- figureCaption_() - Method in class org.apache.maven.doxia.module.apt.AptSink
-
Ends a caption of an image.
- figureCaption_() - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
-
Ends a caption of an image.
- figureCaption_() - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
- figureCaption_() - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
-
Ends a caption of an image.
- figureCaption_() - Method in interface org.apache.maven.doxia.sink.Sink
-
Ends a caption of an image.
- figureGraphics(String) - Method in class org.apache.maven.doxia.sink.impl.AbstractSink
- figureGraphics(String) - Method in interface org.apache.maven.doxia.sink.Sink
-
Adds a graphic element.
- figureGraphics(String, SinkEventAttributes) - Method in class org.apache.maven.doxia.module.apt.AptSink
- figureGraphics(String, SinkEventAttributes) - Method in class org.apache.maven.doxia.module.markdown.MarkdownSink
- figureGraphics(String, SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
-
Adds a graphic element.
- 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
-
Adds a graphic element.
- figureGraphics(String, SinkEventAttributes) - Method in interface org.apache.maven.doxia.sink.Sink
-
Adds a graphic element.
- figureSrc - Variable in class org.apache.maven.doxia.module.markdown.MarkdownSink
- FILE_EXTENSION - Static variable in class org.apache.maven.doxia.module.markdown.MarkdownParserModule
-
The extension for Markdown files.
- fileName - Variable in exception class org.apache.maven.doxia.parser.ParseException
-
The file that caused the ParseException.
- filterAttributes(AttributeSet, String[]) - Static method in class org.apache.maven.doxia.sink.impl.SinkUtils
-
Filters the given AttributeSet.
- firstTag - Variable in class org.apache.maven.doxia.sink.impl.AbstractXmlSink
- FLEXMARK_HTML_RENDERER - Static variable in class org.apache.maven.doxia.module.markdown.MarkdownParser
-
Flexmark's HTML renderer (its output will be re-parsed and converted to Sink events)
- FLEXMARK_METADATA_PARSER - Static variable in class org.apache.maven.doxia.module.markdown.MarkdownParser
-
Flexmark's Markdown Metadata parser
- FLEXMARK_PARSER - Static variable in class org.apache.maven.doxia.module.markdown.MarkdownParser
-
Flexmark's Markdown parser (one static instance fits all)
- FlexmarkDoxiaLinkResolver - Class in org.apache.maven.doxia.module.markdown
-
The FlexmarkDoxiaLinkResolver rewrites the md, markdown links to html.
- FlexmarkDoxiaLinkResolver(LinkResolverBasicContext) - Constructor for class org.apache.maven.doxia.module.markdown.FlexmarkDoxiaLinkResolver
-
Constructor for FlexmarkDoxiaLinkResolver.
- FlexmarkDoxiaLinkResolver.Factory - Class in org.apache.maven.doxia.module.markdown
-
Factory that creates FlexmarkDoxiaLinkResolver objects.
- flush() - Method in class org.apache.maven.doxia.module.apt.AptSink
-
Flush the writer or the stream, if needed.
- flush() - Method in class org.apache.maven.doxia.module.markdown.LastTwoLinesBufferingWriter
- flush() - Method in class org.apache.maven.doxia.module.markdown.MarkdownSink
- 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 the writer or the stream, if needed.
- flush() - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
- flush() - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
-
Flush the writer or the stream, if needed.
- flush() - Method in interface org.apache.maven.doxia.sink.Sink
-
Flush the writer or the stream, if needed.
- flush() - Method in class org.apache.maven.doxia.util.LineBreaker
-
Write out the current StringBuilder and flush the writer.
- FLUSH_METHOD - Static variable in class org.apache.maven.doxia.sink.impl.BufferingSinkProxyFactory.BufferingSinkProxy
- flushLine(char[], int, int) - Method in class org.apache.maven.doxia.module.markdown.LastTwoLinesBufferingWriter
- flushTraversed(StringBuilder, Sink) - Static method in class org.apache.maven.doxia.module.apt.AptParser
-
Emits the text so far parsed into the given sink.
- FML_NAMESPACE - Static variable in interface org.apache.maven.doxia.module.fml.FmlMarkup
-
FML namespace: "http://maven.apache.org/FML/1.0.1"
- FML_SYSTEM_ID - Static variable in interface org.apache.maven.doxia.module.fml.FmlMarkup
-
FML system id: "https://maven.apache.org/xsd/fml-1.0.1.xsd"
- FmlContentParser - Class in org.apache.maven.doxia.module.fml
-
Parse Fml questions and answers, these may contain arbitrary xdoc elements.
- FmlContentParser() - Constructor for class org.apache.maven.doxia.module.fml.FmlContentParser
- FmlMarkup - Interface in org.apache.maven.doxia.module.fml
-
List of
FML
markups. - FmlParser - Class in org.apache.maven.doxia.module.fml
-
Parse a fml model and emit events into the specified doxia Sink.
- FmlParser() - Constructor for class org.apache.maven.doxia.module.fml.FmlParser
- FmlParserModule - Class in org.apache.maven.doxia.module.fml
-
FmlParserModule class.
- FmlParserModule() - Constructor for class org.apache.maven.doxia.module.fml.FmlParserModule
-
Default constructor.
- footer() - Method in class org.apache.maven.doxia.sink.impl.AbstractSink
- footer() - Method in interface org.apache.maven.doxia.sink.Sink
-
Start a new footer within the section or body.
- footer(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
-
Start a new footer within the section or body.
- footer(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
- footer(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
-
Start a new footer within the section or body.
- footer(SinkEventAttributes) - Method in interface org.apache.maven.doxia.sink.Sink
-
Start a new footer within the section or body.
- 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.SinkAdapter
-
Ends a footer element.
- footer_() - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
- footer_() - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
-
Ends a footer element.
- footer_() - Method in interface org.apache.maven.doxia.sink.Sink
-
Ends a footer element.
- 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.
- FRAME - Static variable in interface org.apache.maven.doxia.sink.SinkEventAttributes
-
Specifies which sides of a border surrounding an element should be visible.
- fromDepth - Variable in class org.apache.maven.doxia.macro.toc.TocMacro
-
Start depth.
- fromSectionLevel(int) - Static method in enum org.apache.maven.doxia.index.IndexEntry.Type
G
- GENERIC_CONTAINER - Enum constant in enum org.apache.maven.doxia.module.markdown.MarkdownSink.ElementContext.Type
-
Container with no special meaning for (nested) child element contexts
- GET_BUFFERED_SINK_METHOD - Static variable in class org.apache.maven.doxia.sink.impl.BufferingSinkProxyFactory.BufferingSinkProxy
- GET_DOCUMENT_LOCATOR_METHOD - Static variable in class org.apache.maven.doxia.sink.impl.BufferingSinkProxyFactory.BufferingSinkProxy
- getAddDefaultEntities() - Method in class org.apache.maven.doxia.parser.AbstractXmlParser
- getAnswer() - Method in class org.apache.maven.doxia.module.fml.model.Faq
-
Get the answer.
- 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
- getBeforeDependents() - Method in class org.apache.maven.doxia.module.markdown.FlexmarkDoxiaLinkResolver.Factory
- getBuffer() - Method in class org.apache.maven.doxia.module.apt.AptSink
-
Returns the buffer that holds the current text.
- getBuffer() - Method in class org.apache.maven.doxia.module.markdown.MarkdownSink
-
Returns the buffer that holds the current text.
- getBufferedSink() - Method in interface org.apache.maven.doxia.sink.impl.BufferingSinkProxyFactory.BufferingSink
- getCachedSnippet(URL, String) - Method in class org.apache.maven.doxia.macro.snippet.SnippetMacro
-
Return a snippet from the cache.
- 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 class org.apache.maven.doxia.module.apt.AptParser.AptSourceLocator
- getColumnNumber() - Method in class org.apache.maven.doxia.parser.AbstractXmlParser.XmlPullParserLocator
- getColumnNumber() - Method in exception class org.apache.maven.doxia.parser.ParseException
-
Getter for the field
columnNumber
. - getColumnNumber() - Method in class org.apache.maven.doxia.sink.EmptyLocator
- getColumnNumber() - Method in interface org.apache.maven.doxia.sink.Locator
-
Returns the column number for the sink event (starting from 1).
- getContainerLinePrefixes() - Method in class org.apache.maven.doxia.module.markdown.MarkdownSink
- 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
- getDocumentLocator() - Method in interface org.apache.maven.doxia.sink.Sink
-
Returns the locator which exposes location information for a particular Sink event.
- getEndOffset() - Method in class org.apache.maven.doxia.module.markdown.YamlFrontMatterVisitor
- 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.
- getFaqs() - Method in class org.apache.maven.doxia.module.fml.model.Part
-
Method getFaqs.
- getFileName() - Method in exception class 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.
- getId() - Method in class org.apache.maven.doxia.module.fml.model.Faq
-
Get the FAQ identifier.
- getId() - Method in class org.apache.maven.doxia.module.fml.model.Part
-
Get the identifier of the part.
- getImageAttributes(String) - Static method in class org.apache.maven.doxia.util.DoxiaUtils
-
Determine width and height of an image.
- getIndent() - Method in class org.apache.maven.doxia.module.apt.AptParser.Block
-
Return the block indent.
- getInt(MacroRequest, String, int) - Static method in class org.apache.maven.doxia.macro.toc.TocMacro
- getLastEntry() - Method in class org.apache.maven.doxia.index.IndexEntry
-
Returns the last entry.
- getLineNumber() - Method in class org.apache.maven.doxia.module.apt.AptParser.AptSourceLocator
- getLineNumber() - Method in class org.apache.maven.doxia.module.apt.AptReaderSource
-
Gets the current line number while parsing the document.
- getLineNumber() - Method in interface org.apache.maven.doxia.module.apt.AptSource
-
Gets the current line number while parsing the document.
- getLineNumber() - Method in class org.apache.maven.doxia.parser.AbstractXmlParser.XmlPullParserLocator
- getLineNumber() - Method in exception class org.apache.maven.doxia.parser.ParseException
-
Getter for the field
lineNumber
. - getLineNumber() - Method in class org.apache.maven.doxia.sink.EmptyLocator
- getLineNumber() - Method in interface org.apache.maven.doxia.sink.Locator
-
Returns the line number for the sink event (starting from 1).
- 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
. - getModelEncoding() - Method in class org.apache.maven.doxia.module.fml.model.Faqs
-
Get the modelEncoding field.
- getName() - Method in class org.apache.maven.doxia.module.apt.AptReaderSource
-
Returns the name the apt source document.
- getName() - Method in interface org.apache.maven.doxia.module.apt.AptSource
-
Returns the name the apt source document.
- 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.module.apt.AptReaderSource
-
Returns a line of the apt source document.
- getNextLine() - Method in interface org.apache.maven.doxia.module.apt.AptSource
-
Returns a line of the apt source document.
- getNextLine() - Method in class org.apache.maven.doxia.util.ByLineReaderSource
-
getNextLine.
- getNextLine() - Method in interface org.apache.maven.doxia.util.ByLineSource
-
getNextLine.
- getNumbering() - Method in class org.apache.maven.doxia.module.apt.AptParser.NumberedListItem
-
getNumbering.
- 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() - Method in class org.apache.maven.doxia.macro.MacroRequest
-
getParser.
- 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(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.
- getParts() - Method in class org.apache.maven.doxia.module.fml.model.Faqs
-
Method getParts.
- 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
- getQuestion() - Method in class org.apache.maven.doxia.module.fml.model.Faq
-
Get the question.
- getReference() - Method in class org.apache.maven.doxia.sink.EmptyLocator
- getReference() - Method in class org.apache.maven.doxia.sink.impl.AbstractLocator
- getReference() - Method in interface org.apache.maven.doxia.sink.Locator
-
Returns the underlying source reference (for file based documents a relative file path, otherwise an arbitrary string or
null
). - 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).
- getSnippet(URL, String, String) - Method in class org.apache.maven.doxia.macro.snippet.SnippetMacro
-
Return a snippet of the given url.
- 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.
- getSourceLineNumber() - Method in class org.apache.maven.doxia.module.apt.AptParser
-
Returns the current line number of the Apt source document.
- getSourceName() - Method in class org.apache.maven.doxia.module.apt.AptParser
-
Returns the name of the Apt source document.
- getSourceName() - Method in class org.apache.maven.doxia.parser.Xhtml1BaseParser.AttributeMapping
- getTargetName() - Method in class org.apache.maven.doxia.parser.Xhtml1BaseParser.AttributeMapping
- 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.
- getTimeCached(URL, String) - Method in class org.apache.maven.doxia.macro.snippet.SnippetMacro
-
Return the absolute value of when the snippet has been cached.
- 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
. - getTitle() - Method in class org.apache.maven.doxia.module.fml.model.Faqs
-
Get the title name of this FAQ.
- getTitle() - Method in class org.apache.maven.doxia.module.fml.model.Part
-
Get the title of the FAQ part.
- getTraversedAnchor(String, int, int) - Method in class org.apache.maven.doxia.module.apt.AptParser
-
Parse the given text.
- getTraversedLink(String, int, int) - Method in class org.apache.maven.doxia.module.apt.AptParser
-
Parse the given text.
- getType() - Method in class org.apache.maven.doxia.index.IndexEntry
-
Returns the type of this entry.
- getType() - Method in class org.apache.maven.doxia.module.apt.AptParser.Block
-
Return the block type.
- getType() - Method in class org.apache.maven.doxia.parser.AbstractParser
- getType() - Method in class org.apache.maven.doxia.parser.AbstractTextParser
- getType() - Method in class org.apache.maven.doxia.parser.AbstractXmlParser
- getType() - Method in interface org.apache.maven.doxia.parser.Parser
- getUniqueId(String) - Method in class org.apache.maven.doxia.index.IndexingSink
-
Converts the given id into a unique one by potentially suffixing it with an index value.
- getValueMapper() - Method in class org.apache.maven.doxia.parser.Xhtml1BaseParser.AttributeMapping
- getVerbatimMode() - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
- getWrappedSink() - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
- getWrappedSink(Sink) - Method in class org.apache.maven.doxia.parser.AbstractParser
-
Creates a sink pipeline built from all registered
SinkWrapperFactory
objects. - getXmlReader() - Method in class org.apache.maven.doxia.util.XmlValidator
- globalSnippetId(URL, String) - Method in class org.apache.maven.doxia.macro.snippet.SnippetMacro
-
Return a global identifier for the snippet.
- GREATER_THAN - Static variable in interface org.apache.maven.doxia.markup.Markup
-
end character: '<'
- gridFlag - Variable in class org.apache.maven.doxia.module.apt.AptSink
-
gridFlag for tables.
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
. - handleAEnd(Sink) - Method in class org.apache.maven.doxia.parser.Xhtml5BaseParser
- handleAStart(Sink, SinkEventAttributeSet) - Method in class org.apache.maven.doxia.parser.Xhtml5BaseParser
- handleCdsect(XmlPullParser, Sink) - Method in class org.apache.maven.doxia.module.fml.FmlParser
-
Handles CDATA sections.
- 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.module.fml.FmlParser
-
Handles comments.
- handleComment(XmlPullParser, Sink) - Method in class org.apache.maven.doxia.module.xhtml5.Xhtml5Parser
-
Handles comments.
- 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.
- handleDivEnd(Sink) - Method in class org.apache.maven.doxia.parser.Xhtml5BaseParser
- handleDivStart(SinkEventAttributeSet, Sink) - Method in class org.apache.maven.doxia.parser.Xhtml5BaseParser
- handleEndTag(XmlPullParser, Sink) - Method in class org.apache.maven.doxia.module.fml.FmlContentParser
-
Goes through the possible end tags.
- handleEndTag(XmlPullParser, Sink) - Method in class org.apache.maven.doxia.module.fml.FmlParser
-
Goes through the possible end tags.
- handleEndTag(XmlPullParser, Sink) - Method in class org.apache.maven.doxia.module.xdoc.XdocParser
-
Goes through the possible end tags.
- handleEndTag(XmlPullParser, Sink) - Method in class org.apache.maven.doxia.module.xhtml5.Xhtml5Parser
-
Goes through the possible end tags.
- 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.module.fml.FmlParser
-
Handles entities.
- handleEntity(XmlPullParser, Sink) - Method in class org.apache.maven.doxia.parser.AbstractXmlParser
-
Handles entities.
- handleHeadingStart(Sink, int, SinkEventAttributeSet) - Method in class org.apache.maven.doxia.parser.Xhtml5BaseParser
- handleImgStart(Sink, SinkEventAttributeSet) - Method in class org.apache.maven.doxia.parser.Xhtml5BaseParser
- handleLIStart(Sink, SinkEventAttributeSet) - Method in class org.apache.maven.doxia.parser.Xhtml5BaseParser
- handleListItemEnd(Sink) - Method in class org.apache.maven.doxia.parser.Xhtml5BaseParser
- handleMacroEnd(StringBuilder) - Method in class org.apache.maven.doxia.module.fml.FmlParser
-
TODO import from XdocParser, probably need to be generic.
- handleMacroEnd(Sink) - Method in class org.apache.maven.doxia.module.xdoc.XdocParser
- handleMacroStart(XmlPullParser) - Method in class org.apache.maven.doxia.module.fml.FmlParser
-
TODO import from XdocParser, probably need to be generic.
- handleMacroStart(XmlPullParser) - Method in class org.apache.maven.doxia.module.xdoc.XdocParser
- handleMetaStart(XmlPullParser, Sink, SinkEventAttributeSet) - Method in class org.apache.maven.doxia.module.xdoc.XdocParser
- handleOLStart(Sink, SinkEventAttributeSet) - Method in class org.apache.maven.doxia.parser.Xhtml5BaseParser
- handleParamStart(XmlPullParser, Sink) - Method in class org.apache.maven.doxia.module.fml.FmlParser
-
TODO import from XdocParser, probably need to be generic.
- handleParamStart(XmlPullParser, Sink) - Method in class org.apache.maven.doxia.module.xdoc.XdocParser
- handlePreStart(SinkEventAttributeSet, Sink) - Method in class org.apache.maven.doxia.parser.Xhtml5BaseParser
- handlePStart(Sink, SinkEventAttributeSet) - Method in class org.apache.maven.doxia.parser.Xhtml5BaseParser
- handleSectionEnd(Sink) - Method in class org.apache.maven.doxia.parser.Xhtml5BaseParser
- handleSectionStart(int, Sink, SinkEventAttributeSet, XmlPullParser) - Method in class org.apache.maven.doxia.module.xdoc.XdocParser
- handleSectionStart(Sink, SinkEventAttributeSet) - Method in class org.apache.maven.doxia.parser.Xhtml5BaseParser
- handleStartTag(XmlPullParser, Sink) - Method in class org.apache.maven.doxia.module.fml.FmlContentParser
-
Goes through the possible start tags.
- handleStartTag(XmlPullParser, Sink) - Method in class org.apache.maven.doxia.module.fml.FmlParser
-
Goes through the possible start tags.
- handleStartTag(XmlPullParser, Sink) - Method in class org.apache.maven.doxia.module.xdoc.XdocParser
-
Goes through the possible start tags.
- handleStartTag(XmlPullParser, Sink) - Method in class org.apache.maven.doxia.module.xhtml5.Xhtml5Parser
-
Goes through the possible start tags.
- 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.
- handleTableStart(Sink, SinkEventAttributeSet) - Method in class org.apache.maven.doxia.parser.Xhtml5BaseParser
- handleText(XmlPullParser, Sink) - Method in class org.apache.maven.doxia.module.fml.FmlParser
-
Handles text events.
- 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(String, SinkEventAttributeSet, Sink, int) - Method in class org.apache.maven.doxia.parser.AbstractXmlParser
- handleUnknown(XmlPullParser, Sink, int) - Method in class org.apache.maven.doxia.parser.AbstractXmlParser
-
Handles an unknown event.
- hasAnchor - Variable in class org.apache.maven.doxia.index.IndexEntry
-
true if there is already an anchor for this
- hasAnchor() - Method in class org.apache.maven.doxia.index.IndexEntry
-
Returns if the entry's id already has an anchor in the underlying document.
- hasDefinitionListItem - Variable in class org.apache.maven.doxia.parser.Xhtml5BaseParser
-
Used to wrap the definedTerm with its definition, even when one is omitted
- hashCode() - Method in class org.apache.maven.doxia.index.IndexEntry
- hashCode() - Method in class org.apache.maven.doxia.module.fml.model.Faq
-
Method hashCode.
- hashCode() - Method in class org.apache.maven.doxia.module.fml.model.Faqs
-
Method hashCode.
- hashCode() - Method in class org.apache.maven.doxia.module.fml.model.Part
-
Method hashCode.
- hashCode() - Method in class org.apache.maven.doxia.sink.impl.SinkEventAttributeSet
- hasId() - Method in class org.apache.maven.doxia.index.IndexEntry
-
Returns if the entry has an id.
- hasOpenEntry - Variable in class org.apache.maven.doxia.index.IndexingSink
-
Is
true
if the sink is currently populating entry data (i.e. - hasTitle - Variable in class org.apache.maven.doxia.module.xdoc.XdocParser
-
Indicates that <title> was called from <properties> or <head>.
- head() - Method in class org.apache.maven.doxia.sink.impl.AbstractSink
- head() - Method in interface org.apache.maven.doxia.sink.Sink
-
Starts the head element.
- head(SinkEventAttributes) - Method in class org.apache.maven.doxia.module.apt.AptSink
- head(SinkEventAttributes) - Method in class org.apache.maven.doxia.module.markdown.MarkdownSink
- head(SinkEventAttributes) - Method in class org.apache.maven.doxia.module.xdoc.XdocSink
-
Starts the head element.
- head(SinkEventAttributes) - Method in class org.apache.maven.doxia.module.xhtml5.Xhtml5Sink
- head(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
-
Starts the head element.
- head(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
- head(SinkEventAttributes) - Method in interface org.apache.maven.doxia.sink.Sink
-
Starts the head element.
- HEAD - Enum constant in enum org.apache.maven.doxia.module.markdown.MarkdownSink.ElementContext
- HEAD - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
-
HTML5 tag for
head
. - head_() - Method in class org.apache.maven.doxia.module.apt.AptSink
-
Ends the head element.
- head_() - Method in class org.apache.maven.doxia.module.markdown.MarkdownSink
- head_() - Method in class org.apache.maven.doxia.module.xdoc.XdocSink
-
Ends the head element.
- head_() - Method in class org.apache.maven.doxia.module.xhtml5.Xhtml5Sink
-
Ends the head element.
- head_() - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
-
Ends the head element.
- head_() - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
- head_() - Method in interface org.apache.maven.doxia.sink.Sink
-
Ends the head element.
- header() - Method in class org.apache.maven.doxia.sink.impl.AbstractSink
- header() - Method in interface org.apache.maven.doxia.sink.Sink
-
Start a new header within the section or body.
- header(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
-
Start a new header within the section or body.
- header(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
- header(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
-
Start a new header within the section or body.
- header(SinkEventAttributes) - Method in interface org.apache.maven.doxia.sink.Sink
-
Start a new header within the section or body.
- 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.SinkAdapter
-
Ends a header element.
- header_() - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
- header_() - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
-
Ends a header element.
- header_() - Method in interface org.apache.maven.doxia.sink.Sink
-
Ends a header element.
- HEADER_START_MARKUP - Static variable in interface org.apache.maven.doxia.module.apt.AptMarkup
-
Syntax for the header start: " -----"
- headerFlag - Variable in class org.apache.maven.doxia.module.apt.AptSink
-
headerFlag.
- HEADERS - Static variable in interface org.apache.maven.doxia.sink.SinkEventAttributes
-
A space-separated list of cell IDs that supply header information for the cell.
- headFlag - Variable in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
-
An indication on if we're inside a head.
- headingLevel - Variable in class org.apache.maven.doxia.parser.Xhtml5BaseParser
-
Counts current heading level.
- headTitleFlag - Variable in class org.apache.maven.doxia.module.xhtml5.Xhtml5Sink
-
An indication on if we're inside a head title.
- HEIGHT - Static variable in interface org.apache.maven.doxia.sink.SinkEventAttributes
-
Defines the height of an event element.
- HGROUP - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
-
HTML5 tag for
hgroup
. - HIDDEN_CLASS_PATTERN - Static variable in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
-
Used to identify if a class string contains `hidden`
- HIGHLIGHT - Static variable in class org.apache.maven.doxia.sink.impl.SinkEventAttributeSet.Semantics
-
An unmodifiable attribute set containing only a highlight attribute.
- HORIZONTAL_RULE - Static variable in class org.apache.maven.doxia.module.apt.AptParser
-
Horizontal rule event id
- HORIZONTAL_RULE_MARKUP - Static variable in interface org.apache.maven.doxia.module.apt.AptMarkup
-
Syntax for the horizontal rule: "========"
- HORIZONTAL_RULE_MARKUP - Static variable in interface org.apache.maven.doxia.module.markdown.MarkdownMarkup
-
Syntax for the horizontal rule: "***"
- horizontalRule() - Method in class org.apache.maven.doxia.sink.impl.AbstractSink
- horizontalRule() - Method in interface org.apache.maven.doxia.sink.Sink
-
Adding a separator of sections from a text to each other.
- horizontalRule(SinkEventAttributes) - Method in class org.apache.maven.doxia.module.apt.AptSink
- horizontalRule(SinkEventAttributes) - Method in class org.apache.maven.doxia.module.markdown.MarkdownSink
- horizontalRule(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
-
Adds a horizontal separator rule.
- horizontalRule(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
- horizontalRule(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
-
Adds a horizontal separator rule.
- horizontalRule(SinkEventAttributes) - Method in interface org.apache.maven.doxia.sink.Sink
-
Adds a horizontal separator rule.
- HorizontalRule(int, String) - Constructor for class org.apache.maven.doxia.module.apt.AptParser.HorizontalRule
-
Constructor.
- HOUR - Static variable in class org.apache.maven.doxia.macro.snippet.SnippetMacro
- HR - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
-
HTML5 tag for
hr
. - HR_ATTRIBUTES - Static variable in class org.apache.maven.doxia.sink.impl.SinkUtils
- HREF - Static variable in interface org.apache.maven.doxia.sink.SinkEventAttributes
-
The target URL of an event element, eg a link.
- HREFLANG - Static variable in interface org.apache.maven.doxia.sink.SinkEventAttributes
-
Specifies the base language of the target URL.
- HSPACE - Static variable in interface org.apache.maven.doxia.sink.SinkEventAttributes
-
Defines white space on the left and right side of an event element.
- 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. - HtmlTools() - Constructor for class org.apache.maven.doxia.util.HtmlTools
I
- I - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
-
HTML5 tag for
i
. - id - Variable in class org.apache.maven.doxia.index.IndexEntry
-
The id of the entry.
- id - Variable in class org.apache.maven.doxia.module.fml.model.Faq
-
The FAQ identifier.
- id - Variable in class org.apache.maven.doxia.module.fml.model.Part
-
The identifier of the part.
- ID - Static variable in interface org.apache.maven.doxia.sink.SinkEventAttributes
-
A unique id for the event element.
- IFRAME - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
-
HTML5 tag for
iframe
. - ignorableWhitespace - Variable in class org.apache.maven.doxia.parser.AbstractXmlParser
- IGNORE - Enum constant in enum org.apache.maven.doxia.parser.Xhtml1BaseParser.AttributeMapping.MergeSemantics
- ignoreDownloadError - Variable in class org.apache.maven.doxia.macro.snippet.SnippetMacro
-
in case of Exception during snippet download error will ignored and empty content returned.
- IMG - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
-
HTML5 tag for
img
. - IMG_ATTRIBUTES - Static variable in class org.apache.maven.doxia.sink.impl.SinkUtils
- indent - Variable in class org.apache.maven.doxia.module.apt.AptParser.Block
-
indent.
- indent(String) - Method in class org.apache.maven.doxia.macro.snippet.SnippetReader
-
Returns the indent of the given line.
- INDENT - Static variable in interface org.apache.maven.doxia.module.markdown.MarkdownMarkup
-
indentation e.g.
- 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
- indexEntryComplete() - Method in class org.apache.maven.doxia.index.IndexingSink
- 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)
withSinkAdapter
as argument and callIndexingSink.getRootEntry()
to retrieve the index tree afterwards. - IndexingSink(IndexEntry, Sink) - Constructor for class org.apache.maven.doxia.index.IndexingSink
-
Default constructor.
- IndexingSink(Sink) - Constructor for class org.apache.maven.doxia.index.IndexingSink
- inHead - Variable in class org.apache.maven.doxia.module.xdoc.XdocParser
-
Indicates that we're inside <properties> or <head>.
- init() - Method in class org.apache.maven.doxia.module.apt.AptParser
-
Initialize the parser.
- init() - Method in class org.apache.maven.doxia.module.apt.AptSink
-
This is called in
AbstractSink.head()
or inSink.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.module.fml.FmlContentParser
-
Initialize the parser.
- init() - Method in class org.apache.maven.doxia.module.fml.FmlParser
-
Initialize the parser.
- init() - Method in class org.apache.maven.doxia.module.markdown.MarkdownParser.MarkdownHtmlParser
- init() - Method in class org.apache.maven.doxia.module.markdown.MarkdownSink
- init() - Method in class org.apache.maven.doxia.module.xdoc.XdocParser
-
Initialize the parser.
- init() - Method in class org.apache.maven.doxia.module.xdoc.XdocSink
-
This is called in
AbstractSink.head()
or inSink.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.module.xhtml5.Xhtml5Parser
-
Initialize the parser.
- 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 inSink.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 inSink.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() - Method in interface org.apache.maven.doxia.sink.Sink
-
Starts an inline element.
- inline(SinkEventAttributes) - Method in class org.apache.maven.doxia.module.apt.AptSink
-
Starts an inline element.
- inline(SinkEventAttributes) - Method in class org.apache.maven.doxia.module.markdown.MarkdownSink
- inline(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
-
Starts an inline element.
- inline(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
- inline(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
-
Starts an inline element.
- inline(SinkEventAttributes) - Method in interface org.apache.maven.doxia.sink.Sink
-
Starts an inline element.
- INLINE - Enum constant in enum org.apache.maven.doxia.module.markdown.MarkdownSink.ElementContext.Type
-
Are not allowed to contain any other element context (i.e.
- inline_() - Method in class org.apache.maven.doxia.module.apt.AptSink
-
Ends an inline element.
- inline_() - Method in class org.apache.maven.doxia.module.markdown.MarkdownSink
- inline_() - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
-
Ends an inline element.
- inline_() - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
- inline_() - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
-
Ends an inline element.
- inline_() - Method in interface org.apache.maven.doxia.sink.Sink
-
Ends an inline element.
- inlineSemantics(SinkEventAttributes, String, List<HTML.Tag>, HTML.Tag) - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
- inlineStack - Variable in class org.apache.maven.doxia.module.apt.AptSink
-
Keep track of the closing tags for inline events.
- inlineStack - Variable in class org.apache.maven.doxia.module.markdown.MarkdownSink
-
Keep track of end markup for inline events.
- 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.
- insertNewline - Variable in class org.apache.maven.doxia.sink.impl.AbstractXmlSink
- INSTANCE - Static variable in class org.apache.maven.doxia.sink.EmptyLocator
- inVerbatim - Variable in class org.apache.maven.doxia.parser.Xhtml5BaseParser
-
Verbatim flag, true whenever we are inside a <pre> tag.
- invoke(Object) - Method in class org.apache.maven.doxia.sink.impl.BufferingSinkProxyFactory.MethodWithArguments
- invoke(Object, Method, Object[]) - Method in class org.apache.maven.doxia.sink.impl.BufferingSinkProxyFactory.BufferingSinkProxy
- 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.
- isAnchor - Variable in class org.apache.maven.doxia.parser.Xhtml5BaseParser
-
Used to distinguish <a href=""> from <a name="">.
- isAsciiDigit(char) - Static method in class org.apache.maven.doxia.util.DoxiaUtils
- isAsciiLetter(char) - Static method in class org.apache.maven.doxia.util.DoxiaUtils
- isBlock() - Method in enum org.apache.maven.doxia.module.markdown.MarkdownSink.ElementContext
- isCacheTimedout(URL, String) - Method in class org.apache.maven.doxia.macro.snippet.SnippetMacro
-
Return true if the snippet has been cached longer than the current timeout.
- isCellJustifStack - Variable in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
-
Stack of justification of table cells.
- isCollapsibleWhitespace() - Method in class org.apache.maven.doxia.parser.AbstractXmlParser
-
isCollapsibleWhitespace.
- isComplete - Variable in class org.apache.maven.doxia.index.IndexingSink
-
Is
true
once the sink has been closed. - isContainer() - Method in enum org.apache.maven.doxia.module.markdown.MarkdownSink.ElementContext
- 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.
- isEmptyElement - Variable in class org.apache.maven.doxia.module.fml.FmlContentParser
-
Empty elements don't write a closing tag.
- isEmptyElement - Variable in class org.apache.maven.doxia.module.xdoc.XdocParser
-
Empty elements don't write a closing tag.
- isEmptyElement - Variable in class org.apache.maven.doxia.module.xhtml5.Xhtml5Parser
-
Empty elements don't write a closing tag.
- 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.module.apt.AptUtils
-
Checks if the given string corresponds to an external URI, ie is not a link within the same document nor a link to another document within the same site.
- 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.
- isFirstTableRow - Variable in class org.apache.maven.doxia.module.markdown.MarkdownSink
-
is header row
- isHeadFlag() - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
-
isHeadFlag.
- isHeadTitleFlag() - Method in class org.apache.maven.doxia.module.xhtml5.Xhtml5Sink
-
isHeadTitleFlag.
- isHexChar(char) - Static method in class org.apache.maven.doxia.module.apt.AptParser
-
Determine if c is an hex character.
- isHighSurrogate(char) - Static method in class org.apache.maven.doxia.util.HtmlTools
- isIgnorableWhitespace() - Method in class org.apache.maven.doxia.parser.AbstractXmlParser
-
isIgnorableWhitespace.
- isInternalLink(String) - Static method in class org.apache.maven.doxia.module.apt.AptUtils
-
Checks if the given string corresponds to an internal link, ie it is a link to an anchor within the same document.
- 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.
- isLastEventSectionStart() - Method in class org.apache.maven.doxia.parser.Xhtml5BaseParser
- isLink - Variable in class org.apache.maven.doxia.parser.Xhtml5BaseParser
-
Used to distinguish <a href=""> from <a name="">.
- isLocalLink(String) - Static method in class org.apache.maven.doxia.module.apt.AptUtils
-
Checks if the given string corresponds to a relative link to another document within the same site.
- isLocalLink(String) - Static method in class org.apache.maven.doxia.util.DoxiaUtils
- ISMAP - Static variable in interface org.apache.maven.doxia.sink.SinkEventAttributes
-
Defines an image as a server-side image map.
- isOctalChar(char) - Static method in class org.apache.maven.doxia.module.apt.AptParser
-
Determine if c is an octal character.
- isRelevantIndexEntry(IndexEntry) - Static method in class org.apache.maven.doxia.macro.toc.TocMacro
- 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.
- isSection() - Method in enum org.apache.maven.doxia.index.IndexEntry.Type
- isSource - Variable in class org.apache.maven.doxia.module.apt.AptSink
-
verbatim source.
- isStart(String, String) - Method in class org.apache.maven.doxia.macro.snippet.SnippetReader
-
Determines if the given line is a start demarcator.
- isSupplementaryCodePoint(int) - Static method in class org.apache.maven.doxia.util.HtmlTools
- isTitle - Variable in class org.apache.maven.doxia.index.IndexingSink
- isToplink() - Method in class org.apache.maven.doxia.module.fml.model.Faqs
-
Get boolean to generate optionally [top] links.
- 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
- isValidCodePoint(int) - Static method in class org.apache.maven.doxia.util.HtmlTools
- 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
- isWriterAfterBlankLine() - Method in class org.apache.maven.doxia.module.markdown.LastTwoLinesBufferingWriter
- isWriterAtStartOfNewLine() - Method in class org.apache.maven.doxia.module.markdown.LastTwoLinesBufferingWriter
- italic() - Method in class org.apache.maven.doxia.module.apt.AptSink
-
Starts an italic element.
- italic() - Method in class org.apache.maven.doxia.module.markdown.MarkdownSink
- italic() - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
-
Starts an italic element.
- italic() - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
- italic() - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
-
Starts an italic element.
- italic() - Method in interface org.apache.maven.doxia.sink.Sink
-
Starts an italic element.
- 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.module.apt.AptSink
-
Ends an italic element.
- italic_() - Method in class org.apache.maven.doxia.module.markdown.MarkdownSink
- italic_() - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
-
Ends an italic element.
- italic_() - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
- italic_() - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
-
Ends an italic element.
- italic_() - Method in interface org.apache.maven.doxia.sink.Sink
-
Ends an italic element.
- ITALIC_END_MARKUP - Static variable in interface org.apache.maven.doxia.module.apt.AptMarkup
-
Syntax for the italic style end: ">"
- ITALIC_END_MARKUP - Static variable in interface org.apache.maven.doxia.module.markdown.MarkdownMarkup
-
Syntax for the italic style end: "_"
- ITALIC_START_MARKUP - Static variable in interface org.apache.maven.doxia.module.apt.AptMarkup
-
Syntax for the italic style start: "<"
- ITALIC_START_MARKUP - Static variable in interface org.apache.maven.doxia.module.markdown.MarkdownMarkup
-
Syntax for the italic style start: "_"
- itemFlag - Variable in class org.apache.maven.doxia.module.apt.AptSink
-
itemFlag.
J
- join(String[], String[]) - Static method in class org.apache.maven.doxia.sink.impl.SinkUtils
- JUSTIFY - Static variable in class org.apache.maven.doxia.sink.impl.SinkEventAttributeSet
-
An unmodifiable attribute set containing only a justify attribute.
- JUSTIFY_CENTER - Static variable in interface org.apache.maven.doxia.sink.Sink
-
Center alignment for table cells.
- JUSTIFY_LEFT - Static variable in interface org.apache.maven.doxia.sink.Sink
-
Left alignment for table cells.
- JUSTIFY_RIGHT - Static variable in interface org.apache.maven.doxia.sink.Sink
-
Right alignment for table cells.
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
. - LANG - Static variable in interface org.apache.maven.doxia.sink.SinkEventAttributes
-
The language code for the event element.
- languageId - Variable in class org.apache.maven.doxia.module.xdoc.XdocSink
- languageId - Variable in class org.apache.maven.doxia.module.xhtml5.Xhtml5Sink
- lastLine - Variable in class org.apache.maven.doxia.util.ByLineReaderSource
-
holds the last line returned by getNextLine()
- LastTwoLinesBufferingWriter - Class in org.apache.maven.doxia.module.markdown
-
Decorates an existing writer to additionally temporarily buffer the last two lines written.
- LastTwoLinesBufferingWriter(Writer) - Constructor for class org.apache.maven.doxia.module.markdown.LastTwoLinesBufferingWriter
- LastTwoLinesBufferingWriter(Writer, String) - Constructor for class org.apache.maven.doxia.module.markdown.LastTwoLinesBufferingWriter
- LEAF_BLOCK - Enum constant in enum org.apache.maven.doxia.module.markdown.MarkdownSink.ElementContext.Type
-
Is supposed to start on a new line, must not contain any other block element context (neither leaf nor container)
- 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 - Variable in class org.apache.maven.doxia.module.apt.AptParser
-
a line of AptSource.
- 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() - Method in interface org.apache.maven.doxia.sink.Sink
-
Adds a line break.
- lineBreak(SinkEventAttributes) - Method in class org.apache.maven.doxia.module.apt.AptSink
- lineBreak(SinkEventAttributes) - Method in class org.apache.maven.doxia.module.markdown.MarkdownSink
- lineBreak(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
-
Adds a line break.
- lineBreak(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
- lineBreak(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
-
Adds a line break.
- lineBreak(SinkEventAttributes) - Method in interface org.apache.maven.doxia.sink.Sink
-
Adds a line break.
- 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() - Method in interface org.apache.maven.doxia.sink.Sink
-
Adds a line break opportunity.
- lineBreakOpportunity(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
-
Adds a line break opportunity.
- lineBreakOpportunity(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
- lineBreakOpportunity(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
-
Adds a line break opportunity.
- lineBreakOpportunity(SinkEventAttributes) - Method in interface org.apache.maven.doxia.sink.Sink
-
Adds a line break opportunity.
- lineLength - Variable in class org.apache.maven.doxia.util.LineBreaker
-
The current line length.
- lineNumber - Variable in class org.apache.maven.doxia.module.apt.AptReaderSource
-
lineNumber.
- lineNumber - Variable in exception class org.apache.maven.doxia.parser.ParseException
-
Line number where the parse exception occurred.
- lineNumber - Variable in class org.apache.maven.doxia.util.ByLineReaderSource
-
current line number
- lineSeparator - Variable in class org.apache.maven.doxia.module.markdown.LastTwoLinesBufferingWriter
- LINETHROUGH - Static variable in class org.apache.maven.doxia.sink.impl.SinkEventAttributeSet
-
An unmodifiable attribute set containing only a linethrough attribute.
- link(String) - Method in class org.apache.maven.doxia.sink.impl.AbstractSink
- link(String) - Method in interface org.apache.maven.doxia.sink.Sink
-
Starts an element which defines a link.
- link(String, String) - Method in class org.apache.maven.doxia.module.apt.AptSink
-
A link with a target.
- link(String, SinkEventAttributes) - Method in class org.apache.maven.doxia.module.apt.AptSink
- link(String, SinkEventAttributes) - Method in class org.apache.maven.doxia.module.markdown.MarkdownSink
-
Starts a link.
- link(String, SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
-
Starts a link.
- 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(String, SinkEventAttributes) - Method in interface org.apache.maven.doxia.sink.Sink
-
Starts a link.
- LINK - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
-
HTML5 tag for
link
. - link_() - Method in class org.apache.maven.doxia.module.apt.AptSink
-
Ends a link element.
- link_() - Method in class org.apache.maven.doxia.module.markdown.MarkdownSink
- link_() - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
-
Ends a link element.
- link_() - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
- link_() - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
-
Ends a link element.
- link_() - Method in interface org.apache.maven.doxia.sink.Sink
-
Ends a link element.
- LINK_ATTRIBUTES - Static variable in class org.apache.maven.doxia.sink.impl.SinkUtils
- LINK_END_MARKUP - Static variable in interface org.apache.maven.doxia.module.apt.AptMarkup
-
Syntax for the link end: "}}"
- LINK_END_MARKUP - Static variable in interface org.apache.maven.doxia.module.markdown.MarkdownMarkup
-
Syntax for the link end: ")"
- LINK_START_1_MARKUP - Static variable in interface org.apache.maven.doxia.module.apt.AptMarkup
-
Syntax for the link start: "{{{"
- LINK_START_1_MARKUP - Static variable in interface org.apache.maven.doxia.module.markdown.MarkdownMarkup
-
Syntax for the link start: "["
- LINK_START_2_MARKUP - Static variable in interface org.apache.maven.doxia.module.apt.AptMarkup
-
Syntax for the link start: "}"
- LINK_START_2_MARKUP - Static variable in interface org.apache.maven.doxia.module.markdown.MarkdownMarkup
-
Syntax for the link start: "]("
- linkName - Variable in class org.apache.maven.doxia.module.markdown.MarkdownSink
-
linkName.
- list() - Method in class org.apache.maven.doxia.sink.impl.AbstractSink
- list() - Method in interface org.apache.maven.doxia.sink.Sink
-
Starts an unordered list element.
- list(SinkEventAttributes) - Method in class org.apache.maven.doxia.module.apt.AptSink
- list(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
-
Starts an unordered list.
- list(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
- list(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
-
Starts an unordered list.
- list(SinkEventAttributes) - Method in interface org.apache.maven.doxia.sink.Sink
-
Starts an unordered list.
- list_() - Method in class org.apache.maven.doxia.module.apt.AptSink
-
Ends an unordered list element.
- list_() - Method in class org.apache.maven.doxia.module.markdown.MarkdownSink
- list_() - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
-
Ends an unordered list element.
- list_() - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
- list_() - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
-
Ends an unordered list element.
- list_() - Method in interface org.apache.maven.doxia.sink.Sink
-
Ends an unordered list element.
- LIST_BREAK - Static variable in class org.apache.maven.doxia.module.apt.AptParser
-
List break event id
- LIST_END_MARKUP - Static variable in interface org.apache.maven.doxia.module.apt.AptMarkup
-
Syntax for the list end: "[]"
- LIST_ITEM - Enum constant in enum org.apache.maven.doxia.module.markdown.MarkdownSink.ElementContext
- LIST_ITEM - Static variable in class org.apache.maven.doxia.module.apt.AptParser
-
List event id
- LIST_ORDERED_ITEM_START_MARKUP - Static variable in interface org.apache.maven.doxia.module.markdown.MarkdownMarkup
-
Syntax for the ordered list item: '1.
- LIST_START_MARKUP - Static variable in interface org.apache.maven.doxia.module.apt.AptMarkup
-
Syntax for the list start: "*"
- LIST_UNORDERED_ITEM_START_MARKUP - Static variable in interface org.apache.maven.doxia.module.markdown.MarkdownMarkup
-
Syntax for the unordered list item: "- "
- ListBreak(int, String) - Constructor for class org.apache.maven.doxia.module.apt.AptParser.ListBreak
-
Constructor.
- listItem() - Method in class org.apache.maven.doxia.sink.impl.AbstractSink
- listItem() - Method in interface org.apache.maven.doxia.sink.Sink
-
Starts a list item element within an unordered list.
- listItem(SinkEventAttributes) - Method in class org.apache.maven.doxia.module.apt.AptSink
- listItem(SinkEventAttributes) - Method in class org.apache.maven.doxia.module.markdown.MarkdownSink
- listItem(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
-
Starts a list item element within an unordered list.
- listItem(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
- listItem(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
-
Starts a list item element within an unordered list.
- listItem(SinkEventAttributes) - Method in interface org.apache.maven.doxia.sink.Sink
-
Starts a list item element within an unordered list.
- ListItem(int, String) - Constructor for class org.apache.maven.doxia.module.apt.AptParser.ListItem
-
Constructor.
- listItem_() - Method in class org.apache.maven.doxia.module.apt.AptSink
-
Ends a list item element within an unordered list.
- listItem_() - Method in class org.apache.maven.doxia.module.markdown.MarkdownSink
- listItem_() - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
-
Ends a list item element within an unordered list.
- listItem_() - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
- listItem_() - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
-
Ends a list item element within an unordered list.
- listItem_() - Method in interface org.apache.maven.doxia.sink.Sink
-
Ends a list item element within an unordered list.
- listNestingIndent - Variable in class org.apache.maven.doxia.module.apt.AptSink
-
listNestingIndent.
- listStyles - Variable in class org.apache.maven.doxia.module.apt.AptSink
-
listStyles.
- locator - Variable in class org.apache.maven.doxia.sink.impl.AbstractSink
- Locator - Interface in org.apache.maven.doxia.sink
-
Interface for associating a
Sink
event with a document location. - LOGGER - Static variable in class org.apache.maven.doxia.macro.snippet.SnippetMacro
- LOGGER - Static variable in class org.apache.maven.doxia.module.apt.AptParser
- LOGGER - Static variable in class org.apache.maven.doxia.module.apt.AptSink
- LOGGER - Static variable in class org.apache.maven.doxia.module.fml.FmlContentParser
- LOGGER - Static variable in class org.apache.maven.doxia.module.fml.FmlParser
- LOGGER - Static variable in class org.apache.maven.doxia.module.markdown.MarkdownSink
- LOGGER - Static variable in class org.apache.maven.doxia.module.xdoc.XdocParser
- LOGGER - Static variable in class org.apache.maven.doxia.module.xhtml5.Xhtml5Parser
- LOGGER - Static variable in class org.apache.maven.doxia.parser.AbstractXmlParser.CachedFileEntityResolver
- LOGGER - Static variable in class org.apache.maven.doxia.parser.Xhtml5BaseParser
- LOGGER - Static variable in class org.apache.maven.doxia.sink.impl.UniqueAnchorNamesValidator
- LOGGER - Static variable in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
- LOGGER - Static variable in class org.apache.maven.doxia.util.XmlValidator
- LOW_SURROGATE - Static variable in class org.apache.maven.doxia.util.HtmlTools
- LUNATE_SIGMA - Static variable in class org.apache.maven.doxia.util.HtmlTools
M
- Macro - Interface in org.apache.maven.doxia.macro
-
Base interface of a macro.
- MACRO - Static variable in class org.apache.maven.doxia.module.apt.AptParser
-
Macro event id
- MACRO_TAG - Static variable in interface org.apache.maven.doxia.module.fml.FmlMarkup
-
Fml tag for
macro
- MACRO_TAG - Static variable in interface org.apache.maven.doxia.module.xdoc.XdocMarkup
-
Xdoc tag for
macro
- MacroBlock(int, String) - Constructor for class org.apache.maven.doxia.module.apt.AptParser.MacroBlock
-
Constructor.
- MacroExecutionException - Exception Class in org.apache.maven.doxia.macro
-
Wrap an exception that occurs during the execution of a Doxia macro.
- MacroExecutionException(String) - Constructor for exception class org.apache.maven.doxia.macro.MacroExecutionException
-
Construct a new
MacroExecutionException
with the specified detail message. - MacroExecutionException(String, Throwable) - Constructor for exception class org.apache.maven.doxia.macro.MacroExecutionException
-
Construct a new
MacroExecutionException
with the specified detail message and cause. - MacroExecutionException(Throwable) - Constructor for exception class org.apache.maven.doxia.macro.MacroExecutionException
-
Construct a new
MacroExecutionException
with the specified cause. - macroManager - Variable in class org.apache.maven.doxia.parser.AbstractParser
- MacroManager - Interface in org.apache.maven.doxia.macro.manager
-
Handles MacroManager lookups.
- macroName - Variable in class org.apache.maven.doxia.module.fml.FmlParser
-
A macro name.
- macroName - Variable in class org.apache.maven.doxia.module.xdoc.XdocParser
-
A macro name.
- MacroNotFoundException - Exception Class 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 class org.apache.maven.doxia.macro.manager.MacroNotFoundException
-
Construct a new MacroNotFoundException with the specified detail message.
- MacroNotFoundException(String, Throwable) - Constructor for exception class org.apache.maven.doxia.macro.manager.MacroNotFoundException
-
Construct a new MacroNotFoundException with the specified detail message and cause.
- MacroNotFoundException(Throwable) - Constructor for exception class org.apache.maven.doxia.macro.manager.MacroNotFoundException
-
Constructs a new MacroNotFoundException with the specified cause.
- macroParameters - Variable in class org.apache.maven.doxia.module.fml.FmlParser
-
The macro parameters.
- macroParameters - Variable in class org.apache.maven.doxia.module.xdoc.XdocParser
-
The macro parameters.
- 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.
- macros - Variable in class org.apache.maven.doxia.macro.manager.DefaultMacroManager
- MAIN - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
-
HTML5 tag for
main
. - manuallyRegisteredSinkWrapperFactories - Variable in class org.apache.maven.doxia.parser.AbstractParser
- MAP - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
-
HTML5 tag for
map
. - mapAlignToStyle(String) - Static method in class org.apache.maven.doxia.parser.Xhtml1BaseParser
- MARK - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
-
HTML5 tag for
mark
. - MarkdownHtmlParser() - Constructor for class org.apache.maven.doxia.module.markdown.MarkdownParser.MarkdownHtmlParser
- MarkdownMarkup - Interface in org.apache.maven.doxia.module.markdown
-
This interface defines all markups and syntaxes used by the Markdown format.
- MarkdownParser - Class in org.apache.maven.doxia.module.markdown
-
Implementation of
Parser
for Markdown documents. - MarkdownParser() - Constructor for class org.apache.maven.doxia.module.markdown.MarkdownParser
- MarkdownParser.MarkdownHtmlParser - Class in org.apache.maven.doxia.module.markdown
-
Internal parser for HTML generated by the Markdown library.
- MarkdownParserModule - Class in org.apache.maven.doxia.module.markdown
-
ParserModule
for Markdown. - MarkdownParserModule() - Constructor for class org.apache.maven.doxia.module.markdown.MarkdownParserModule
-
Build a new instance of
MarkdownParserModule
. - MarkdownSink - Class in org.apache.maven.doxia.module.markdown
-
Markdown generator implementation.
- MarkdownSink(Writer) - Constructor for class org.apache.maven.doxia.module.markdown.MarkdownSink
-
Constructor, initialize the Writer and the variables.
- MarkdownSink.ElementContext - Enum in org.apache.maven.doxia.module.markdown
-
Most important contextual metadata (of the surrounding element)
- MarkdownSink.ElementContext.Type - Enum in org.apache.maven.doxia.module.markdown
- MarkdownSinkFactory - Class in org.apache.maven.doxia.module.markdown
-
Markdown implementation of the Sink factory.
- MarkdownSinkFactory() - Constructor for class org.apache.maven.doxia.module.markdown.MarkdownSinkFactory
- Markup - Interface in org.apache.maven.doxia.markup
-
List of constants used by all markup syntax.
- MAX_CODE_POINT - Static variable in class org.apache.maven.doxia.util.HtmlTools
- MAX_HIGH_SURROGATE - Static variable in class org.apache.maven.doxia.util.HtmlTools
- maxLineLength - Variable in class org.apache.maven.doxia.util.LineBreaker
-
The maximal line length.
- 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
. - mergeSemantics - Variable in class org.apache.maven.doxia.parser.Xhtml1BaseParser.AttributeMapping
- MergeSemantics() - Constructor for enum org.apache.maven.doxia.parser.Xhtml1BaseParser.AttributeMapping.MergeSemantics
- mergeValue(String, String) - Method in class org.apache.maven.doxia.parser.Xhtml1BaseParser.AttributeMapping
- 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
. - METADATA_ENTRY_PATTERN - Static variable in class org.apache.maven.doxia.module.markdown.MarkdownParser
-
Regex that captures the key and value of a multimarkdown-style metadata entry.
- METADATA_MARKUP - Static variable in interface org.apache.maven.doxia.module.markdown.MarkdownMarkup
-
Syntax for the header start: "---"
- METADATA_SECTION_PATTERN - Static variable in class org.apache.maven.doxia.module.markdown.MarkdownParser
-
Regex that identifies a multimarkdown-style metadata section at the start of the document In order to ensure that we have minimal risk of false positives when slurping metadata sections, the first key in the metadata section must be one of these standard keys or else the entire metadata section is ignored.
- METER - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
-
HTML5 tag for
meter
. - method - Variable in class org.apache.maven.doxia.sink.impl.BufferingSinkProxyFactory.MethodWithArguments
- MethodWithArguments(Method, Object[]) - Constructor for class org.apache.maven.doxia.sink.impl.BufferingSinkProxyFactory.MethodWithArguments
- MIN_CODE_POINT - Static variable in class org.apache.maven.doxia.util.HtmlTools
- MIN_HIGH_SURROGATE - Static variable in class org.apache.maven.doxia.util.HtmlTools
- MIN_SUPPLEMENTARY_CODE_POINT - Static variable in class org.apache.maven.doxia.util.HtmlTools
- minIndent(List<String>) - Method in class org.apache.maven.doxia.macro.snippet.SnippetReader
-
Returns the minimal indent of all the lines in the given List.
- MINUS - Static variable in interface org.apache.maven.doxia.markup.Markup
-
minus character: '-'
- modelEncoding - Variable in class org.apache.maven.doxia.module.fml.model.Faqs
-
Field modelEncoding.
- monospaced() - Method in class org.apache.maven.doxia.module.apt.AptSink
-
Starts a monospaced element.
- monospaced() - Method in class org.apache.maven.doxia.module.markdown.MarkdownSink
- monospaced() - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
-
Starts a monospaced element.
- monospaced() - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
- monospaced() - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
-
Starts a monospaced element.
- monospaced() - Method in interface org.apache.maven.doxia.sink.Sink
-
Starts a monospaced element.
- 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.module.apt.AptSink
-
Ends a monospaced element.
- monospaced_() - Method in class org.apache.maven.doxia.module.markdown.MarkdownSink
- monospaced_() - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
-
Ends a monospaced element.
- monospaced_() - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
- monospaced_() - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
-
Ends a monospaced element.
- monospaced_() - Method in interface org.apache.maven.doxia.sink.Sink
-
Ends a monospaced element.
- MONOSPACED_END_MARKUP - Static variable in interface org.apache.maven.doxia.module.apt.AptMarkup
-
Syntax for the mono-spaced style end: ">>>"
- MONOSPACED_END_MARKUP - Static variable in interface org.apache.maven.doxia.module.markdown.MarkdownMarkup
-
Syntax for the mono-spaced style end: "`"
- MONOSPACED_START_MARKUP - Static variable in interface org.apache.maven.doxia.module.apt.AptMarkup
-
Syntax for the mono-spaced style start: "<<<"
- MONOSPACED_START_MARKUP - Static variable in interface org.apache.maven.doxia.module.markdown.MarkdownMarkup
-
Syntax for the mono-spaced style start: "`"
N
- name - Variable in class org.apache.maven.doxia.module.apt.AptReaderSource
-
The name, e.g.
- name - Variable in enum org.apache.maven.doxia.module.markdown.MarkdownSink.ElementContext
- name - Variable in class org.apache.maven.doxia.util.ByLineReaderSource
- NAME - Static variable in interface org.apache.maven.doxia.sink.SinkEventAttributes
-
Specifies the name of an anchor.
- nameSpace - Variable in class org.apache.maven.doxia.sink.impl.AbstractXmlSink
-
Default namespace prepended to all tags
- 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() - Method in interface org.apache.maven.doxia.sink.Sink
-
Starts a navigation section within a document.
- navigation(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
-
Starts a navigation section within a document.
- navigation(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
- navigation(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
-
Starts a navigation section within a document.
- navigation(SinkEventAttributes) - Method in interface org.apache.maven.doxia.sink.Sink
-
Starts a navigation section within a document.
- navigation_() - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
-
Ends the navigation element.
- navigation_() - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
- navigation_() - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
-
Ends the navigation element.
- navigation_() - Method in interface org.apache.maven.doxia.sink.Sink
-
Ends the navigation element.
- newInstance(List<Sink>) - Static method in class org.apache.maven.doxia.sink.impl.PipelineSink
-
Deprecated.Returns an instance of a PipelineSink as a Sink.
- newInstance(Sink, List<String>) - Static method in class org.apache.maven.doxia.sink.impl.EventCapturingSinkProxy
- nextBlock() - Method in class org.apache.maven.doxia.module.apt.AptParser
-
Parse the next block of the Apt source document.
- nextBlock(boolean) - Method in class org.apache.maven.doxia.module.apt.AptParser
-
Parse the next block of the Apt source document.
- nextLine() - Method in class org.apache.maven.doxia.module.apt.AptParser
-
Parse the next line of the Apt source document.
- NON_BREAKING_SPACE_MARKUP - Static variable in interface org.apache.maven.doxia.module.apt.AptMarkup
-
Syntax for the non breaking space: "\ "
- NON_BREAKING_SPACE_MARKUP - Static variable in interface org.apache.maven.doxia.module.markdown.MarkdownMarkup
-
Syntax for the non breaking space: entity from HTML
- NON_PRIVATE_USE_HIGH_SURROGATE - Static variable in class org.apache.maven.doxia.util.HtmlTools
- nonBreakingSpace() - Method in class org.apache.maven.doxia.module.apt.AptSink
-
Adding a non breaking space, ie a space without any special formatting operations.
- nonBreakingSpace() - Method in class org.apache.maven.doxia.module.markdown.MarkdownSink
- nonBreakingSpace() - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
-
Adding a non breaking space, ie a space without any special formatting operations.
- nonBreakingSpace() - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
- nonBreakingSpace() - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
-
Adding a non breaking space, ie a space without any special formatting operations.
- nonBreakingSpace() - Method in interface org.apache.maven.doxia.sink.Sink
-
Adding a non breaking space, ie a space without any special formatting operations.
- normalizeMultilineValue(String) - Static method in class org.apache.maven.doxia.module.markdown.MarkdownParser
- NOSCRIPT - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
-
HTML5 tag for
noscript
. - NOSHADE - Static variable in interface org.apache.maven.doxia.sink.SinkEventAttributes
-
Used to indicate that an element comes with a shadow.
- NOWRAP - Static variable in interface org.apache.maven.doxia.sink.SinkEventAttributes
-
Whether to disable or enable automatic text wrapping for an element.
- NUMBER_OF_SPACES - Static variable in class org.apache.maven.doxia.module.apt.AptParser
- NUMBERED_LIST_ITEM - Static variable in class org.apache.maven.doxia.module.apt.AptParser
-
Numbered list event id
- numberedList(int) - Method in class org.apache.maven.doxia.sink.impl.AbstractSink
- numberedList(int) - Method in interface org.apache.maven.doxia.sink.Sink
-
Starts an ordered list element.
- numberedList(int, SinkEventAttributes) - Method in class org.apache.maven.doxia.module.apt.AptSink
- numberedList(int, SinkEventAttributes) - Method in class org.apache.maven.doxia.module.markdown.MarkdownSink
- numberedList(int, SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
-
Starts an ordered list element.
- 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(int, SinkEventAttributes) - Method in interface org.apache.maven.doxia.sink.Sink
-
Starts an ordered list element.
- numberedList_() - Method in class org.apache.maven.doxia.module.apt.AptSink
-
Ends an ordered list element.
- numberedList_() - Method in class org.apache.maven.doxia.module.markdown.MarkdownSink
- numberedList_() - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
-
Ends an ordered list element.
- numberedList_() - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
- numberedList_() - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
-
Ends an ordered list element.
- numberedList_() - Method in interface org.apache.maven.doxia.sink.Sink
-
Ends an ordered list element.
- numberedListItem() - Method in class org.apache.maven.doxia.sink.impl.AbstractSink
- numberedListItem() - Method in interface org.apache.maven.doxia.sink.Sink
-
Starts a list item element within an ordered list.
- numberedListItem(SinkEventAttributes) - Method in class org.apache.maven.doxia.module.apt.AptSink
- numberedListItem(SinkEventAttributes) - Method in class org.apache.maven.doxia.module.markdown.MarkdownSink
- numberedListItem(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
-
Starts a list item element within an ordered list.
- numberedListItem(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
- numberedListItem(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
-
Starts a list item element within an ordered list.
- numberedListItem(SinkEventAttributes) - Method in interface org.apache.maven.doxia.sink.Sink
-
Starts a list item element within an ordered list.
- NumberedListItem(int, String, int) - Constructor for class org.apache.maven.doxia.module.apt.AptParser.NumberedListItem
-
Constructor.
- numberedListItem_() - Method in class org.apache.maven.doxia.module.apt.AptSink
-
Ends a list item element within an ordered list.
- numberedListItem_() - Method in class org.apache.maven.doxia.module.markdown.MarkdownSink
- numberedListItem_() - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
-
Ends a list item element within an ordered list.
- numberedListItem_() - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
- numberedListItem_() - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
-
Ends a list item element within an ordered list.
- numberedListItem_() - Method in interface org.apache.maven.doxia.sink.Sink
-
Ends a list item element within an ordered list.
- numbering - Variable in class org.apache.maven.doxia.module.apt.AptParser.NumberedListItem
-
numbering.
- NUMBERING - Static variable in interface org.apache.maven.doxia.module.apt.AptMarkup
-
APT numbering decimal markup char: '1'
- NUMBERING_DECIMAL - Static variable in interface org.apache.maven.doxia.sink.Sink
-
A numbering to handle a number list.
- NUMBERING_LOWER_ALPHA - Static variable in interface org.apache.maven.doxia.sink.Sink
-
A numbering to handle a lower alpha list.
- NUMBERING_LOWER_ALPHA_CHAR - Static variable in interface org.apache.maven.doxia.module.apt.AptMarkup
-
APT numbering lower alpha markup char: 'a'
- NUMBERING_LOWER_ROMAN - Static variable in interface org.apache.maven.doxia.sink.Sink
-
A numbering to handle a lower roman list.
- NUMBERING_LOWER_ROMAN_CHAR - Static variable in interface org.apache.maven.doxia.module.apt.AptMarkup
-
APT numbering lower roman markup char: 'i'
- NUMBERING_UPPER_ALPHA - Static variable in interface org.apache.maven.doxia.sink.Sink
-
A numbering to handle a upper alpha list.
- NUMBERING_UPPER_ALPHA_CHAR - Static variable in interface org.apache.maven.doxia.module.apt.AptMarkup
-
APT numbering upper alpha markup char: 'A'
- NUMBERING_UPPER_ROMAN - Static variable in interface org.apache.maven.doxia.sink.Sink
-
A numbering to handle a upper roman list.
- NUMBERING_UPPER_ROMAN_CHAR - Static variable in interface org.apache.maven.doxia.module.apt.AptMarkup
-
APT numbering upper roman markup char: 'I'
O
- OBJECT - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
-
HTML5 tag for
object
. - OFF - Enum constant in enum org.apache.maven.doxia.sink.impl.Xhtml5BaseSink.VerbatimMode
-
not in verbatim mode
- OL - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
-
HTML5 tag for
ol
. - ON - Enum constant in enum org.apache.maven.doxia.sink.impl.Xhtml5BaseSink.VerbatimMode
-
Inside
<pre>
- ON_WITH_CODE - Enum constant in enum org.apache.maven.doxia.sink.impl.Xhtml5BaseSink.VerbatimMode
-
Inside
<pre><code>
- 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.module.xdoc.XdocSink
-
Starts a section.
- 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.module.xdoc.XdocSink
-
Ends 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.module.xdoc.XdocSink
-
Starts a section title.
- 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.module.xdoc.XdocSink
-
Ends a section title.
- onSectionTitle_(int) - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
-
Ends a section title.
- openMissingHeadingSections(int, Sink) - Method in class org.apache.maven.doxia.parser.Xhtml5BaseParser
-
Open missing heading sections.
- openMissingSections(int, Sink) - Method in class org.apache.maven.doxia.module.xdoc.XdocParser
-
Open missing h2, h3, h4, h5 sections.
- 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
. - orderedListDepth - Variable in class org.apache.maven.doxia.parser.Xhtml5BaseParser
-
Used for nested lists.
- org.apache.maven.doxia - package org.apache.maven.doxia
- 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.module.apt - package org.apache.maven.doxia.module.apt
- org.apache.maven.doxia.module.fml - package org.apache.maven.doxia.module.fml
- org.apache.maven.doxia.module.fml.model - package org.apache.maven.doxia.module.fml.model
- org.apache.maven.doxia.module.markdown - package org.apache.maven.doxia.module.markdown
- org.apache.maven.doxia.module.xdoc - package org.apache.maven.doxia.module.xdoc
- org.apache.maven.doxia.module.xhtml5 - package org.apache.maven.doxia.module.xhtml5
- 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 - package org.apache.maven.doxia.sink
- org.apache.maven.doxia.sink.impl - package org.apache.maven.doxia.sink.impl
- org.apache.maven.doxia.util - package org.apache.maven.doxia.util
- out - Variable in class org.apache.maven.doxia.module.markdown.LastTwoLinesBufferingWriter
- OUTPUT - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
-
HTML5 tag for
output
. - outputStreams - Variable in class org.apache.maven.doxia.sink.impl.RandomAccessSink
-
Deprecated.
- OVERLINE - Static variable in class org.apache.maven.doxia.sink.impl.SinkEventAttributeSet
-
An unmodifiable attribute set containing only an overline attribute.
- OVERWRITE - Enum constant in enum org.apache.maven.doxia.parser.Xhtml1BaseParser.AttributeMapping.MergeSemantics
P
- P - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
-
HTML5 tag for
p
. - PAGE_BREAK - Static variable in interface org.apache.maven.doxia.module.apt.AptMarkup
-
APT page break markup char: '\f'
- PAGE_BREAK_MARKUP - Static variable in interface org.apache.maven.doxia.module.apt.AptMarkup
-
Syntax for the page break: "\f"
- pageBreak() - Method in class org.apache.maven.doxia.module.apt.AptSink
-
Adding a new page separator.
- pageBreak() - Method in class org.apache.maven.doxia.module.markdown.MarkdownSink
- pageBreak() - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
-
Adding a new page separator.
- pageBreak() - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
- pageBreak() - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
-
Adding a new page separator.
- pageBreak() - Method in interface org.apache.maven.doxia.sink.Sink
-
Adding a new page separator.
- PageBreak(int, String) - Constructor for class org.apache.maven.doxia.module.apt.AptParser.PageBreak
-
Constructor.
- paragraph() - Method in class org.apache.maven.doxia.sink.impl.AbstractSink
- paragraph() - Method in interface org.apache.maven.doxia.sink.Sink
-
Starts an element which represents a paragraph.
- paragraph(SinkEventAttributes) - Method in class org.apache.maven.doxia.module.apt.AptSink
- paragraph(SinkEventAttributes) - Method in class org.apache.maven.doxia.module.markdown.MarkdownSink
- paragraph(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
-
Starts a paragraph.
- paragraph(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
- paragraph(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
-
Starts a paragraph.
- paragraph(SinkEventAttributes) - Method in interface org.apache.maven.doxia.sink.Sink
-
Starts a paragraph.
- Paragraph(int, String) - Constructor for class org.apache.maven.doxia.module.apt.AptParser.Paragraph
-
Constructor.
- PARAGRAPH - Static variable in class org.apache.maven.doxia.module.apt.AptParser
-
Paragraph event id
- paragraph_() - Method in class org.apache.maven.doxia.module.apt.AptSink
-
Ends a paragraph element.
- paragraph_() - Method in class org.apache.maven.doxia.module.markdown.MarkdownSink
- paragraph_() - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
-
Ends a paragraph element.
- paragraph_() - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
- paragraph_() - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
-
Ends a paragraph element.
- paragraph_() - Method in interface org.apache.maven.doxia.sink.Sink
-
Ends a paragraph element.
- paragraphFlag - Variable in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
-
An indication on if we're inside a paragraph flag.
- PARAM - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
-
HTML5 tag for
param
. - PARAM_PARSER - Static variable in class org.apache.maven.doxia.macro.MacroRequest
- PARAM_SOURCE_CONTENT - Static variable in class org.apache.maven.doxia.macro.MacroRequest
- parameters - Variable in class org.apache.maven.doxia.macro.MacroRequest
-
A map of parameters.
- parent - Variable in class org.apache.maven.doxia.index.IndexEntry
-
The parent entry.
- 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) - 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 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 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, Sink) - Method in class org.apache.maven.doxia.module.apt.AptParser
-
Parses the given source model and emits Doxia 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) - 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.module.apt.AptParser
-
Parses the given source model and emits Doxia events into the given sink.
- parse(Reader, Sink, String) - Method in class org.apache.maven.doxia.module.fml.FmlParser
-
Parses the given source model and emits Doxia events into the given sink.
- parse(Reader, Sink, String) - Method in class org.apache.maven.doxia.module.markdown.MarkdownParser
-
Parses the given source model and emits Doxia events into the given sink.
- parse(Reader, Sink, String) - Method in class org.apache.maven.doxia.module.xdoc.XdocParser
-
Parses the given source model and emits Doxia events into the given sink.
- parse(Reader, Sink, String) - Method in class org.apache.maven.doxia.module.xhtml5.Xhtml5Parser
-
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, String) - Method in interface org.apache.maven.doxia.parser.Parser
-
Parses the given source model and emits Doxia events into the given sink.
- parse(Reader, Sink, String) - Method in class org.apache.maven.doxia.parser.Xhtml5BaseParser
-
Parses the given source model and emits Doxia events into the given sink.
- parse(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.
- parseAnchor(String) - Method in class org.apache.maven.doxia.index.IndexingSink
- 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 Class in org.apache.maven.doxia.parser
-
Encapsulate a Doxia parse error.
- ParseException(Exception) - Constructor for exception class org.apache.maven.doxia.parser.ParseException
-
Construct a new
ParseException
with the specified cause. - ParseException(Exception, int, int) - Constructor for exception class 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 class org.apache.maven.doxia.parser.ParseException
-
Construct a new
ParseException
with the specified cause, filename, line number and column number. - ParseException(String) - Constructor for exception class org.apache.maven.doxia.parser.ParseException
-
Construct a new
ParseException
with the specified detail message. - ParseException(String, int, int) - Constructor for exception class org.apache.maven.doxia.parser.ParseException
-
Construct a new
ParseException
with the specified detail message, line number and column number. - ParseException(String, Exception) - Constructor for exception class org.apache.maven.doxia.parser.ParseException
-
Construct a new
ParseException
with the specified detail message and cause. - ParseException(String, Exception, int, int) - Constructor for exception class org.apache.maven.doxia.parser.ParseException
-
Construct a new
ParseException
with the specified detail message and cause, line number and column number. - ParseException(String, Exception, String, int, int) - Constructor for exception class org.apache.maven.doxia.parser.ParseException
-
Construct a new
ParseException
with the specified cause, detail message, filename, line number and column number. - parseJustification(String, int) - Method in class org.apache.maven.doxia.module.apt.AptParser.Table
-
Parse a table justification line.
- parser - Variable in class org.apache.maven.doxia.module.markdown.MarkdownParser
-
The parser of the HTML produced by Flexmark, that we will use to convert this HTML to Sink events
- parser - Variable in class org.apache.maven.doxia.parser.AbstractXmlParser.XmlPullParserLocator
- 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.
- parserId - Variable in class org.apache.maven.doxia.parser.module.AbstractParserModule
-
The default file extension.
- parserManager - Variable in class org.apache.maven.doxia.DefaultDoxia
- 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 Class 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 class org.apache.maven.doxia.parser.module.ParserModuleNotFoundException
-
Construct a new ParserModuleNotFoundException with the specified detail message.
- ParserModuleNotFoundException(String, Throwable) - Constructor for exception class org.apache.maven.doxia.parser.module.ParserModuleNotFoundException
-
Construct a new ParserModuleNotFoundException with the specified detail message and cause.
- ParserModuleNotFoundException(Throwable) - Constructor for exception class org.apache.maven.doxia.parser.module.ParserModuleNotFoundException
-
Constructs a new ParserModuleNotFoundException with the specified cause.
- parserModules - Variable in class org.apache.maven.doxia.parser.module.DefaultParserModuleManager
- parserModulesValues - Variable in class org.apache.maven.doxia.parser.module.DefaultParserModuleManager
- ParserNotFoundException - Exception Class 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 class org.apache.maven.doxia.parser.manager.ParserNotFoundException
-
Construct a new ParserNotFoundException with the specified detail message.
- ParserNotFoundException(String, Throwable) - Constructor for exception class org.apache.maven.doxia.parser.manager.ParserNotFoundException
-
Construct a new ParserNotFoundException with the specified detail message and cause.
- ParserNotFoundException(Throwable) - Constructor for exception class org.apache.maven.doxia.parser.manager.ParserNotFoundException
-
Constructs a new exception with the specified cause.
- parsers - Variable in class org.apache.maven.doxia.parser.manager.DefaultParserManager
- parseXml(XmlPullParser, Sink, String) - Method in class org.apache.maven.doxia.parser.AbstractXmlParser
-
Parse the model from the XmlPullParser into the given sink.
- Part - Class in org.apache.maven.doxia.module.fml.model
-
FAQ part.
- Part() - Constructor for class org.apache.maven.doxia.module.fml.model.Part
- PART_TAG - Static variable in interface org.apache.maven.doxia.module.fml.FmlMarkup
-
Fml tag for
part
- parts - Variable in class org.apache.maven.doxia.module.fml.model.Faqs
-
Field parts.
- pattern - Variable in class org.apache.maven.doxia.module.markdown.FlexmarkDoxiaLinkResolver
- PATTERN_ENTITY_1 - Static variable in class org.apache.maven.doxia.parser.AbstractXmlParser
-
Entity pattern for HTML entity, i.e.
- PATTERN_ENTITY_2 - Static variable in class org.apache.maven.doxia.parser.AbstractXmlParser
-
Entity pattern for Unicode entity, i.e.
- peek() - Method in class org.apache.maven.doxia.index.IndexingSink
-
peek.
- PERCENT - Static variable in interface org.apache.maven.doxia.module.apt.AptMarkup
-
APT percent markup char: '%'
- PG_BREAK - Static variable in class org.apache.maven.doxia.module.apt.AptParser
-
Page break event id
- 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: '|'
- pipeline - Variable in class org.apache.maven.doxia.sink.impl.PipelineSink
-
Deprecated.
- 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
. - prefix - Variable in enum org.apache.maven.doxia.module.markdown.MarkdownSink.ElementContext
-
prefix to be used for a (nested) block elements inside the current container context (only not empty for
MarkdownSink.ElementContext.type
beingMarkdownSink.ElementContext.Type.CONTAINER_BLOCK
) - PREPEND - Enum constant in enum org.apache.maven.doxia.parser.Xhtml1BaseParser.AttributeMapping.MergeSemantics
- previousLine - Variable in class org.apache.maven.doxia.module.markdown.LastTwoLinesBufferingWriter
- processException(int, SAXParseException) - Method in class org.apache.maven.doxia.util.XmlValidator.MessagesErrorHandler
- processMacro(String, Sink) - Method in class org.apache.maven.doxia.module.xhtml5.Xhtml5Parser
-
process macro embedded in XHTML commment
- processMetadataForHtml(StringBuilder, StringBuilder) - Method in class org.apache.maven.doxia.module.markdown.MarkdownParser
- PROFILE - Static variable in interface org.apache.maven.doxia.sink.SinkEventAttributes
-
A space separated list of URL's that contains meta data information about the document.
- PROGRESS - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
-
HTML5 tag for
progress
. - PROPERTIES_TAG - Static variable in interface org.apache.maven.doxia.module.xdoc.XdocMarkup
-
Xdoc tag for
properties
- push(IndexEntry) - Method in class org.apache.maven.doxia.index.IndexingSink
-
Pushes an IndexEntry onto the top of this stack.
- pushNewEntry(IndexEntry.Type) - Method in class org.apache.maven.doxia.index.IndexingSink
-
Creates and pushes a new IndexEntry onto the top of this stack.
Q
- Q - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
-
HTML5 tag for
q
. - question - Variable in class org.apache.maven.doxia.module.fml.model.Faq
-
The question.
- QUESTION_TAG - Static variable in interface org.apache.maven.doxia.module.fml.FmlMarkup
-
Fml tag for
question
- 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 aSinkFactory
. - 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.
- 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.
- rawText(String) - Method in class org.apache.maven.doxia.module.apt.AptSink
-
Adding a raw text, ie a text without any special formatting operations.
- rawText(String) - Method in class org.apache.maven.doxia.module.markdown.MarkdownSink
- rawText(String) - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
-
Adding a raw text, ie a text without any special formatting operations.
- rawText(String) - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
- rawText(String) - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
-
Adding a raw text, ie a text without any special formatting operations.
- rawText(String) - Method in interface org.apache.maven.doxia.sink.Sink
-
Adding a raw text, ie a text without any special formatting operations.
- RB - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
-
HTML5 tag for
rb
. - reader - Variable in class org.apache.maven.doxia.module.apt.AptReaderSource
-
A reader.
- reader - Variable in class org.apache.maven.doxia.util.ByLineReaderSource
-
reader
- readLines(String) - Method in class org.apache.maven.doxia.macro.snippet.SnippetReader
-
Reads the snippet and returns the lines in a List.
- readSnippet(String) - Method in class org.apache.maven.doxia.macro.snippet.SnippetReader
-
Reads the snippet with given id.
- reference - Variable in class org.apache.maven.doxia.sink.impl.AbstractLocator
- REL - Static variable in interface org.apache.maven.doxia.sink.SinkEventAttributes
-
For references to external resourcs, specifies the relationship between the current document and the target URL.
- 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
- removeFaq(Faq) - Method in class org.apache.maven.doxia.module.fml.model.Part
-
Method removeFaq.
- removeFromCache(URL, String) - Method in class org.apache.maven.doxia.macro.snippet.SnippetMacro
-
Removes the snippet from the cache.
- removePart(Part) - Method in class org.apache.maven.doxia.module.fml.model.Faqs
-
Method removePart.
- replaceAll(String, String, String) - Static method in class org.apache.maven.doxia.module.apt.AptParser
-
Replace part of a string.
- requiresBuffering - Variable in enum org.apache.maven.doxia.module.markdown.MarkdownSink.ElementContext
-
if
true
requires buffering any text appearing inside this context - requiresBuffering() - Method in class org.apache.maven.doxia.module.markdown.MarkdownSink
- requiresSurroundingByBlankLines - Variable in enum org.apache.maven.doxia.module.markdown.MarkdownSink.ElementContext
-
Only relevant for block element, if set to
true
the element requires to be surrounded by blank lines. - resetBuffer() - Method in class org.apache.maven.doxia.module.apt.AptSink
-
Reset the StringBuilder.
- resetBuffer() - Method in class org.apache.maven.doxia.module.markdown.MarkdownSink
-
Reset the StringBuilder.
- resetTableCaptionBuffer() - Method in class org.apache.maven.doxia.module.apt.AptSink
-
Reset the TableCaptionBuffer.
- 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
- resolveLink(Node, LinkResolverBasicContext, ResolvedLink) - Method in class org.apache.maven.doxia.module.markdown.FlexmarkDoxiaLinkResolver
- resolveParent - Variable in class org.apache.maven.doxia.sink.impl.SinkEventAttributeSet
- REV - Static variable in interface org.apache.maven.doxia.sink.SinkEventAttributes
-
For references to external resourcs, specifies the relationship between the target URL and the current document.
- 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: ']'
- rootEntry - Variable in class org.apache.maven.doxia.index.IndexingSink
- rowLine - Variable in class org.apache.maven.doxia.module.apt.AptSink
-
a line of a row in a table.
- ROWSPAN - Static variable in interface org.apache.maven.doxia.sink.SinkEventAttributes
-
Indicates the number of rows a cell should span.
- 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.
- RULES - Static variable in interface org.apache.maven.doxia.sink.SinkEventAttributes
-
Specifies horizontal/vertical divider lines between certain elements, eg table cells.
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.
- SCOPE - Static variable in interface org.apache.maven.doxia.sink.SinkEventAttributes
-
A general scope parameter.
- SCRIPT - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
-
HTML5 tag for
script
. - scriptBlock - Variable in class org.apache.maven.doxia.parser.Xhtml5BaseParser
-
True if a <script></script> or <style></style> block is read.
- secondParsing - Variable in class org.apache.maven.doxia.parser.AbstractParser
-
Indicates that a second parsing is required.
- section - Variable in class org.apache.maven.doxia.macro.toc.TocMacro
-
The section to display.
- section(int, SinkEventAttributes) - Method in class org.apache.maven.doxia.index.IndexingSink
- section(int, SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
-
Start a new section at the given level.
- 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
-
Start a new section at the given level.
- section(int, SinkEventAttributes) - Method in interface org.apache.maven.doxia.sink.Sink
-
Start a new section at the given level.
- Section(int, int, String) - Constructor for class org.apache.maven.doxia.module.apt.AptParser.Section
-
Constructor.
- SECTION - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
-
HTML5 tag for
section
. - section_(int) - Method in class org.apache.maven.doxia.index.IndexingSink
- section_(int) - Method in class org.apache.maven.doxia.module.apt.AptSink
- section_(int) - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
-
Ends a section at the given level.
- section_(int) - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
- section_(int) - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
-
Ends a section at the given level.
- section_(int) - Method in interface org.apache.maven.doxia.sink.Sink
-
Ends a section at the given level.
- SECTION_1 - Enum constant in enum org.apache.maven.doxia.index.IndexEntry.Type
- SECTION_2 - Enum constant in enum org.apache.maven.doxia.index.IndexEntry.Type
- SECTION_3 - Enum constant in enum org.apache.maven.doxia.index.IndexEntry.Type
- SECTION_4 - Enum constant in enum org.apache.maven.doxia.index.IndexEntry.Type
- SECTION_5 - Enum constant in enum org.apache.maven.doxia.index.IndexEntry.Type
- SECTION_6 - Enum constant in enum org.apache.maven.doxia.index.IndexEntry.Type
- SECTION_LEVEL_1 - Static variable in interface org.apache.maven.doxia.sink.Sink
-
A level 1 section (section).
- SECTION_LEVEL_2 - Static variable in interface org.apache.maven.doxia.sink.Sink
-
A level 2 section (subsection).
- SECTION_LEVEL_3 - Static variable in interface org.apache.maven.doxia.sink.Sink
-
A level 3 section (sub-subsection).
- SECTION_LEVEL_4 - Static variable in interface org.apache.maven.doxia.sink.Sink
-
A level 4 section (sub-sub-subsection).
- SECTION_LEVEL_5 - Static variable in interface org.apache.maven.doxia.sink.Sink
-
A level 5 section (sub-sub-sub-subsection).
- SECTION_LEVEL_6 - Static variable in interface org.apache.maven.doxia.sink.Sink
-
A level 6 section.
- SECTION_TAG - Static variable in interface org.apache.maven.doxia.module.xdoc.XdocMarkup
-
Xdoc tag for
section
- SECTION_TITLE_START_MARKUP - Static variable in interface org.apache.maven.doxia.module.apt.AptMarkup
-
Syntax for the section title start: "*"
- SECTION_TITLE_START_MARKUP - Static variable in interface org.apache.maven.doxia.module.markdown.MarkdownMarkup
-
Syntax for the section title start: "#"
- section1() - Method in class org.apache.maven.doxia.sink.impl.AbstractSink
- section1() - Method in interface org.apache.maven.doxia.sink.Sink
-
Starts a first heading element which contains the topic of the section.
- Section1(int, String) - Constructor for class org.apache.maven.doxia.module.apt.AptParser.Section1
-
Constructor.
- SECTION1 - Static variable in class org.apache.maven.doxia.module.apt.AptParser
-
Section 1 event id
- section1_() - Method in class org.apache.maven.doxia.sink.impl.AbstractSink
- section1_() - Method in interface org.apache.maven.doxia.sink.Sink
-
Ends a first heading element.
- section2() - Method in class org.apache.maven.doxia.sink.impl.AbstractSink
- section2() - Method in interface org.apache.maven.doxia.sink.Sink
-
Starts a second heading element which contains the topic of the section.
- Section2(int, String) - Constructor for class org.apache.maven.doxia.module.apt.AptParser.Section2
-
Constructor.
- SECTION2 - Static variable in class org.apache.maven.doxia.module.apt.AptParser
-
Section 2 event id
- section2_() - Method in class org.apache.maven.doxia.sink.impl.AbstractSink
- section2_() - Method in interface org.apache.maven.doxia.sink.Sink
-
Ends a second heading element.
- section3() - Method in class org.apache.maven.doxia.sink.impl.AbstractSink
- section3() - Method in interface org.apache.maven.doxia.sink.Sink
-
Starts a third heading element which contains the topic of the section.
- Section3(int, String) - Constructor for class org.apache.maven.doxia.module.apt.AptParser.Section3
-
Constructor.
- SECTION3 - Static variable in class org.apache.maven.doxia.module.apt.AptParser
-
Section 3 event id
- section3_() - Method in class org.apache.maven.doxia.sink.impl.AbstractSink
- section3_() - Method in interface org.apache.maven.doxia.sink.Sink
-
Ends a third heading element.
- section4() - Method in class org.apache.maven.doxia.sink.impl.AbstractSink
- section4() - Method in interface org.apache.maven.doxia.sink.Sink
-
Starts a 4th heading element which contains the topic of the section.
- Section4(int, String) - Constructor for class org.apache.maven.doxia.module.apt.AptParser.Section4
-
Constructor.
- SECTION4 - Static variable in class org.apache.maven.doxia.module.apt.AptParser
-
Section 4 event id
- section4_() - Method in class org.apache.maven.doxia.sink.impl.AbstractSink
- section4_() - Method in interface org.apache.maven.doxia.sink.Sink
-
Ends a 4th heading element.
- section5() - Method in class org.apache.maven.doxia.sink.impl.AbstractSink
- section5() - Method in interface org.apache.maven.doxia.sink.Sink
-
Starts a 5th heading element which contains the topic of the section.
- Section5(int, String) - Constructor for class org.apache.maven.doxia.module.apt.AptParser.Section5
-
Constructor.
- SECTION5 - Static variable in class org.apache.maven.doxia.module.apt.AptParser
-
Section 5 event id
- section5_() - Method in class org.apache.maven.doxia.sink.impl.AbstractSink
- section5_() - Method in interface org.apache.maven.doxia.sink.Sink
-
Ends a 5th heading element.
- section6() - Method in class org.apache.maven.doxia.sink.impl.AbstractSink
- section6() - Method in interface org.apache.maven.doxia.sink.Sink
-
Starts a 6th heading element which contains the topic of the section.
- section6_() - Method in class org.apache.maven.doxia.sink.impl.AbstractSink
- section6_() - Method in interface org.apache.maven.doxia.sink.Sink
-
Ends a 6th heading element.
- sectionLevel - Variable in enum org.apache.maven.doxia.index.IndexEntry.Type
- sectionLevel - Variable in class org.apache.maven.doxia.parser.Xhtml5BaseParser
-
Counts section nesting level of the sections manually set in the HTML document
- SECTIONS - Static variable in interface org.apache.maven.doxia.sink.SinkEventAttributes
-
Specifies the semantics of an element.
- sectionTitle() - Method in class org.apache.maven.doxia.sink.impl.AbstractSink
- sectionTitle() - Method in interface org.apache.maven.doxia.sink.Sink
-
Starts a title heading element.
- sectionTitle(int, SinkEventAttributes) - Method in class org.apache.maven.doxia.module.apt.AptSink
- sectionTitle(int, SinkEventAttributes) - Method in class org.apache.maven.doxia.module.markdown.MarkdownSink
- sectionTitle(int, SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
-
Start a new section title at the given level.
- 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
-
Start a new section title at the given level.
- sectionTitle(int, SinkEventAttributes) - Method in interface org.apache.maven.doxia.sink.Sink
-
Start a new section title at the given level.
- sectionTitle_() - Method in class org.apache.maven.doxia.sink.impl.AbstractSink
- sectionTitle_() - Method in interface org.apache.maven.doxia.sink.Sink
-
Ends a title heading element.
- sectionTitle_(int) - Method in class org.apache.maven.doxia.index.IndexingSink
- sectionTitle_(int) - Method in class org.apache.maven.doxia.module.apt.AptSink
- sectionTitle_(int) - Method in class org.apache.maven.doxia.module.markdown.MarkdownSink
- sectionTitle_(int) - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
-
Ends a section title at the given level.
- sectionTitle_(int) - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
- sectionTitle_(int) - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
-
Ends a section title at the given level.
- sectionTitle_(int) - Method in interface org.apache.maven.doxia.sink.Sink
-
Ends a section title at the given level.
- sectionTitle1() - Method in class org.apache.maven.doxia.sink.impl.AbstractSink
- sectionTitle1() - Method in interface org.apache.maven.doxia.sink.Sink
-
Starts a first title heading element.
- sectionTitle1_() - Method in class org.apache.maven.doxia.sink.impl.AbstractSink
- sectionTitle1_() - Method in interface org.apache.maven.doxia.sink.Sink
-
Ends a first title heading element.
- sectionTitle2() - Method in class org.apache.maven.doxia.sink.impl.AbstractSink
- sectionTitle2() - Method in interface org.apache.maven.doxia.sink.Sink
-
Starts a second title heading element.
- sectionTitle2_() - Method in class org.apache.maven.doxia.sink.impl.AbstractSink
- sectionTitle2_() - Method in interface org.apache.maven.doxia.sink.Sink
-
Ends a second title heading element.
- sectionTitle3() - Method in class org.apache.maven.doxia.sink.impl.AbstractSink
- sectionTitle3() - Method in interface org.apache.maven.doxia.sink.Sink
-
Starts a third title heading element.
- sectionTitle3_() - Method in class org.apache.maven.doxia.sink.impl.AbstractSink
- sectionTitle3_() - Method in interface org.apache.maven.doxia.sink.Sink
-
Ends a third title heading element.
- sectionTitle4() - Method in class org.apache.maven.doxia.sink.impl.AbstractSink
- sectionTitle4() - Method in interface org.apache.maven.doxia.sink.Sink
-
Starts a 4th title heading element.
- sectionTitle4_() - Method in class org.apache.maven.doxia.sink.impl.AbstractSink
- sectionTitle4_() - Method in interface org.apache.maven.doxia.sink.Sink
-
Ends a 4th title heading element.
- sectionTitle5() - Method in class org.apache.maven.doxia.sink.impl.AbstractSink
- sectionTitle5() - Method in interface org.apache.maven.doxia.sink.Sink
-
Starts a 5th title heading element.
- sectionTitle5_() - Method in class org.apache.maven.doxia.sink.impl.AbstractSink
- sectionTitle5_() - Method in interface org.apache.maven.doxia.sink.Sink
-
Ends a 5th title heading element.
- sectionTitle6() - Method in class org.apache.maven.doxia.sink.impl.AbstractSink
- sectionTitle6() - Method in interface org.apache.maven.doxia.sink.Sink
-
Starts a 6th title heading element.
- sectionTitle6_() - Method in class org.apache.maven.doxia.sink.impl.AbstractSink
- sectionTitle6_() - Method in interface org.apache.maven.doxia.sink.Sink
-
Ends a 6th title heading element.
- 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
- SEMANTICS - Static variable in interface org.apache.maven.doxia.sink.SinkEventAttributes
-
Specifies the semantics of an element.
- SEMICOLON - Static variable in interface org.apache.maven.doxia.markup.Markup
-
semicolon character: ';'
- serialVersionUID - Static variable in exception class org.apache.maven.doxia.macro.MacroExecutionException
-
serialVersionUID
- serialVersionUID - Static variable in exception class org.apache.maven.doxia.macro.manager.MacroNotFoundException
-
serialVersionUID
- serialVersionUID - Static variable in exception class org.apache.maven.doxia.module.apt.AptParseException
-
serialVersionUID
- serialVersionUID - Static variable in exception class org.apache.maven.doxia.parser.manager.ParserNotFoundException
-
serialVersionUID
- serialVersionUID - Static variable in exception class org.apache.maven.doxia.parser.module.ParserModuleNotFoundException
- serialVersionUID - Static variable in exception class org.apache.maven.doxia.parser.ParseException
-
serialVersionUID
- 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.
- setAnswer(String) - Method in class org.apache.maven.doxia.module.fml.model.Faq
-
Set the answer.
- 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
- setDocumentLocator(Locator) - Method in interface org.apache.maven.doxia.sink.Sink
-
Sets the locator which exposes location information for a particular Sink event.
- 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
- setEntryId(IndexEntry, String) - Method in class org.apache.maven.doxia.index.IndexingSink
- setFaqs(List<Faq>) - Method in class org.apache.maven.doxia.module.fml.model.Part
-
Set a list of FAQ.
- setHeadFlag(boolean) - Method in class org.apache.maven.doxia.module.apt.AptSink
-
Used to determine whether we are in head mode.
- setHeadFlag(boolean) - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
-
Setter for the field
headFlag
. - setHeadTitleFlag(boolean) - Method in class org.apache.maven.doxia.module.xhtml5.Xhtml5Sink
-
Setter for the field
headTitleFlag
. - setId(String) - Method in class org.apache.maven.doxia.index.IndexEntry
-
Set the id.
- setId(String) - Method in class org.apache.maven.doxia.module.fml.model.Faq
-
Set the FAQ identifier.
- setId(String) - Method in class org.apache.maven.doxia.module.fml.model.Part
-
Set the identifier of the part.
- 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
. - setModelEncoding(String) - Method in class org.apache.maven.doxia.module.fml.model.Faqs
-
Set the modelEncoding field.
- 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.
- setParts(List<Part>) - Method in class org.apache.maven.doxia.module.fml.model.Faqs
-
Set list of FAQ part.
- setQuestion(String) - Method in class org.apache.maven.doxia.module.fml.model.Faq
-
Set the question.
- 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.
- setTitle(String) - Method in class org.apache.maven.doxia.module.fml.model.Faqs
-
Set the title name of this FAQ.
- setTitle(String) - Method in class org.apache.maven.doxia.module.fml.model.Part
-
Set the title of the FAQ part.
- setToplink(boolean) - Method in class org.apache.maven.doxia.module.fml.model.Faqs
-
Set boolean to generate optionally [top] links.
- 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
- SHAPE - Static variable in interface org.apache.maven.doxia.sink.SinkEventAttributes
-
Defines the type of region to be defined for a mapping.
- sidebar() - Method in class org.apache.maven.doxia.sink.impl.AbstractSink
- sidebar() - Method in interface org.apache.maven.doxia.sink.Sink
-
Starts a sidebar section within a document.
- sidebar(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
-
Starts a sidebar section within a document.
- sidebar(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
- sidebar(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
-
Starts a sidebar section within a document.
- sidebar(SinkEventAttributes) - Method in interface org.apache.maven.doxia.sink.Sink
-
Starts a sidebar section within a document.
- sidebar_() - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
-
Ends the sidebar element.
- sidebar_() - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
- sidebar_() - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
-
Ends the sidebar element.
- sidebar_() - Method in interface org.apache.maven.doxia.sink.Sink
-
Ends the sidebar element.
- sink - Variable in class org.apache.maven.doxia.module.apt.AptParser
-
the sink to receive the events.
- sink - Variable in class org.apache.maven.doxia.sink.impl.EventCapturingSinkProxy
- Sink - Interface in org.apache.maven.doxia.sink
-
A Sink consumes Doxia events to produce a resultant output format (eg Docbook, PDF, XHTML...).
- 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
- SinkEventAttributes - Interface in org.apache.maven.doxia.sink
-
A set of attributes for a sink event.
- 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.
- sinkFactory - Variable in class org.apache.maven.doxia.sink.impl.RandomAccessSink
-
Deprecated.
- SinkFactory - Interface in org.apache.maven.doxia.sink
-
A factory that creates a
Sink
object. - sinks - Variable in class org.apache.maven.doxia.sink.impl.RandomAccessSink
-
Deprecated.
- SinkUtils - Class in org.apache.maven.doxia.sink.impl
-
Collection of common utility methods for sinks.
- SinkUtils() - Constructor for class org.apache.maven.doxia.sink.impl.SinkUtils
-
Do not instantiate.
- 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
SinkWrapperFactory
s so that the one with the highest priority comes first (i.e. - SinkWrapperFactoryComparator() - Constructor for class org.apache.maven.doxia.sink.impl.SinkWrapperFactoryComparator
- SIZE - Static variable in interface org.apache.maven.doxia.sink.SinkEventAttributes
-
Specifies the size, or thickness, or height of an event element.
- skipFromLeftToRightBracket(int) - Method in class org.apache.maven.doxia.module.apt.AptParser.Block
-
Skip brackets.
- skipItemNumber() - Method in class org.apache.maven.doxia.module.apt.AptParser.NumberedListItem
-
skipItemNumber.
- skipLeadingBullets() - Method in class org.apache.maven.doxia.module.apt.AptParser.Block
-
Skip spaces.
- skipSpace(String, int, int) - Static method in class org.apache.maven.doxia.module.apt.AptParser
-
Skip spaces.
- skipSpaceFrom(int) - Method in class org.apache.maven.doxia.module.apt.AptParser.Block
-
Skip spaces.
- skipTraversedLinkAnchor(String, int, int, StringBuilder) - Static method in class org.apache.maven.doxia.module.apt.AptParser
-
Parse the given text.
- 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) - Constructor for class org.apache.maven.doxia.macro.snippet.SnippetReader
-
Constructor.
- SnippetReader(URL, String) - Constructor for class org.apache.maven.doxia.macro.snippet.SnippetReader
-
Constructor.
- source - Variable in class org.apache.maven.doxia.macro.snippet.SnippetReader
-
The source.
- source - Variable in class org.apache.maven.doxia.module.apt.AptParser
-
the AptSource.
- source - Variable in class org.apache.maven.doxia.module.apt.AptParser.Verbatim
-
source.
- source - Variable in class org.apache.maven.doxia.module.xhtml5.Xhtml5Parser
-
For verbatim source.
- 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.
- SOURCE_TAG - Static variable in interface org.apache.maven.doxia.module.fml.FmlMarkup
-
Fml tag for
source
- SOURCE_TAG - Static variable in interface org.apache.maven.doxia.module.xdoc.XdocMarkup
-
Xdoc tag for
source
- sourceContent - Variable in class org.apache.maven.doxia.module.apt.AptParser
-
sourceContent.
- sourceContent - Variable in class org.apache.maven.doxia.module.fml.FmlParser
-
The source content of the input reader.
- sourceContent - Variable in class org.apache.maven.doxia.module.xdoc.XdocParser
-
The source content of the input reader.
- sourceContent - Variable in class org.apache.maven.doxia.module.xhtml5.Xhtml5Parser
-
The source content of the input reader.
- sourceDirectory - Variable in class org.apache.maven.doxia.parser.module.AbstractParserModule
-
The source directory.
- sourceName - Variable in class org.apache.maven.doxia.parser.Xhtml1BaseParser.AttributeMapping
- SPACE - Static variable in interface org.apache.maven.doxia.markup.Markup
-
space character: ' '
- SPACES - Static variable in class org.apache.maven.doxia.module.apt.AptParser
-
An array of 85 spaces.
- SPAN - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
-
HTML5 tag for
span
. - SRC - Static variable in interface org.apache.maven.doxia.sink.SinkEventAttributes
-
The URL of an external resource, eg an image.
- stack - Variable in class org.apache.maven.doxia.index.IndexingSink
-
The stack.
- STAR - Static variable in interface org.apache.maven.doxia.markup.Markup
-
star character: '*'
- startBlock(boolean) - Method in class org.apache.maven.doxia.module.markdown.MarkdownSink
- startContext(MarkdownSink.ElementContext) - Method in class org.apache.maven.doxia.module.markdown.MarkdownSink
- startFlag - Variable in class org.apache.maven.doxia.module.apt.AptSink
-
startFlag.
- 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
. - STYLE - Static variable in interface org.apache.maven.doxia.sink.SinkEventAttributes
-
An inline style definition.
- 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.
- SUBSECTION_TAG - Static variable in interface org.apache.maven.doxia.module.xdoc.XdocMarkup
-
Xdoc tag for
subsection
- SUMMARY - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
-
HTML5 tag for
summary
. - SUMMARY - Static variable in interface org.apache.maven.doxia.sink.SinkEventAttributes
-
Specifies a summary of an event attribute for speech-synthesizing/non-visual target output.
- 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
- TAB - Static variable in interface org.apache.maven.doxia.module.apt.AptMarkup
-
APT tab markup char: '\t'
- TAB_WIDTH - Static variable in class org.apache.maven.doxia.module.apt.AptParser
-
Default tab width.
- table() - Method in class org.apache.maven.doxia.sink.impl.AbstractSink
- table() - Method in interface org.apache.maven.doxia.sink.Sink
-
Starts a table element for marking up tabular information in a document.
- table(SinkEventAttributes) - Method in class org.apache.maven.doxia.module.apt.AptSink
- table(SinkEventAttributes) - Method in class org.apache.maven.doxia.module.markdown.MarkdownSink
- table(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
-
Starts a table.
- table(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
- table(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
-
Starts a table.
- table(SinkEventAttributes) - Method in interface org.apache.maven.doxia.sink.Sink
-
Starts a table.
- Table(int, String) - Constructor for class org.apache.maven.doxia.module.apt.AptParser.Table
-
Constructor.
- TABLE - Enum constant in enum org.apache.maven.doxia.index.IndexEntry.Type
- TABLE - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
-
HTML5 tag for
table
. - TABLE - Static variable in class org.apache.maven.doxia.module.apt.AptParser
-
Table event id
- table_() - Method in class org.apache.maven.doxia.module.apt.AptSink
-
Ends a table element.
- table_() - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
-
Ends a table element.
- table_() - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
- table_() - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
-
Ends a table element.
- table_() - Method in interface org.apache.maven.doxia.sink.Sink
-
Ends a table element.
- TABLE_ATTRIBUTES - Static variable in class org.apache.maven.doxia.sink.impl.SinkUtils
- TABLE_CAPTION - Enum constant in enum org.apache.maven.doxia.module.markdown.MarkdownSink.ElementContext
- TABLE_CELL - Enum constant in enum org.apache.maven.doxia.module.markdown.MarkdownSink.ElementContext
- TABLE_CELL_ATTRIBUTES - Static variable in class org.apache.maven.doxia.sink.impl.SinkUtils
- TABLE_CELL_SEPARATOR_MARKUP - Static variable in interface org.apache.maven.doxia.module.apt.AptMarkup
-
Syntax for the table cell start: "|"
- TABLE_CELL_SEPARATOR_MARKUP - Static variable in interface org.apache.maven.doxia.module.markdown.MarkdownMarkup
-
Syntax for the table cell start: "|"
- TABLE_COL_CENTER_ALIGNED_MARKUP - Static variable in interface org.apache.maven.doxia.module.markdown.MarkdownMarkup
-
Syntax for the table column, center alignment: ":---:"
- TABLE_COL_CENTERED_ALIGNED_MARKUP - Static variable in interface org.apache.maven.doxia.module.apt.AptMarkup
-
Syntax for the table column, centered style: "-*"
- TABLE_COL_LEFT_ALIGNED_MARKUP - Static variable in interface org.apache.maven.doxia.module.apt.AptMarkup
-
Syntax for the table column, left style: "-+"
- TABLE_COL_LEFT_ALIGNED_MARKUP - Static variable in interface org.apache.maven.doxia.module.markdown.MarkdownMarkup
-
Syntax for the table column, left alignment (default): "---"
- TABLE_COL_RIGHT_ALIGNED_MARKUP - Static variable in interface org.apache.maven.doxia.module.apt.AptMarkup
-
Syntax for the table column, right style: "-:"
- TABLE_COL_RIGHT_ALIGNED_MARKUP - Static variable in interface org.apache.maven.doxia.module.markdown.MarkdownMarkup
-
Syntax for the table column, right alignment: "---:"
- TABLE_ROW_PREFIX - Static variable in interface org.apache.maven.doxia.module.markdown.MarkdownMarkup
-
Syntax for the table row prefix (the other separators in the same row are regular
MarkdownMarkup.TABLE_CELL_SEPARATOR_MARKUP
characters) - TABLE_ROW_SEPARATOR_MARKUP - Static variable in interface org.apache.maven.doxia.module.apt.AptMarkup
-
Syntax for the table row end: "|"
- TABLE_ROW_START_MARKUP - Static variable in interface org.apache.maven.doxia.module.apt.AptMarkup
-
Syntax for the table row start: "*--"
- 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() - Method in interface org.apache.maven.doxia.sink.Sink
-
Starts a caption element of a table.
- tableCaption(SinkEventAttributes) - Method in class org.apache.maven.doxia.module.apt.AptSink
- tableCaption(SinkEventAttributes) - Method in class org.apache.maven.doxia.module.markdown.MarkdownSink
- tableCaption(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
-
Starts a table caption.
- tableCaption(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
- tableCaption(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
-
Starts a table caption.
- tableCaption(SinkEventAttributes) - Method in interface org.apache.maven.doxia.sink.Sink
-
Starts a table caption.
- tableCaption_() - Method in class org.apache.maven.doxia.module.apt.AptSink
-
Ends a caption element of a table.
- tableCaption_() - Method in class org.apache.maven.doxia.module.markdown.MarkdownSink
- tableCaption_() - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
-
Ends a caption element of a table.
- tableCaption_() - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
- tableCaption_() - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
-
Ends a caption element of a table.
- tableCaption_() - Method in interface org.apache.maven.doxia.sink.Sink
-
Ends a caption element of a table.
- tableCaptionBuffer - Variable in class org.apache.maven.doxia.module.apt.AptSink
-
A buffer that holds the table caption.
- tableCaptionFlag - Variable in class org.apache.maven.doxia.module.apt.AptSink
-
tableCaptionFlag.
- tableCaptionStack - Variable in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
-
The stack of table caption
- tableCaptionWriterStack - Variable in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
- tableCaptionXMLWriterStack - Variable in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
- tableCell() - Method in class org.apache.maven.doxia.sink.impl.AbstractSink
- tableCell() - Method in interface org.apache.maven.doxia.sink.Sink
-
Starts a cell element which defines a cell that contains data.
- tableCell(boolean) - Method in class org.apache.maven.doxia.module.apt.AptSink
-
Starts a table cell.
- tableCell(boolean, MutableAttributeSet) - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
- tableCell(SinkEventAttributes) - Method in class org.apache.maven.doxia.module.apt.AptSink
- tableCell(SinkEventAttributes) - Method in class org.apache.maven.doxia.module.markdown.MarkdownSink
- tableCell(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
-
Starts a table cell.
- tableCell(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
- tableCell(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
-
Starts a table cell.
- tableCell(SinkEventAttributes) - Method in interface org.apache.maven.doxia.sink.Sink
-
Starts a table cell.
- tableCell_() - Method in class org.apache.maven.doxia.module.apt.AptSink
-
Ends a cell element.
- tableCell_() - Method in class org.apache.maven.doxia.module.markdown.MarkdownSink
- tableCell_() - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
-
Ends a cell element.
- tableCell_() - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
- tableCell_() - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
-
Ends a cell element.
- tableCell_() - Method in interface org.apache.maven.doxia.sink.Sink
-
Ends a cell element.
- tableCell_(boolean) - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
-
Ends a table cell.
- tableCellFlag - Variable in class org.apache.maven.doxia.module.apt.AptSink
-
tableCellFlag.
- tableContentWriterStack - Variable in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
-
The stack of StringWriter to write the table result temporary, so we could play with the output DOXIA-177.
- tableHeaderCell() - Method in class org.apache.maven.doxia.sink.impl.AbstractSink
- tableHeaderCell() - Method in interface org.apache.maven.doxia.sink.Sink
-
Starts a cell element which defines a cell that contains header information.
- tableHeaderCell(SinkEventAttributes) - Method in class org.apache.maven.doxia.module.apt.AptSink
- tableHeaderCell(SinkEventAttributes) - Method in class org.apache.maven.doxia.module.markdown.MarkdownSink
- tableHeaderCell(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
-
Starts a table header cell.
- tableHeaderCell(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
- tableHeaderCell(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
-
Starts a table header cell.
- tableHeaderCell(SinkEventAttributes) - Method in interface org.apache.maven.doxia.sink.Sink
-
Starts a table header cell.
- tableHeaderCell_() - Method in class org.apache.maven.doxia.module.apt.AptSink
-
Ends a cell header element.
- tableHeaderCell_() - Method in class org.apache.maven.doxia.module.markdown.MarkdownSink
- tableHeaderCell_() - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
-
Ends a cell header element.
- tableHeaderCell_() - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
- tableHeaderCell_() - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
-
Ends a cell header element.
- tableHeaderCell_() - Method in interface org.apache.maven.doxia.sink.Sink
-
Ends a cell header element.
- tableHeaderCellFlag - Variable in class org.apache.maven.doxia.module.markdown.MarkdownSink
-
tableHeaderCellFlag, set to
true
for table rows containing at least one table header cell - tableRow() - Method in class org.apache.maven.doxia.sink.impl.AbstractSink
- tableRow() - Method in interface org.apache.maven.doxia.sink.Sink
-
Starts a row element which acts as a container for a row of table cells.
- tableRow(SinkEventAttributes) - Method in class org.apache.maven.doxia.module.apt.AptSink
- tableRow(SinkEventAttributes) - Method in class org.apache.maven.doxia.module.markdown.MarkdownSink
- tableRow(SinkEventAttributes) - Method in class org.apache.maven.doxia.module.xdoc.XdocSink
-
Rows are striped with two colors by adding the class
a
orb
. - tableRow(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
-
Starts a table row.
- 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
orb
. - tableRow(SinkEventAttributes) - Method in interface org.apache.maven.doxia.sink.Sink
-
Starts a table row.
- tableRow_() - Method in class org.apache.maven.doxia.module.apt.AptSink
-
Ends a row element.
- tableRow_() - Method in class org.apache.maven.doxia.module.markdown.MarkdownSink
- tableRow_() - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
-
Ends a row element.
- tableRow_() - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
- tableRow_() - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
-
Ends a row element.
- tableRow_() - Method in interface org.apache.maven.doxia.sink.Sink
-
Ends a row element.
- tableRows() - Method in class org.apache.maven.doxia.sink.impl.AbstractSink
- tableRows() - Method in interface org.apache.maven.doxia.sink.Sink
-
Starts an element that contains rows of table data.
- tableRows(int[], boolean) - Method in class org.apache.maven.doxia.module.apt.AptSink
- tableRows(int[], boolean) - Method in class org.apache.maven.doxia.module.markdown.MarkdownSink
- tableRows(int[], boolean) - Method in class org.apache.maven.doxia.module.xdoc.XdocSink
-
The default style class is
bodyTable
. - tableRows(int[], boolean) - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
-
Starts an element that contains rows of table data.
- 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(int[], boolean) - Method in interface org.apache.maven.doxia.sink.Sink
-
Starts an element that contains rows of table data.
- tableRows_() - Method in class org.apache.maven.doxia.module.apt.AptSink
-
Ends an element that contains rows of table data.
- tableRows_() - Method in class org.apache.maven.doxia.module.markdown.MarkdownSink
- tableRows_() - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
-
Ends an element that contains rows of table data.
- tableRows_() - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
- tableRows_() - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
-
Ends an element that contains rows of table data.
- tableRows_() - Method in interface org.apache.maven.doxia.sink.Sink
-
Ends an element that contains rows of table data.
- TAG_MAP - Static variable in class org.apache.maven.doxia.util.HtmlTools
- 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.
- TARGET - Static variable in interface org.apache.maven.doxia.sink.SinkEventAttributes
-
Where to open the target URL.
- targetName - Variable in class org.apache.maven.doxia.parser.Xhtml1BaseParser.AttributeMapping
- 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 - Variable in class org.apache.maven.doxia.module.apt.AptParser.Block
-
text.
- text(String) - Method in class org.apache.maven.doxia.sink.impl.AbstractSink
- text(String) - Method in interface org.apache.maven.doxia.sink.Sink
-
Adding a text.
- text(String, SinkEventAttributes) - Method in class org.apache.maven.doxia.index.IndexingSink
- text(String, SinkEventAttributes) - Method in class org.apache.maven.doxia.module.apt.AptSink
- text(String, SinkEventAttributes) - Method in class org.apache.maven.doxia.module.markdown.MarkdownSink
- text(String, SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
-
Adds a text.
- 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
-
Adds a text.
- text(String, SinkEventAttributes) - Method in interface org.apache.maven.doxia.sink.Sink
-
Adds a text.
- TEXTAREA - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
-
HTML5 tag for
textarea
. - textBuffer - Variable in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
-
Used to collect text events mainly for the head events.
- textLength - Variable in class org.apache.maven.doxia.module.apt.AptParser.Block
-
textLength.
- 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(String) - Method in class org.apache.maven.doxia.sink.impl.AbstractSink
- time(String) - Method in interface org.apache.maven.doxia.sink.Sink
-
Starts a time element which groups together other elements representing a time.
- time(String, SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
-
Starts a time element which groups together other elements representing a time.
- 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
-
Starts a time element which groups together other elements representing a time.
- time(String, SinkEventAttributes) - Method in interface org.apache.maven.doxia.sink.Sink
-
Starts a time element which groups together other elements representing a time.
- TIME - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
-
HTML5 tag for
time
. - time_() - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
-
Ends a time element.
- time_() - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
- time_() - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
-
Ends a time element.
- time_() - Method in interface org.apache.maven.doxia.sink.Sink
-
Ends a time element.
- timeCached - Static variable in class org.apache.maven.doxia.macro.snippet.SnippetMacro
-
Holds the time cache.
- timeInCache(URL, String) - Method in class org.apache.maven.doxia.macro.snippet.SnippetMacro
-
Return the time the snippet has been cached.
- timeout - Variable in class org.apache.maven.doxia.macro.snippet.SnippetMacro
-
One hour default cache.
- title - Variable in class org.apache.maven.doxia.index.IndexEntry
-
The entry title.
- title - Variable in class org.apache.maven.doxia.module.apt.AptSink
-
title.
- title - Variable in class org.apache.maven.doxia.module.fml.model.Faqs
-
The title name of this FAQ.
- title - Variable in class org.apache.maven.doxia.module.fml.model.Part
-
The title of the FAQ part.
- title - Variable in class org.apache.maven.doxia.module.markdown.MarkdownSink
-
title.
- title() - Method in class org.apache.maven.doxia.sink.impl.AbstractSink
- title() - Method in interface org.apache.maven.doxia.sink.Sink
-
Starts the title element.
- title(SinkEventAttributes) - Method in class org.apache.maven.doxia.index.IndexingSink
- title(SinkEventAttributes) - Method in class org.apache.maven.doxia.module.xdoc.XdocSink
-
Starts the title element.
- title(SinkEventAttributes) - Method in class org.apache.maven.doxia.module.xhtml5.Xhtml5Sink
-
Starts the title element.
- title(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
-
Starts the title element.
- title(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
- title(SinkEventAttributes) - Method in interface org.apache.maven.doxia.sink.Sink
-
Starts the title element.
- Title(int, String) - Constructor for class org.apache.maven.doxia.module.apt.AptParser.Title
-
Constructor.
- Title() - Method in class org.apache.maven.doxia.module.apt.AptParser.Section
-
Start a title.
- Title() - Method in class org.apache.maven.doxia.module.apt.AptParser.Section1
-
Start a title.
- Title() - Method in class org.apache.maven.doxia.module.apt.AptParser.Section2
-
Start a title.
- Title() - Method in class org.apache.maven.doxia.module.apt.AptParser.Section3
-
Start a title.
- Title() - Method in class org.apache.maven.doxia.module.apt.AptParser.Section4
-
Start a title.
- Title() - Method in class org.apache.maven.doxia.module.apt.AptParser.Section5
-
Start a title.
- TITLE - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
-
HTML5 tag for
title
. - TITLE - Static variable in class org.apache.maven.doxia.module.apt.AptParser
-
Title event id
- TITLE - Static variable in interface org.apache.maven.doxia.sink.SinkEventAttributes
-
A text to display in a tool tip.
- title_() - Method in class org.apache.maven.doxia.index.IndexingSink
- title_() - Method in class org.apache.maven.doxia.module.apt.AptSink
-
Ends the title element.
- title_() - Method in class org.apache.maven.doxia.module.markdown.MarkdownSink
- title_() - Method in class org.apache.maven.doxia.module.xdoc.XdocSink
-
Ends the title element.
- title_() - Method in class org.apache.maven.doxia.module.xhtml5.Xhtml5Sink
-
Ends the title element.
- title_() - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
-
Ends the title element.
- title_() - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
- title_() - Method in interface org.apache.maven.doxia.sink.Sink
-
Ends the title element.
- Title_() - Method in class org.apache.maven.doxia.module.apt.AptParser.Section
-
End a title.
- Title_() - Method in class org.apache.maven.doxia.module.apt.AptParser.Section1
-
End a title.
- Title_() - Method in class org.apache.maven.doxia.module.apt.AptParser.Section2
-
End a title.
- Title_() - Method in class org.apache.maven.doxia.module.apt.AptParser.Section3
-
End a title.
- Title_() - Method in class org.apache.maven.doxia.module.apt.AptParser.Section4
-
End a title.
- Title_() - Method in class org.apache.maven.doxia.module.apt.AptParser.Section5
-
End a title.
- toByteArray(URL) - Static method in class org.apache.maven.doxia.parser.AbstractXmlParser.CachedFileEntityResolver
- 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 givenSink
. - TocMacro() - Constructor for class org.apache.maven.doxia.macro.toc.TocMacro
- toCodePoint(char, char) - Static method in class org.apache.maven.doxia.util.HtmlTools
- toDepth - Variable in class org.apache.maven.doxia.macro.toc.TocMacro
-
End depth.
- toHtml(Reader) - Method in class org.apache.maven.doxia.module.markdown.MarkdownParser
-
uses flexmark-java library to parse content and generate HTML output.
- toplink - Variable in class org.apache.maven.doxia.module.fml.model.Faqs
-
Boolean to generate optionally [top] links.
- toString() - Method in class org.apache.maven.doxia.index.IndexEntry
-
Returns a string representation of the object.
- toString() - Method in class org.apache.maven.doxia.module.fml.model.Faq
-
Method toString.
- toString() - Method in class org.apache.maven.doxia.module.fml.model.Faqs
-
Method toString.
- toString() - Method in class org.apache.maven.doxia.module.fml.model.Part
-
Method toString.
- toString() - Method in class org.apache.maven.doxia.sink.impl.SinkEventAttributeSet
- toString(int) - Method in class org.apache.maven.doxia.index.IndexEntry
-
Returns a string representation of all objects to the given depth.
- 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
. - traverse() - Method in class org.apache.maven.doxia.module.apt.AptParser.Block
-
Parse the block.
- traverse() - Method in class org.apache.maven.doxia.module.apt.AptParser.Comment
-
Parse the block.
- traverse() - Method in class org.apache.maven.doxia.module.apt.AptParser.DefinitionListItem
-
Parse the block.
- traverse() - Method in class org.apache.maven.doxia.module.apt.AptParser.Figure
-
Parse the block.
- traverse() - Method in class org.apache.maven.doxia.module.apt.AptParser.HorizontalRule
-
Parse the block.
- traverse() - Method in class org.apache.maven.doxia.module.apt.AptParser.ListBreak
-
Parse the block.
- traverse() - Method in class org.apache.maven.doxia.module.apt.AptParser.ListItem
-
Parse the block.
- traverse() - Method in class org.apache.maven.doxia.module.apt.AptParser.MacroBlock
-
Parse the block.
- traverse() - Method in class org.apache.maven.doxia.module.apt.AptParser.NumberedListItem
-
Parse the block.
- traverse() - Method in class org.apache.maven.doxia.module.apt.AptParser.PageBreak
-
Parse the block.
- traverse() - Method in class org.apache.maven.doxia.module.apt.AptParser.Paragraph
-
Parse the block.
- traverse() - Method in class org.apache.maven.doxia.module.apt.AptParser.Section
-
Parse the block.
- traverse() - Method in class org.apache.maven.doxia.module.apt.AptParser.Table
-
Parse the block.
- traverse() - Method in class org.apache.maven.doxia.module.apt.AptParser.Title
-
Parse the block.
- traverse() - Method in class org.apache.maven.doxia.module.apt.AptParser.Verbatim
-
Parse the block.
- traverseBody() - Method in class org.apache.maven.doxia.module.apt.AptParser
-
Parse the body of the Apt source document.
- traverseDefinitionList() - Method in class org.apache.maven.doxia.module.apt.AptParser
-
Parse a definition list of the Apt source document.
- traverseHead() - Method in class org.apache.maven.doxia.module.apt.AptParser
-
Parse the head of the Apt source document.
- traverseList() - Method in class org.apache.maven.doxia.module.apt.AptParser
-
Parse a list of the Apt source document.
- traverseNumberedList() - Method in class org.apache.maven.doxia.module.apt.AptParser
-
Parse a numbered list of the Apt source document.
- traverseRow(StringBuilder[], boolean[], int[]) - Method in class org.apache.maven.doxia.module.apt.AptParser.Table
-
Traverse a table row.
- traverseSection(int) - Method in class org.apache.maven.doxia.module.apt.AptParser
-
Parse a section of the Apt source document.
- traverseSectionBlocks() - Method in class org.apache.maven.doxia.module.apt.AptParser
-
Parse the section blocks of the Apt source document.
- traverseText(int) - Method in class org.apache.maven.doxia.module.apt.AptParser.Block
-
Traverse the text.
- traverseText(int, int) - Method in class org.apache.maven.doxia.module.apt.AptParser.Block
-
Traverse the text.
- trimmableWhitespace - Variable in class org.apache.maven.doxia.parser.AbstractXmlParser
- TXT_TYPE - Static variable in interface org.apache.maven.doxia.parser.Parser
-
Text parser type
- type - Variable in class org.apache.maven.doxia.index.IndexEntry
-
The type of the entry, one of the types defined by
IndexingSink
- type - Variable in class org.apache.maven.doxia.index.IndexingSink
-
The current type.
- type - Variable in class org.apache.maven.doxia.module.apt.AptParser.Block
-
type.
- type - Variable in enum org.apache.maven.doxia.module.markdown.MarkdownSink.ElementContext
-
true
if block element, otherwisefalse
for inline elements - Type() - Constructor for enum org.apache.maven.doxia.index.IndexEntry.Type
- Type() - Constructor for enum org.apache.maven.doxia.module.markdown.MarkdownSink.ElementContext.Type
- Type(int) - Constructor for enum org.apache.maven.doxia.index.IndexEntry.Type
- TYPE - Static variable in interface org.apache.maven.doxia.sink.SinkEventAttributes
-
Specifies the MIME (Multipurpose Internet Mail Extensions) type of an external resource URL, eg a link.
- TYPE_ERROR - Static variable in class org.apache.maven.doxia.util.XmlValidator.MessagesErrorHandler
- TYPE_FATAL - Static variable in class org.apache.maven.doxia.util.XmlValidator.MessagesErrorHandler
- TYPE_NAMES - Static variable in class org.apache.maven.doxia.module.apt.AptParser
-
String representations of event ids
- TYPE_UNKNOWN - Static variable in class org.apache.maven.doxia.util.XmlValidator.MessagesErrorHandler
- TYPE_WARNING - Static variable in class org.apache.maven.doxia.util.XmlValidator.MessagesErrorHandler
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.
- unescapeForMacro(String) - Method in class org.apache.maven.doxia.module.apt.AptParser.MacroBlock
-
unescapeForMacro
- unescapeForMacro(String) - Method in class org.apache.maven.doxia.module.xhtml5.Xhtml5Parser
-
unescapeForMacro
- 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.
- ungetted - Variable in class org.apache.maven.doxia.util.ByLineReaderSource
-
true
if ungetLine() was called and no getNextLine() was called - 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.module.apt.AptSink
-
Add an unknown event.
- unknown(String, Object[], SinkEventAttributes) - Method in class org.apache.maven.doxia.module.markdown.MarkdownSink
-
Add an unknown event.
- unknown(String, Object[], SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
-
Add an unknown event.
- 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(String, Object[], SinkEventAttributes) - Method in interface org.apache.maven.doxia.sink.Sink
-
Add an unknown event.
- UNKNOWN - Enum constant in enum org.apache.maven.doxia.index.IndexEntry.Type
-
Used for unknown types but also for the root entry
- UNKNOWN_TYPE - Static variable in interface org.apache.maven.doxia.parser.Parser
-
Unknown parser type
- UNMATCHED_XHTML5_ELEMENTS - Static variable in class org.apache.maven.doxia.parser.Xhtml5BaseParser
- UNMATCHED_XHTML5_SIMPLE_ELEMENTS - Static variable in class org.apache.maven.doxia.parser.Xhtml5BaseParser
- unmodifiable() - Method in class org.apache.maven.doxia.sink.impl.SinkEventAttributeSet
-
Replace this AttributeSet by an unmodifiable view of itself.
- usedAnchorNames - Variable in class org.apache.maven.doxia.sink.impl.UniqueAnchorNamesValidator
- usedIds - Variable in class org.apache.maven.doxia.index.IndexingSink
-
A map containing all used ids of index entries as key and how often they are used as value (0-based, i.e.
- USEMAP - Static variable in interface org.apache.maven.doxia.sink.SinkEventAttributes
-
Defines an image as a client-side image map.
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 - Variable in class org.apache.maven.doxia.parser.AbstractXmlParser
- validate - Variable in class org.apache.maven.doxia.util.XmlValidator
- validate(String) - Method in class org.apache.maven.doxia.util.XmlValidator
-
Validate an XML content with SAX.
- VALIGN - Static variable in interface org.apache.maven.doxia.sink.SinkEventAttributes
-
Specifies the vertical alignment of an element.
- VALUE - Static variable in interface org.apache.maven.doxia.sink.SinkEventAttributes
-
Specifies a value for the data element.
- valueMapper - Variable in class org.apache.maven.doxia.parser.Xhtml1BaseParser.AttributeMapping
- 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.module.markdown.MarkdownSink.ElementContext.Type
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.apache.maven.doxia.module.markdown.MarkdownSink.ElementContext
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.apache.maven.doxia.parser.Xhtml1BaseParser.AttributeMapping.MergeSemantics
-
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.module.markdown.MarkdownSink.ElementContext.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.module.markdown.MarkdownSink.ElementContext
-
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.parser.Xhtml1BaseParser.AttributeMapping.MergeSemantics
-
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() - Method in interface org.apache.maven.doxia.sink.Sink
-
Starts a verbatim block, ie a block where whitespace has semantic relevance.
- verbatim(SinkEventAttributes) - Method in class org.apache.maven.doxia.module.apt.AptSink
- verbatim(SinkEventAttributes) - Method in class org.apache.maven.doxia.module.markdown.MarkdownSink
- verbatim(SinkEventAttributes) - Method in class org.apache.maven.doxia.module.xdoc.XdocSink
-
Depending on whether the decoration attribute is "source" or not, this leads to either emitting
<pre><code>
or just<pre>
. - verbatim(SinkEventAttributes) - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
-
Starts a verbatim block, ie a block where whitespace has semantic relevance.
- 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
<pre><code>
or just<pre>
. - verbatim(SinkEventAttributes) - Method in interface org.apache.maven.doxia.sink.Sink
-
Starts a verbatim block, ie a block where whitespace has semantic relevance.
- Verbatim(int, String) - Constructor for class org.apache.maven.doxia.module.apt.AptParser.Verbatim
-
Constructor.
- VERBATIM - Static variable in class org.apache.maven.doxia.module.apt.AptParser
-
Verbatim event id
- verbatim_() - Method in class org.apache.maven.doxia.module.apt.AptSink
-
Ends a verbatim element.
- verbatim_() - Method in class org.apache.maven.doxia.module.markdown.MarkdownSink
- verbatim_() - Method in class org.apache.maven.doxia.module.xdoc.XdocSink
-
Ends a verbatim element.
- verbatim_() - Method in class org.apache.maven.doxia.parser.Xhtml5BaseParser
-
Stop verbatim mode.
- verbatim_() - Method in class org.apache.maven.doxia.sink.impl.SinkAdapter
-
Ends a verbatim element.
- verbatim_() - Method in class org.apache.maven.doxia.sink.impl.SinkWrapper
- verbatim_() - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
-
Ends a verbatim element.
- verbatim_() - Method in interface org.apache.maven.doxia.sink.Sink
-
Ends a verbatim element.
- VERBATIM_END_MARKUP - Static variable in interface org.apache.maven.doxia.module.apt.AptMarkup
-
Syntax for the verbatim end: "------"
- VERBATIM_END_MARKUP - Static variable in interface org.apache.maven.doxia.module.markdown.MarkdownMarkup
-
Syntax for the verbatim end: "```"
- VERBATIM_SOURCE_END_MARKUP - Static variable in interface org.apache.maven.doxia.module.apt.AptMarkup
-
Syntax for the verbatim source end: "+------+"
- VERBATIM_SOURCE_START_MARKUP - Static variable in interface org.apache.maven.doxia.module.apt.AptMarkup
-
Syntax for the verbatim source start: "+------+"
- VERBATIM_START_MARKUP - Static variable in interface org.apache.maven.doxia.module.apt.AptMarkup
-
Syntax for the verbatim start: "------"
- VERBATIM_START_MARKUP - Static variable in interface org.apache.maven.doxia.module.markdown.MarkdownMarkup
-
Syntax for the verbatim start: "```"
- verbatimContent(String) - Method in class org.apache.maven.doxia.module.apt.AptSink
-
Write Apt escaped text to output.
- verbatimContent(String) - Method in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
-
Write HTML escaped text to output.
- verbatimFlag - Variable in class org.apache.maven.doxia.module.apt.AptSink
-
verbatimFlag.
- verbatimMode - Variable in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
-
An indication on if we're in verbatim mode and if so, surrounded by which tags.
- VerbatimMode() - Constructor for enum org.apache.maven.doxia.sink.impl.Xhtml5BaseSink.VerbatimMode
- VIDEO - Static variable in interface org.apache.maven.doxia.markup.HtmlMarkup
-
HTML5 tag for
video
. - visit(YamlFrontMatterBlock) - Method in class org.apache.maven.doxia.module.markdown.YamlFrontMatterVisitor
- VSPACE - Static variable in interface org.apache.maven.doxia.sink.SinkEventAttributes
-
Defines white space on the top and bottom of the event element.
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
. - WELL_KNOWN_SYSTEM_IDS - Static variable in class org.apache.maven.doxia.parser.AbstractXmlParser.CachedFileEntityResolver
- WIDTH - Static variable in interface org.apache.maven.doxia.sink.SinkEventAttributes
-
Sets the width of an event element.
- word - Variable in class org.apache.maven.doxia.util.LineBreaker
-
The string buffer to store the current text.
- write(char[], int, int) - Method in class org.apache.maven.doxia.module.markdown.LastTwoLinesBufferingWriter
- write(String) - Method in class org.apache.maven.doxia.module.apt.AptSink
-
Write text to output.
- 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.
- writeEmptyTableHeader() - Method in class org.apache.maven.doxia.module.markdown.MarkdownSink
- 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.
- writeFaqs(Sink) - Method in class org.apache.maven.doxia.module.fml.FmlParser
-
Writes the faqs to the specified sink.
- writeHtmlMetadata(StringBuilder, String, List<String>) - Method in class org.apache.maven.doxia.module.markdown.MarkdownParser
- writeHtmlMetadata(StringBuilder, Map<String, List<String>>) - Method in class org.apache.maven.doxia.module.markdown.MarkdownParser
- writeImage(String, String) - Method in class org.apache.maven.doxia.module.markdown.MarkdownSink
- writer - Variable in class org.apache.maven.doxia.module.apt.AptSink
-
The writer to use.
- writer - Variable in class org.apache.maven.doxia.module.markdown.MarkdownSink
-
The writer to use.
- writer - Variable in class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
-
The PrintWriter to write the result.
- writer - Variable in class org.apache.maven.doxia.util.LineBreaker
-
The writer to use.
- 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.
- writeSubSectionN(Sink, IndexEntry, int) - Method in class org.apache.maven.doxia.macro.toc.TocMacro
-
This recursive method just skips index entries that are not sections (but still evaluates their children).
- writeTableDelimiterRow() - Method in class org.apache.maven.doxia.module.markdown.MarkdownSink
-
Emit the delimiter row which determines the alignment
- writeTocForIndexEntry(Sink, SinkEventAttributes, IndexEntry) - Method in class org.apache.maven.doxia.macro.toc.TocMacro
- writeTopLink(Sink) - Method in class org.apache.maven.doxia.module.fml.FmlParser
-
Writes a toplink element.
- writeUnescaped(String) - Method in class org.apache.maven.doxia.module.markdown.MarkdownSink
- writeWord() - Method in class org.apache.maven.doxia.util.LineBreaker
-
Writes the current StringBuilder to the writer.
X
- XDOC_NAMESPACE - Static variable in interface org.apache.maven.doxia.module.xdoc.XdocMarkup
-
XDOC namespace: "http://maven.apache.org/XDOC/2.0"
- XDOC_SYSTEM_ID - Static variable in interface org.apache.maven.doxia.module.xdoc.XdocMarkup
-
XDOC system id: "https://maven.apache.org/xsd/xdoc-2.0.xsd"
- XdocMarkup - Interface in org.apache.maven.doxia.module.xdoc
-
List of
Xdoc
markups. - XdocParser - Class in org.apache.maven.doxia.module.xdoc
-
Parse an xdoc model and emit events into the specified doxia Sink.
- XdocParser() - Constructor for class org.apache.maven.doxia.module.xdoc.XdocParser
- XdocParserModule - Class in org.apache.maven.doxia.module.xdoc
-
XdocParserModule class.
- XdocParserModule() - Constructor for class org.apache.maven.doxia.module.xdoc.XdocParserModule
-
Default constructor.
- XdocSink - Class in org.apache.maven.doxia.module.xdoc
-
Xdoc Sink implementation.
- XdocSink(Writer) - Constructor for class org.apache.maven.doxia.module.xdoc.XdocSink
-
Constructor, initialize the Writer.
- XdocSink(Writer, String) - Constructor for class org.apache.maven.doxia.module.xdoc.XdocSink
-
Constructor, initialize the Writer and tells which encoding is used.
- XdocSink(Writer, String, String) - Constructor for class org.apache.maven.doxia.module.xdoc.XdocSink
-
Constructor, initialize the Writer and tells which encoding and languageId are used.
- XdocSinkFactory - Class in org.apache.maven.doxia.module.xdoc
-
Xdoc implementation of the Sink factory.
- XdocSinkFactory() - Constructor for class org.apache.maven.doxia.module.xdoc.XdocSinkFactory
- 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
- Xhtml1BaseParser.AttributeMapping - Class in org.apache.maven.doxia.parser
- Xhtml1BaseParser.AttributeMapping.MergeSemantics - Enum in org.apache.maven.doxia.parser
- XHTML5_NAMESPACE - Static variable in interface org.apache.maven.doxia.module.xhtml5.Xhtml5Markup
-
XHTML5 namespace: "http://www.w3.org/1999/xhtml"
- 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
- Xhtml5Markup - Interface in org.apache.maven.doxia.module.xhtml5
-
List of
Xhtml5
markups. - Xhtml5Parser - Class in org.apache.maven.doxia.module.xhtml5
-
Parse an xhtml5 model and emit events into a Doxia Sink.
- Xhtml5Parser() - Constructor for class org.apache.maven.doxia.module.xhtml5.Xhtml5Parser
- Xhtml5ParserModule - Class in org.apache.maven.doxia.module.xhtml5
-
Xhtml5ParserModule class.
- Xhtml5ParserModule() - Constructor for class org.apache.maven.doxia.module.xhtml5.Xhtml5ParserModule
-
Default constructor.
- Xhtml5Sink - Class in org.apache.maven.doxia.module.xhtml5
-
XHTML 5.2 sink implementation.
- Xhtml5Sink(Writer) - Constructor for class org.apache.maven.doxia.module.xhtml5.Xhtml5Sink
-
Constructor, initialize the Writer.
- Xhtml5Sink(Writer, String) - Constructor for class org.apache.maven.doxia.module.xhtml5.Xhtml5Sink
-
Constructor, initialize the Writer and tells which encoding is used.
- Xhtml5Sink(Writer, String, String) - Constructor for class org.apache.maven.doxia.module.xhtml5.Xhtml5Sink
-
Constructor, initialize the Writer and tells which encoding and languageId are used.
- Xhtml5SinkFactory - Class in org.apache.maven.doxia.module.xhtml5
-
Xhtml5 implementation of the Sink factory.
- Xhtml5SinkFactory() - Constructor for class org.apache.maven.doxia.module.xhtml5.Xhtml5SinkFactory
- 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. - XmlPullParserLocator(XmlPullParser, String) - Constructor for class org.apache.maven.doxia.parser.AbstractXmlParser.XmlPullParserLocator
- xmlReader - Variable in class org.apache.maven.doxia.util.XmlValidator
-
lazy xmlReader to validate xml content
- 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.
Y
- YamlFrontMatterVisitor - Class in org.apache.maven.doxia.module.markdown
- YamlFrontMatterVisitor() - Constructor for class org.apache.maven.doxia.module.markdown.YamlFrontMatterVisitor
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
Xhtml5BaseParser.emitHeadingSections(int, Sink, boolean)
instead.