Uses of Interface
org.apache.maven.doxia.sink.Sink
Packages that use Sink
Package
Description
-
Uses of Sink in org.apache.maven.doxia
Methods in org.apache.maven.doxia with parameters of type SinkModifier and TypeMethodDescriptionvoid
Parses the given source model using a parser with given id, and emits Doxia events into the given sink.void
Parses the given source model using a parser with given id, and emits Doxia events into the given sink.void
Parses the given source model using a parser with given id, and emits Doxia events into the given sink.void
Parses the given source model using a parser with given id, and emits Doxia events into the given sink. -
Uses of Sink in org.apache.maven.doxia.index
Classes in org.apache.maven.doxia.index that implement SinkModifier and TypeClassDescriptionclass
A sink wrapper for populating an index tree for particular elements in a document.Constructors in org.apache.maven.doxia.index with parameters of type SinkModifierConstructorDescriptionprivate
IndexingSink
(IndexEntry rootEntry, Sink delegate) Default constructor.IndexingSink
(Sink delegate) -
Uses of Sink in org.apache.maven.doxia.macro
Methods in org.apache.maven.doxia.macro with parameters of type SinkModifier and TypeMethodDescriptionvoid
EchoMacro.execute
(Sink sink, MacroRequest request) Execute the current macro using the given MacroRequest, and emit events into the given sink.void
Macro.execute
(Sink sink, MacroRequest request) Execute the current macro using the given MacroRequest, and emit events into the given sink. -
Uses of Sink in org.apache.maven.doxia.macro.snippet
Methods in org.apache.maven.doxia.macro.snippet with parameters of type SinkModifier and TypeMethodDescriptionvoid
SnippetMacro.execute
(Sink sink, MacroRequest request) Execute the current macro using the given MacroRequest, and emit events into the given sink. -
Uses of Sink in org.apache.maven.doxia.macro.toc
Methods in org.apache.maven.doxia.macro.toc with parameters of type SinkModifier and TypeMethodDescriptionvoid
TocMacro.execute
(Sink sink, MacroRequest request) Execute the current macro using the given MacroRequest, and emit events into the given sink.private void
TocMacro.writeSubSectionN
(Sink sink, IndexEntry sectionIndex, int n) This recursive method just skips index entries that are not sections (but still evaluates their children).(package private) void
TocMacro.writeTocForIndexEntry
(Sink sink, SinkEventAttributes listAttributes, IndexEntry rootEntry) -
Uses of Sink in org.apache.maven.doxia.module.apt
Classes in org.apache.maven.doxia.module.apt that implement SinkFields in org.apache.maven.doxia.module.apt declared as SinkMethods in org.apache.maven.doxia.module.apt that return SinkModifier and TypeMethodDescriptionprotected Sink
AptSinkFactory.createSink
(Writer writer, String encoding) Create a text Sink for a given encoding.Methods in org.apache.maven.doxia.module.apt with parameters of type SinkModifier and TypeMethodDescriptionprotected void
AptParser.doTraverseText
(String text, int begin, int end, Sink sink) Parse the given text.private static void
AptParser.flushTraversed
(StringBuilder buffer, Sink sink) Emits the text so far parsed into the given sink.void
Parses the given source model and emits Doxia events into the given sink.void
Parses the given source model and emits Doxia events into the given sink. -
Uses of Sink in org.apache.maven.doxia.module.fml
Methods in org.apache.maven.doxia.module.fml with parameters of type SinkModifier and TypeMethodDescriptionprotected 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
FmlContentParser.handleEndTag
(org.codehaus.plexus.util.xml.pull.XmlPullParser parser, Sink sink) Goes through the possible end tags.protected void
FmlParser.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.private void
FmlParser.handleParamStart
(org.codehaus.plexus.util.xml.pull.XmlPullParser parser, Sink sink) TODO import from XdocParser, probably need to be generic.protected void
FmlContentParser.handleStartTag
(org.codehaus.plexus.util.xml.pull.XmlPullParser parser, Sink sink) Goes through the possible start tags.protected void
FmlParser.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
Parses the given source model and emits Doxia events into the given sink.private void
Writes the faqs to the specified sink.private void
FmlParser.writeTopLink
(Sink sink) Writes a toplink element. -
Uses of Sink in org.apache.maven.doxia.module.markdown
Classes in org.apache.maven.doxia.module.markdown that implement SinkMethods in org.apache.maven.doxia.module.markdown that return SinkModifier and TypeMethodDescriptionprotected Sink
MarkdownSinkFactory.createSink
(Writer writer, String encoding) Create a text Sink for a given encoding.Methods in org.apache.maven.doxia.module.markdown with parameters of type SinkModifier and TypeMethodDescriptionprotected 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
Parses the given source model and emits Doxia events into the given sink. -
Uses of Sink in org.apache.maven.doxia.module.xdoc
Classes in org.apache.maven.doxia.module.xdoc that implement SinkMethods in org.apache.maven.doxia.module.xdoc that return SinkModifier and TypeMethodDescriptionprotected 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.Methods in org.apache.maven.doxia.module.xdoc with parameters of type SinkModifier and TypeMethodDescriptionprivate void
XdocParser.closeOpenSections
(int newLevel, Sink sink) Close open h2, h3, h4, h5 sections.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.private void
XdocParser.handleMacroEnd
(Sink sink) private void
XdocParser.handleMetaStart
(org.codehaus.plexus.util.xml.pull.XmlPullParser parser, Sink sink, SinkEventAttributeSet attribs) private void
XdocParser.handleParamStart
(org.codehaus.plexus.util.xml.pull.XmlPullParser parser, Sink sink) private void
XdocParser.handleSectionStart
(int level, Sink sink, SinkEventAttributeSet attribs, org.codehaus.plexus.util.xml.pull.XmlPullParser parser) protected void
XdocParser.handleStartTag
(org.codehaus.plexus.util.xml.pull.XmlPullParser parser, Sink sink) Goes through the possible start tags.private void
XdocParser.openMissingSections
(int newLevel, Sink sink) Open missing h2, h3, h4, h5 sections.void
Parses the given source model and emits Doxia events into the given sink. -
Uses of Sink in org.apache.maven.doxia.module.xhtml5
Classes in org.apache.maven.doxia.module.xhtml5 that implement SinkModifier and TypeClassDescriptionclass
Abstract AbstractXhtml5Sink class.class
XHTML 5.2 sink implementation.Methods in org.apache.maven.doxia.module.xhtml5 that return SinkModifier and TypeMethodDescriptionprotected 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.Methods in org.apache.maven.doxia.module.xhtml5 with parameters of type SinkModifier and TypeMethodDescriptionprotected 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
Parses the given source model and emits Doxia events into the given sink.private void
Xhtml5Parser.processMacro
(String text, Sink sink) process macro embedded in XHTML commment -
Uses of Sink in org.apache.maven.doxia.parser
Methods in org.apache.maven.doxia.parser that return SinkModifier and TypeMethodDescriptionprotected Sink
AbstractParser.getWrappedSink
(Sink sink) Creates a sink pipeline built from all registeredSinkWrapperFactory
objects.Methods in org.apache.maven.doxia.parser with parameters of type SinkModifier and TypeMethodDescriptionprotected boolean
Xhtml1BaseParser.baseEndTag
(org.codehaus.plexus.util.xml.pull.XmlPullParser parser, Sink sink) protected boolean
Xhtml5BaseParser.baseEndTag
(String elementName, SinkEventAttributeSet attribs, Sink sink) 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
Xhtml1BaseParser.baseStartTag
(org.codehaus.plexus.util.xml.pull.XmlPullParser parser, Sink sink) Translates obsolete XHTML 1.0 attributes/elements to valid XHTML5 ones before calling the underlyingXhtml5BaseParser
.protected boolean
Xhtml5BaseParser.baseStartTag
(String elementName, SinkEventAttributeSet attribs, Sink sink) protected boolean
Xhtml5BaseParser.baseStartTag
(org.codehaus.plexus.util.xml.pull.XmlPullParser parser, Sink sink) Goes through a common list of possible html5 start tags.private void
Xhtml5BaseParser.closeOpenHeadingSections
(int newLevel, Sink sink) Close open heading sections.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 levelvoid
AbstractParser.executeMacro
(String macroId, MacroRequest request, Sink sink) Execute a macro on the given sink.protected Sink
AbstractParser.getWrappedSink
(Sink sink) Creates a sink pipeline built from all registeredSinkWrapperFactory
objects.private void
Xhtml5BaseParser.handleAEnd
(Sink sink) private void
Xhtml5BaseParser.handleAStart
(Sink sink, SinkEventAttributeSet attribs) protected void
AbstractXmlParser.handleCdsect
(org.codehaus.plexus.util.xml.pull.XmlPullParser parser, Sink sink) Handles CDATA sections.protected void
Xhtml5BaseParser.handleCdsect
(org.codehaus.plexus.util.xml.pull.XmlPullParser parser, Sink sink) Handles CDATA sections.protected void
AbstractXmlParser.handleComment
(org.codehaus.plexus.util.xml.pull.XmlPullParser parser, Sink sink) Handles comments.protected void
Xhtml5BaseParser.handleComment
(org.codehaus.plexus.util.xml.pull.XmlPullParser parser, Sink sink) Handles comments.private boolean
Xhtml5BaseParser.handleDivEnd
(Sink sink) private boolean
Xhtml5BaseParser.handleDivStart
(SinkEventAttributeSet attribs, Sink sink) protected abstract void
AbstractXmlParser.handleEndTag
(org.codehaus.plexus.util.xml.pull.XmlPullParser parser, Sink sink) Goes through the possible end tags.protected void
Xhtml5BaseParser.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.private void
Xhtml5BaseParser.handleHeadingStart
(Sink sink, int level, SinkEventAttributeSet attribs) private void
Xhtml5BaseParser.handleImgStart
(Sink sink, SinkEventAttributeSet attribs) private void
Xhtml5BaseParser.handleLIStart
(Sink sink, SinkEventAttributeSet attribs) private void
Xhtml5BaseParser.handleListItemEnd
(Sink sink) private void
Xhtml5BaseParser.handleOLStart
(Sink sink, SinkEventAttributeSet attribs) private void
Xhtml5BaseParser.handlePreStart
(SinkEventAttributeSet attribs, Sink sink) private void
Xhtml5BaseParser.handlePStart
(Sink sink, SinkEventAttributeSet attribs) private void
Xhtml5BaseParser.handleSectionEnd
(Sink sink) private void
Xhtml5BaseParser.handleSectionStart
(Sink sink, SinkEventAttributeSet attribs) protected abstract void
AbstractXmlParser.handleStartTag
(org.codehaus.plexus.util.xml.pull.XmlPullParser parser, Sink sink) Goes through the possible start tags.protected void
Xhtml5BaseParser.handleStartTag
(org.codehaus.plexus.util.xml.pull.XmlPullParser parser, Sink sink) Goes through the possible start tags.private void
Xhtml5BaseParser.handleTableStart
(Sink sink, SinkEventAttributeSet attribs) protected void
AbstractXmlParser.handleText
(org.codehaus.plexus.util.xml.pull.XmlPullParser parser, Sink sink) Handles text events.protected void
Xhtml5BaseParser.handleText
(org.codehaus.plexus.util.xml.pull.XmlPullParser parser, Sink sink) Handles text events.protected void
AbstractXmlParser.handleUnknown
(String elementName, SinkEventAttributeSet attribs, Sink sink, int type) protected void
AbstractXmlParser.handleUnknown
(org.codehaus.plexus.util.xml.pull.XmlPullParser parser, Sink sink, int type) Handles an unknown event.private void
Xhtml5BaseParser.openMissingHeadingSections
(int newLevel, Sink sink) Open missing heading sections.void
Parses the given source model and emits Doxia events into the given sink.void
Convenience method to parse an arbitrary string and emit events into the given sink.void
Convenience method to parse an arbitrary string and emit events into the given sink.void
Parses the given source model and emits Doxia events into the given sink.void
Parses the given source model and emits Doxia events into the given sink.void
Parses the given source model and emits Doxia events into the given sink.void
Parses the given source model and emits Doxia events into the given sink.private void
AbstractXmlParser.parseXml
(org.codehaus.plexus.util.xml.pull.XmlPullParser parser, Sink sink, String reference) Parse the model from the XmlPullParser into the given sink. -
Uses of Sink in org.apache.maven.doxia.sink
Methods in org.apache.maven.doxia.sink that return SinkModifier and TypeMethodDescriptionSinkFactory.createSink
(File outputDir, String outputName) Create aSink
into a file.SinkFactory.createSink
(File outputDir, String outputName, String encoding) Create aSink
into a file using a specified encoding.SinkFactory.createSink
(OutputStream out) Create aSink
into an OutputStream.SinkFactory.createSink
(OutputStream out, String encoding) Create aSink
into an OutputStream using a specified encoding. -
Uses of Sink in org.apache.maven.doxia.sink.impl
Subinterfaces of Sink in org.apache.maven.doxia.sink.implClasses in org.apache.maven.doxia.sink.impl that implement SinkModifier and TypeClassDescriptionclass
An abstract base class that defines some convenience methods for sinks.class
An abstractSink
for text markup syntax.class
An abstractSink
for xml markup syntax.class
Sink wrapper which emits anchors for each entry detected by the underlyingIndexingSink
.class
Deprecated.UseBufferingSinkProxyFactory
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.class
Empty implementation of theSink
interface.class
By default aSinkWrapper
just delegates each method to the wrapped sink's method.class
Validates that each anchor name only appears once per document.class
Abstract base xhtml5 sink implementation.Fields in org.apache.maven.doxia.sink.impl declared as SinkModifier and TypeFieldDescriptionprivate Sink
RandomAccessSink.coreSink
Deprecated.private Sink
RandomAccessSink.currentSink
Deprecated.private final Sink
BufferingSinkProxyFactory.BufferingSinkProxy.delegate
private Sink
SinkWrapper.delegate
private final Sink
EventCapturingSinkProxy.sink
Fields in org.apache.maven.doxia.sink.impl with type parameters of type SinkModifier and TypeFieldDescriptionPipelineSink.pipeline
Deprecated.RandomAccessSink.sinks
Deprecated.Methods in org.apache.maven.doxia.sink.impl that return SinkModifier and TypeMethodDescriptionRandomAccessSink.addSinkHook()
Deprecated.By calling this method a sink reference is added at the current position.AbstractTextSinkFactory.createSink
(File outputDir, String outputName) Create aSink
into a file.AbstractTextSinkFactory.createSink
(File outputDir, String outputName, String encoding) Create aSink
into a file using a specified encoding.AbstractTextSinkFactory.createSink
(OutputStream out) Create aSink
into an OutputStream.AbstractTextSinkFactory.createSink
(OutputStream out, String encoding) Create aSink
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.BufferingSinkProxyFactory.createWrapper
(Sink delegate) CreateAnchorsForIndexEntriesFactory.createWrapper
(Sink sink) SinkWrapperFactory.createWrapper
(Sink sink) By default all wrappers just delegate each method to the wrapped sink's method.UniqueAnchorNamesValidatorFactory.createWrapper
(Sink sink) BufferingSinkProxyFactory.BufferingSink.getBufferedSink()
SinkWrapper.getWrappedSink()
static Sink
EventCapturingSinkProxy.newInstance
(Sink sink, List<String> capturedEventNames) static Sink
PipelineSink.newInstance
(List<Sink> pipeline) Deprecated.Returns an instance of a PipelineSink as a Sink.Methods in org.apache.maven.doxia.sink.impl with parameters of type SinkModifier and TypeMethodDescriptionvoid
Deprecated.Add a Sink to the List of Sinks.BufferingSinkProxyFactory.castAsBufferingSink
(Sink sink) BufferingSinkProxyFactory.createWrapper
(Sink delegate) CreateAnchorsForIndexEntriesFactory.createWrapper
(Sink sink) SinkWrapperFactory.createWrapper
(Sink sink) By default all wrappers just delegate each method to the wrapped sink's method.UniqueAnchorNamesValidatorFactory.createWrapper
(Sink sink) static Sink
EventCapturingSinkProxy.newInstance
(Sink sink, List<String> capturedEventNames) void
SinkWrapper.setWrappedSink
(Sink sink) Method parameters in org.apache.maven.doxia.sink.impl with type arguments of type SinkModifier and TypeMethodDescriptionstatic Sink
PipelineSink.newInstance
(List<Sink> pipeline) Deprecated.Returns an instance of a PipelineSink as a Sink.Constructors in org.apache.maven.doxia.sink.impl with parameters of type SinkModifierConstructorDescription(package private)
BufferingSinkProxy
(Sink delegate) CreateAnchorsForIndexEntries
(Sink delegate) private
EventCapturingSinkProxy
(Sink sink, List<String> capturedEventNames) SinkWrapper
(Sink delegate) Constructor parameters in org.apache.maven.doxia.sink.impl with type arguments of type SinkModifierConstructorDescriptionPipelineSink
(List<Sink> pipeline) Deprecated.Constructs a PipelineSink for a given List of Sinks.
Xhtml5BaseParser.emitHeadingSections(int, Sink, boolean)
instead.