Package org.apache.maven.doxia
Interface Doxia
- All Known Implementing Classes:
DefaultDoxia
public interface Doxia
Basic interface of the Doxia framework.
- Since:
- 1.0
-
Field Summary
Fields -
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.
-
Field Details
-
ROLE
The Plexus lookup role.
-
-
Method Details
-
parse
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.- 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
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.- 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
.- 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
-