public interface Parser extends LogEnabled
Modifier and Type | Field and Description |
---|---|
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
|
Modifier and Type | Method and Description |
---|---|
int |
getType()
|
boolean |
isEmitComments()
Does the parser emit Doxia comments event when comments found in source?
|
void |
parse(Reader source,
Sink sink)
Parses the given source model and emits Doxia events into the given sink.
|
void |
parse(Reader source,
Sink sink,
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?
|
enableLogging
static final int UNKNOWN_TYPE
static final int TXT_TYPE
static final int XML_TYPE
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.void parse(Reader source, Sink sink, 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 emittedCopyright © 2005–2016 The Apache Software Foundation. All rights reserved.