Package org.apache.maven.doxia.sink

Maven Doxia API.

See:
Description

Interface Summary

Sink	A Sink consumes Doxia events to produce a resultant output format (eg Docbook, PDF, XHTML...).
SinkEventAttributes	A set of attributes for a sink event.
SinkFactory	A factory that creates a Sink object.

Class Summary

AbstractBinarySinkFactory	An abstract SinkFactory for binary output.
AbstractSink	An abstract base class that defines some convenience methods for sinks.
AbstractTextSink	An abstract Sink for text markup syntax.
AbstractTextSinkFactory	An abstract SinkFactory for Text markup syntax.
AbstractXmlSink	An abstract Sink for xml markup syntax.
AbstractXmlSinkFactory	An abstract SinkFactory for XML markup syntax.
PipelineSink	May be used to invoke the same method on a List of Sinks.
RandomAccessSink	The RandomAccessSink provides the ability to create a Sink with hooks.
SinkAdapter	Empty implementation of the Sink interface.
SinkEventAttributeSet	Implementation of MutableAttributeSet using a LinkedHashMap.
SinkUtils	Collection of common utility methods for sinks.
XhtmlBaseSink	Abstract base xhtml sink implementation.

Package org.apache.maven.doxia.sink Description

Maven Doxia API.

The Doxia API is based on Sinks objects: each sink consumes Doxia events to produce a resultant output format (eg Docbook, PDF, XHTML...).

Using Maven Doxia API

The following snippet shows how to use a Doxia Sink:

File userDir = new File( System.getProperty ( "user.dir" ) );
File outputFile = new File( userDir, "test.html" );

SinkFactory sinkFactory = (SinkFactory) lookup( SinkFactory.ROLE, "html" ); // Plexus lookup
Sink sink = sinkFactory.createSink( outputFile.getParentFile(), outputFile.getName() ) );

// Sink head
sink.head();

sink.title();
sink.text( "Title" );
sink.title_();

sink.author();
sink.text( "Author" );
sink.author_();

sink.date();
sink.text( "Date" );
sink.date_();

sink.head_();
// Sink head

sink.body();

sink.paragraph();
sink.text( "Paragraph 1, line 1. Paragraph 1, line 2." );
sink.paragraph_();

...

sink.body_();

sink.flush();

sink.close();

Resources

• Maven Doxia Website
• Plexus