Modifier and Type | Method and Description |
---|---|
void |
Doxia.parse(Reader source,
String parserId,
Sink sink)
Parses the given source model using a parser with given id,
and emits Doxia events into the given sink.
|
void |
DefaultDoxia.parse(Reader source,
String parserId,
Sink sink)
Parses the given source model using a parser with given id,
and emits Doxia events into the given sink.
|
void |
Doxia.parse(Reader source,
String parserId,
Sink sink,
String reference)
Parses the given source model using a parser with given id,
and emits Doxia events into the given sink.
|
void |
DefaultDoxia.parse(Reader source,
String parserId,
Sink sink,
String reference)
Parses the given source model using a parser with given id,
and emits Doxia events into the given sink.
|
Modifier and Type | Class and Description |
---|---|
class |
IndexingSink
A sink wrapper for populating an index tree for particular elements in a document.
|
Constructor and Description |
---|
IndexingSink(Sink delegate) |
Modifier and Type | Method and Description |
---|---|
void |
Macro.execute(Sink sink,
MacroRequest request)
Execute the current macro using the given MacroRequest,
and emit events into the given sink.
|
void |
EchoMacro.execute(Sink sink,
MacroRequest request)
Execute the current macro using the given MacroRequest,
and emit events into the given sink.
|
Modifier and Type | Method and Description |
---|---|
void |
SnippetMacro.execute(Sink sink,
MacroRequest request)
Execute the current macro using the given MacroRequest,
and emit events into the given sink.
|
Modifier and Type | Method and Description |
---|---|
void |
TocMacro.execute(Sink sink,
MacroRequest request)
Execute the current macro using the given MacroRequest,
and emit events into the given sink.
|
Modifier and Type | Class and Description |
---|---|
class |
AptSink
APT generator implementation.
|
Modifier and Type | Field and Description |
---|---|
protected Sink |
AptParser.sink
the sink to receive the events.
|
Modifier and Type | Method and Description |
---|---|
protected Sink |
AptSinkFactory.createSink(Writer writer,
String encoding)
Create a text Sink for a given encoding.
|
Modifier and Type | Method and Description |
---|---|
protected void |
AptParser.doTraverseText(String text,
int begin,
int end,
Sink sink)
Parse the given text.
|
void |
AptParser.parse(Reader source,
Sink sink)
Parses the given source model and emits Doxia events into the given sink.
|
void |
AptParser.parse(Reader source,
Sink sink,
String reference)
Parses the given source model and emits Doxia events into the given sink.
|
Modifier and Type | Method and Description |
---|---|
protected void |
FmlParser.handleCdsect(org.codehaus.plexus.util.xml.pull.XmlPullParser parser,
Sink sink)
Handles CDATA sections.
|
protected void |
FmlParser.handleComment(org.codehaus.plexus.util.xml.pull.XmlPullParser parser,
Sink sink)
Handles comments.
|
protected void |
FmlParser.handleEndTag(org.codehaus.plexus.util.xml.pull.XmlPullParser parser,
Sink sink)
Goes through the possible end tags.
|
protected void |
FmlContentParser.handleEndTag(org.codehaus.plexus.util.xml.pull.XmlPullParser parser,
Sink sink)
Goes through the possible end tags.
|
protected void |
FmlParser.handleEntity(org.codehaus.plexus.util.xml.pull.XmlPullParser parser,
Sink sink)
Handles entities.
|
protected void |
FmlParser.handleStartTag(org.codehaus.plexus.util.xml.pull.XmlPullParser parser,
Sink sink)
Goes through the possible start tags.
|
protected void |
FmlContentParser.handleStartTag(org.codehaus.plexus.util.xml.pull.XmlPullParser parser,
Sink sink)
Goes through the possible start tags.
|
protected void |
FmlParser.handleText(org.codehaus.plexus.util.xml.pull.XmlPullParser parser,
Sink sink)
Handles text events.
|
void |
FmlParser.parse(Reader source,
Sink sink,
String reference)
Parses the given source model and emits Doxia events into the given sink.
|
Modifier and Type | Class and Description |
---|---|
class |
MarkdownSink
Markdown generator implementation.
|
Modifier and Type | Method and Description |
---|---|
protected Sink |
MarkdownSinkFactory.createSink(Writer writer,
String encoding)
Create a text Sink for a given encoding.
|
Modifier and Type | Method and Description |
---|---|
protected boolean |
MarkdownParser.MarkdownHtmlParser.baseEndTag(org.codehaus.plexus.util.xml.pull.XmlPullParser parser,
Sink sink) |
protected boolean |
MarkdownParser.MarkdownHtmlParser.baseStartTag(org.codehaus.plexus.util.xml.pull.XmlPullParser parser,
Sink sink) |
void |
MarkdownParser.parse(Reader source,
Sink sink,
String reference)
Parses the given source model and emits Doxia events into the given sink.
|
Modifier and Type | Class and Description |
---|---|
class |
XdocSink
Xdoc Sink implementation.
|
Modifier and Type | Method and Description |
---|---|
protected Sink |
XdocSinkFactory.createSink(Writer writer,
String encoding)
Create a text Sink for a given encoding.
|
protected Sink |
XdocSinkFactory.createSink(Writer writer,
String encoding,
String languageId)
Create a text Sink for a given encoding and for a given language identifier.
|
Modifier and Type | Method and Description |
---|---|
protected void |
XdocParser.consecutiveSections(int newLevel,
Sink sink) |
protected void |
XdocParser.handleEndTag(org.codehaus.plexus.util.xml.pull.XmlPullParser parser,
Sink sink)
Goes through the possible end tags.
|
protected void |
XdocParser.handleStartTag(org.codehaus.plexus.util.xml.pull.XmlPullParser parser,
Sink sink)
Goes through the possible start tags.
|
void |
XdocParser.parse(Reader source,
Sink sink,
String reference)
Parses the given source model and emits Doxia events into the given sink.
|
Modifier and Type | Class and Description |
---|---|
class |
AbstractXhtml5Sink
Abstract AbstractXhtml5Sink class.
|
class |
Xhtml5Sink
XHTML 5.2 sink implementation.
|
Modifier and Type | Method and Description |
---|---|
protected Sink |
Xhtml5SinkFactory.createSink(Writer writer,
String encoding)
Create a text Sink for a given encoding.
|
protected Sink |
Xhtml5SinkFactory.createSink(Writer writer,
String encoding,
String languageId)
Create a text Sink for a given encoding and for a given language identifier.
|
Modifier and Type | Method and Description |
---|---|
protected void |
Xhtml5Parser.handleComment(org.codehaus.plexus.util.xml.pull.XmlPullParser parser,
Sink sink)
Handles comments.
|
protected void |
Xhtml5Parser.handleEndTag(org.codehaus.plexus.util.xml.pull.XmlPullParser parser,
Sink sink)
Goes through the possible end tags.
|
protected void |
Xhtml5Parser.handleStartTag(org.codehaus.plexus.util.xml.pull.XmlPullParser parser,
Sink sink)
Goes through the possible start tags.
|
void |
Xhtml5Parser.parse(Reader source,
Sink sink,
String reference)
Parses the given source model and emits Doxia events into the given sink.
|
Modifier and Type | Method and Description |
---|---|
protected Sink |
AbstractParser.getWrappedSink(Sink sink)
Retrieves the sink pipeline built from all registered
SinkWrapperFactory objects. |
Modifier and Type | Method and Description |
---|---|
protected boolean |
Xhtml5BaseParser.baseEndTag(org.codehaus.plexus.util.xml.pull.XmlPullParser parser,
Sink sink)
Goes through a common list of possible html end tags.
|
protected boolean |
Xhtml5BaseParser.baseStartTag(org.codehaus.plexus.util.xml.pull.XmlPullParser parser,
Sink sink)
Goes through a common list of possible html5 start tags.
|
protected void |
Xhtml5BaseParser.consecutiveSections(int newLevel,
Sink sink,
SinkEventAttributeSet attribs)
Deprecated.
|
protected void |
Xhtml5BaseParser.emitHeadingSections(int newLevel,
Sink sink,
boolean enforceNewSection)
Make sure sections are nested consecutively and correctly inserted for the given heading level
|
void |
AbstractParser.executeMacro(String macroId,
MacroRequest request,
Sink sink)
Execute a macro on the given sink.
|
protected Sink |
AbstractParser.getWrappedSink(Sink sink)
Retrieves the sink pipeline built from all registered
SinkWrapperFactory objects. |
protected void |
Xhtml5BaseParser.handleCdsect(org.codehaus.plexus.util.xml.pull.XmlPullParser parser,
Sink sink)
Handles CDATA sections.
|
protected void |
AbstractXmlParser.handleCdsect(org.codehaus.plexus.util.xml.pull.XmlPullParser parser,
Sink sink)
Handles CDATA sections.
|
protected void |
Xhtml5BaseParser.handleComment(org.codehaus.plexus.util.xml.pull.XmlPullParser parser,
Sink sink)
Handles comments.
|
protected void |
AbstractXmlParser.handleComment(org.codehaus.plexus.util.xml.pull.XmlPullParser parser,
Sink sink)
Handles comments.
|
protected void |
Xhtml5BaseParser.handleEndTag(org.codehaus.plexus.util.xml.pull.XmlPullParser parser,
Sink sink)
Goes through the possible end tags.
|
protected abstract void |
AbstractXmlParser.handleEndTag(org.codehaus.plexus.util.xml.pull.XmlPullParser parser,
Sink sink)
Goes through the possible end tags.
|
protected void |
AbstractXmlParser.handleEntity(org.codehaus.plexus.util.xml.pull.XmlPullParser parser,
Sink sink)
Handles entities.
|
protected void |
Xhtml5BaseParser.handleStartTag(org.codehaus.plexus.util.xml.pull.XmlPullParser parser,
Sink sink)
Goes through the possible start tags.
|
protected abstract void |
AbstractXmlParser.handleStartTag(org.codehaus.plexus.util.xml.pull.XmlPullParser parser,
Sink sink)
Goes through the possible start tags.
|
protected void |
Xhtml5BaseParser.handleText(org.codehaus.plexus.util.xml.pull.XmlPullParser parser,
Sink sink)
Handles text events.
|
protected void |
AbstractXmlParser.handleText(org.codehaus.plexus.util.xml.pull.XmlPullParser parser,
Sink sink)
Handles text events.
|
protected void |
AbstractXmlParser.handleUnknown(org.codehaus.plexus.util.xml.pull.XmlPullParser parser,
Sink sink,
int type)
Handles an unknown event.
|
void |
Parser.parse(Reader source,
Sink sink)
Parses the given source model and emits Doxia events into the given sink.
|
void |
AbstractParser.parse(Reader source,
Sink sink)
Parses the given source model and emits Doxia events into the given sink.
|
void |
Xhtml5BaseParser.parse(Reader source,
Sink sink,
String reference)
Parses the given source model and emits Doxia events into the given sink.
|
void |
Parser.parse(Reader source,
Sink sink,
String reference)
Parses the given source model and emits Doxia events into the given sink.
|
void |
AbstractXmlParser.parse(Reader source,
Sink sink,
String reference)
Parses the given source model and emits Doxia events into the given sink.
|
void |
AbstractParser.parse(String string,
Sink sink)
Convenience method to parse an arbitrary string and emit events into the given sink.
|
void |
AbstractParser.parse(String string,
Sink sink,
String reference)
Convenience method to parse an arbitrary string and emit events into the given sink.
|
Modifier and Type | Method and Description |
---|---|
Sink |
SinkFactory.createSink(File outputDir,
String outputName)
Create a
Sink into a file. |
Sink |
SinkFactory.createSink(File outputDir,
String outputName,
String encoding)
Create a
Sink into a file using a specified encoding. |
Sink |
SinkFactory.createSink(OutputStream out)
Create a
Sink into an OutputStream. |
Sink |
SinkFactory.createSink(OutputStream out,
String encoding)
Create a
Sink into an OutputStream using a specified encoding. |
Modifier and Type | Interface and Description |
---|---|
static interface |
BufferingSinkProxyFactory.BufferingSink |
Modifier and Type | Class and Description |
---|---|
class |
AbstractSink
An abstract base class that defines some convenience methods for sinks.
|
class |
AbstractTextSink
An abstract
Sink for text markup syntax. |
class |
AbstractXmlSink
An abstract
Sink for xml markup syntax. |
class |
CreateAnchorsForIndexEntries
Sink wrapper which emits anchors for each entry detected by the underlying
IndexingSink . |
class |
RandomAccessSink
Deprecated.
Use
BufferingSinkProxyFactory instead which buffers on the (higher) Sink API level
which usually is less memory intense than buffering the output stream which is done by this class.
Also it doesn't require dynamically creating new sinks leveraging a SinkFactory . |
class |
SinkAdapter
Empty implementation of the
Sink interface. |
class |
SinkWrapper
By default a
SinkWrapper just delegates each method to the wrapped sink's method. |
class |
UniqueAnchorNamesValidator
Validates that each anchor name only appears once per document.
|
class |
Xhtml5BaseSink
Abstract base xhtml5 sink implementation.
|
Modifier and Type | Method and Description |
---|---|
Sink |
RandomAccessSink.addSinkHook()
Deprecated.
By calling this method a sink reference is added at the current position.
|
Sink |
AbstractTextSinkFactory.createSink(File outputDir,
String outputName)
Create a
Sink into a file. |
Sink |
AbstractTextSinkFactory.createSink(File outputDir,
String outputName,
String encoding)
Create a
Sink into a file using a specified encoding. |
Sink |
AbstractTextSinkFactory.createSink(OutputStream out)
Create a
Sink into an OutputStream. |
Sink |
AbstractTextSinkFactory.createSink(OutputStream out,
String encoding)
Create a
Sink into an OutputStream using a specified encoding. |
protected abstract Sink |
AbstractTextSinkFactory.createSink(Writer writer,
String encoding)
Create a text Sink for a given encoding.
|
protected abstract Sink |
AbstractXmlSinkFactory.createSink(Writer writer,
String encoding,
String languageId)
Create a text Sink for a given encoding and for a given language identifier.
|
Sink |
UniqueAnchorNamesValidatorFactory.createWrapper(Sink sink) |
Sink |
SinkWrapperFactory.createWrapper(Sink sink)
By default all wrappers just delegate each method to the wrapped sink's method.
|
Sink |
CreateAnchorsForIndexEntriesFactory.createWrapper(Sink sink) |
Sink |
BufferingSinkProxyFactory.createWrapper(Sink delegate) |
Sink |
BufferingSinkProxyFactory.BufferingSink.getBufferedSink() |
Sink |
SinkWrapper.getWrappedSink() |
static Sink |
PipelineSink.newInstance(List<Sink> pipeline)
Deprecated.
Returns an instance of a PipelineSink as a Sink.
|
static Sink |
EventCapturingSinkProxy.newInstance(Sink sink,
List<String> capturedEventNames) |
Modifier and Type | Method and Description |
---|---|
void |
PipelineSink.addSink(Sink sink)
Deprecated.
Add a Sink to the List of Sinks.
|
static BufferingSinkProxyFactory.BufferingSink |
BufferingSinkProxyFactory.castAsBufferingSink(Sink sink) |
Sink |
UniqueAnchorNamesValidatorFactory.createWrapper(Sink sink) |
Sink |
SinkWrapperFactory.createWrapper(Sink sink)
By default all wrappers just delegate each method to the wrapped sink's method.
|
Sink |
CreateAnchorsForIndexEntriesFactory.createWrapper(Sink sink) |
Sink |
BufferingSinkProxyFactory.createWrapper(Sink delegate) |
static Sink |
EventCapturingSinkProxy.newInstance(Sink sink,
List<String> capturedEventNames) |
void |
SinkWrapper.setWrappedSink(Sink sink) |
Modifier and Type | Method and Description |
---|---|
static Sink |
PipelineSink.newInstance(List<Sink> pipeline)
Deprecated.
Returns an instance of a PipelineSink as a Sink.
|
Constructor and Description |
---|
CreateAnchorsForIndexEntries(Sink delegate) |
SinkWrapper(Sink delegate) |
UniqueAnchorNamesValidator(Sink sink) |
Constructor and Description |
---|
PipelineSink(List<Sink> pipeline)
Deprecated.
Constructs a PipelineSink for a given List of Sinks.
|
Copyright © 2005–2024 The Apache Software Foundation. All rights reserved.