Uses of Interface
org.apache.maven.doxia.sink.Sink

Packages that use Sink

Package	Description
org.apache.maven.doxia
org.apache.maven.doxia.index
org.apache.maven.doxia.macro
org.apache.maven.doxia.macro.snippet
org.apache.maven.doxia.macro.toc
org.apache.maven.doxia.module.apt
org.apache.maven.doxia.module.fml
org.apache.maven.doxia.module.markdown
org.apache.maven.doxia.module.xdoc
org.apache.maven.doxia.module.xhtml5
org.apache.maven.doxia.parser
org.apache.maven.doxia.sink
org.apache.maven.doxia.sink.impl

Uses of Sink in org.apache.maven.doxia

Methods in org.apache.maven.doxia with parameters of type Sink

Modifier and Type	Method	Description
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	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.
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	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.

Uses of Sink in org.apache.maven.doxia.index

Classes in org.apache.maven.doxia.index that implement Sink

Modifier and Type	Class	Description
class	IndexingSink	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 Sink

Modifier	Constructor	Description
private	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 Sink

Modifier and Type	Method	Description
void	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 Sink

Modifier and Type	Method	Description
void	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 Sink

Modifier and Type	Method	Description
void	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 Sink

Modifier and Type	Class	Description
class	AptSink	APT generator implementation.

Fields in org.apache.maven.doxia.module.apt declared as Sink

Modifier and Type	Field	Description
protected Sink	AptParser.sink	the sink to receive the events.

Methods in org.apache.maven.doxia.module.apt that return Sink

Modifier and Type	Method	Description
protected 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 Sink

Modifier and Type	Method	Description
protected 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	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.

Uses of Sink in org.apache.maven.doxia.module.fml

Methods in org.apache.maven.doxia.module.fml with parameters of type Sink

Modifier and Type	Method	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	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	FmlParser.parse(Reader source, Sink sink, String reference)	Parses the given source model and emits Doxia events into the given sink.
private void	FmlParser.writeFaqs(Sink sink)	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 Sink

Modifier and Type	Class	Description
class	MarkdownSink	Markdown generator implementation.

Methods in org.apache.maven.doxia.module.markdown that return Sink

Modifier and Type	Method	Description
protected 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 Sink

Modifier and Type	Method	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.

Uses of Sink in org.apache.maven.doxia.module.xdoc

Classes in org.apache.maven.doxia.module.xdoc that implement Sink

Modifier and Type	Class	Description
class	XdocSink	Xdoc Sink implementation.

Methods in org.apache.maven.doxia.module.xdoc that return Sink

Modifier and Type	Method	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.

Methods in org.apache.maven.doxia.module.xdoc with parameters of type Sink

Modifier and Type	Method	Description
private 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	XdocParser.parse(Reader source, Sink sink, String reference)	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 Sink

Modifier and Type	Class	Description
class	AbstractXhtml5Sink	Abstract AbstractXhtml5Sink class.
class	Xhtml5Sink	XHTML 5.2 sink implementation.

Methods in org.apache.maven.doxia.module.xhtml5 that return Sink

Modifier and Type	Method	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.

Methods in org.apache.maven.doxia.module.xhtml5 with parameters of type Sink

Modifier and Type	Method	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.
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 Sink

Modifier and Type	Method	Description
protected Sink	AbstractParser.getWrappedSink(Sink sink)	Creates a sink pipeline built from all registered SinkWrapperFactory objects.

Methods in org.apache.maven.doxia.parser with parameters of type Sink

Modifier and Type	Method	Description
protected 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 underlying Xhtml5BaseParser.
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. Use Xhtml5BaseParser.emitHeadingSections(int, Sink, boolean) instead.
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)	Creates a sink pipeline built from all registered SinkWrapperFactory 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	AbstractParser.parse(Reader source, Sink sink)	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.
void	AbstractXmlParser.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)	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	Xhtml5BaseParser.parse(Reader source, Sink sink, String reference)	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 Sink

Modifier and Type	Method	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.

Uses of Sink in org.apache.maven.doxia.sink.impl

Subinterfaces of Sink in org.apache.maven.doxia.sink.impl

Modifier and Type	Interface	Description
static interface	BufferingSinkProxyFactory.BufferingSink

Classes in org.apache.maven.doxia.sink.impl that implement Sink

Modifier and Type	Class	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.
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.

Fields in org.apache.maven.doxia.sink.impl declared as Sink

Modifier and Type	Field	Description
private 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 Sink

Modifier and Type	Field	Description
private List<Sink>	PipelineSink.pipeline	Deprecated.
private List<Sink>	RandomAccessSink.sinks	Deprecated.

Methods in org.apache.maven.doxia.sink.impl that return Sink

Modifier and Type	Method	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	BufferingSinkProxyFactory.createWrapper(Sink delegate)
Sink	CreateAnchorsForIndexEntriesFactory.createWrapper(Sink sink)
Sink	SinkWrapperFactory.createWrapper(Sink sink)	By default all wrappers just delegate each method to the wrapped sink's method.
Sink	UniqueAnchorNamesValidatorFactory.createWrapper(Sink sink)
Sink	BufferingSinkProxyFactory.BufferingSink.getBufferedSink()
Sink	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 Sink

Modifier and Type	Method	Description
void	PipelineSink.addSink(Sink sink)	Deprecated. Add a Sink to the List of Sinks.
static BufferingSinkProxyFactory.BufferingSink	BufferingSinkProxyFactory.castAsBufferingSink(Sink sink)
Sink	BufferingSinkProxyFactory.createWrapper(Sink delegate)
Sink	CreateAnchorsForIndexEntriesFactory.createWrapper(Sink sink)
Sink	SinkWrapperFactory.createWrapper(Sink sink)	By default all wrappers just delegate each method to the wrapped sink's method.
Sink	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 Sink

Modifier and Type	Method	Description
static 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 Sink

Modifier	Constructor	Description
(package private)	BufferingSinkProxy(Sink delegate)
	CreateAnchorsForIndexEntries(Sink delegate)
private	EventCapturingSinkProxy(Sink sink, List<String> capturedEventNames)
	SinkWrapper(Sink delegate)
	UniqueAnchorNamesValidator(Sink sink)

Constructor parameters in org.apache.maven.doxia.sink.impl with type arguments of type Sink

Modifier	Constructor	Description
	PipelineSink(List<Sink> pipeline)	Deprecated. Constructs a PipelineSink for a given List of Sinks.