Package org.apache.maven.doxia
Class DefaultDoxia
java.lang.Object
org.codehaus.plexus.logging.AbstractLogEnabled
org.apache.maven.doxia.DefaultDoxia
- All Implemented Interfaces:
Doxia
,org.codehaus.plexus.logging.LogEnabled
@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
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionReturn a parser for the givenparserId
.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.Methods inherited from class org.codehaus.plexus.logging.AbstractLogEnabled
enableLogging, getLogger, setupLogger, setupLogger, setupLogger
-
Field Details
-
parserManager
-
-
Constructor Details
-
DefaultDoxia
public DefaultDoxia()
-
-
Method Details
-
parse
public void parse(Reader source, String parserId, 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 interfaceDoxia
- Parameters:
source
- not null reader that provides the source documentparserId
- identifier for the parser to usesink
- a sink that consumes the Doxia events- Throws:
ParserNotFoundException
- if no parser could be found for the given idParseException
- if the model could not be parsed
-
parse
public void parse(Reader source, String parserId, Sink sink, String reference) 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 interfaceDoxia
- Parameters:
source
- not null reader that provides the source documentparserId
- identifier for the parser to usesink
- a sink that consumes the Doxia eventsreference
- string containing the reference to the source (e.g. filename)- Throws:
ParserNotFoundException
- if no parser could be found for the given idParseException
- if the model could not be parsed
-
getParser
Return a parser for the givenparserId
.- Specified by:
getParser
in interfaceDoxia
- Parameters:
parserId
- identifier for the parser to use- Returns:
- the parser identified by parserId
- Throws:
ParserNotFoundException
- if no parser could be found for the given id
-