|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Parser
A Parser is responsible for parsing any document in a supported front-end format, and emitting the standard Doxia events, which can then be consumed by any Doxia Sink.
Field Summary | |
---|---|
static String |
ROLE
The Plexus lookup role. |
static int |
TXT_TYPE
Text parser type |
static int |
UNKNOWN_TYPE
Unknown parser type |
static int |
XML_TYPE
XML parser type |
Method Summary | |
---|---|
int |
getType()
The parser type value could be UNKNOWN_TYPE , TXT_TYPE or
XML_TYPE . |
void |
parse(Reader source,
Sink sink)
Parses the given source model and emits Doxia events into the given sink. |
Methods inherited from interface org.apache.maven.doxia.logging.LogEnabled |
---|
enableLogging |
Field Detail |
---|
static final String ROLE
static final int UNKNOWN_TYPE
static final int TXT_TYPE
static final int XML_TYPE
Method Detail |
---|
void parse(Reader source, Sink sink) throws ParseException
source
- not null reader that provides the source document.
You could use newReader
methods from ReaderFactory
.sink
- A sink that consumes the Doxia events.
ParseException
- if the model could not be parsed.int getType()
UNKNOWN_TYPE
, TXT_TYPE
or
XML_TYPE
.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |