Package org.apache.maven.doxia

Class DefaultDoxia

java.lang.Object

org.codehaus.plexus.logging.AbstractLogEnabled

org.apache.maven.doxia.DefaultDoxia

All Implemented Interfaces:

Doxia

@Component(role=Doxia.class)
public class DefaultDoxia
extends org.codehaus.plexus.logging.AbstractLogEnabled
implements Doxia

Simple implementation of the Doxia interface: uses a ParserManager to lookup a parser.

Since:

1.0

Version:

$Id: DefaultDoxia.java 1345590 2012-06-02 21:36:10Z hboutemy $

Author:

Jason van Zyl

Field Summary

Fields inherited from interface org.apache.maven.doxia.Doxia

ROLE

Constructor Summary

Constructors

Constructor	Description
DefaultDoxia()

Method Summary

Modifier and Type	Method	Description
Parser	getParser(java.lang.String parserId)	Return a parser for the given parserId.
void	parse(java.io.Reader source, java.lang.String parserId, org.apache.maven.doxia.sink.Sink sink)	Parses the given source model using a parser with given id, and emits Doxia events into the given sink.

Methods inherited from class org.codehaus.plexus.logging.AbstractLogEnabled

enableLogging, getLogger, setupLogger, setupLogger, setupLogger

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultDoxia

public DefaultDoxia()

Method Detail

parse

public void parse(java.io.Reader source,
                  java.lang.String parserId,
                  org.apache.maven.doxia.sink.Sink sink)
           throws ParserNotFoundException,
                  ParseException

Parses the given source model using a parser with given id, and emits Doxia events into the given sink.

Specified by:

parse in interface Doxia

Parameters:

source - not null reader that provides the source document. You could use newReader methods from ReaderFactory.

parserId - Identifier for the parser to use.

sink - A sink that consumes the Doxia events.

Throws:

ParserNotFoundException - if no parser could be found for the given id.

ParseException - if the model could not be parsed.

getParser

public Parser getParser(java.lang.String parserId)
                 throws ParserNotFoundException

Return a parser for the given parserId.

Specified by:

getParser in interface Doxia

Parameters:

parserId - Identifier for the parser to use.

Returns:

the parser defining by parserId.

Throws:

ParserNotFoundException - if no parser could be found for the given id.