org.apache.maven.doxia.logging.LogEnabledAbstractParser, AbstractTextParser, AbstractXmlParser, XhtmlBaseParserpublic interface Parser
extends org.apache.maven.doxia.logging.LogEnabled
| Modifier and Type | Field | Description |
|---|---|---|
static java.lang.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
|
| Modifier and Type | Method | Description |
|---|---|---|
int |
getType() |
|
boolean |
isEmitComments() |
Does the parser emit Doxia comments event when comments found in source?
|
void |
parse(java.io.Reader source,
org.apache.maven.doxia.sink.Sink sink) |
Parses the given source model and emits Doxia events into the given sink.
|
void |
parse(java.io.Reader source,
org.apache.maven.doxia.sink.Sink sink,
java.lang.String reference) |
Parses the given source model and emits Doxia events into the given sink.
|
void |
setEmitComments(boolean emitComments) |
When comments are found in source markup, emit comment Doxia events or just ignore?
|
static final java.lang.String ROLE
static final int UNKNOWN_TYPE
static final int TXT_TYPE
static final int XML_TYPE
void parse(java.io.Reader source,
org.apache.maven.doxia.sink.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.void parse(java.io.Reader source,
org.apache.maven.doxia.sink.Sink sink,
java.lang.String reference)
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()
void setEmitComments(boolean emitComments)
emitComments - true (default value) to emit comment Doxia eventsboolean isEmitComments()
true (default value) if comment Doxia events are emitted