|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Doxia
Basic interface of the Doxia framework.
Field Summary | |
---|---|
static String |
ROLE
The Plexus lookup role. |
Method Summary | |
---|---|
Parser |
getParser(String parserId)
Return a parser for the given parserId . |
void |
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. |
Field Detail |
---|
static final String ROLE
Method Detail |
---|
void parse(Reader source, String parserId, Sink sink) throws ParserNotFoundException, ParseException
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.
ParserNotFoundException
- if no parser could be found for the given id.
ParseException
- if the model could not be parsed.Parser getParser(String parserId) throws ParserNotFoundException
parserId
.
parserId
- Identifier for the parser to use.
ParserNotFoundException
- if no parser could be found for the given id.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |