Package org.apache.maven.doxia.parser
Interface Parser
- All Superinterfaces:
LogEnabled
- All Known Implementing Classes:
AbstractParser
,AbstractTextParser
,AbstractXmlParser
,AptParser
,ConfluenceParser
,DocBookParser
,FmlContentParser
,FmlParser
,TWikiParser
,XdocParser
,Xhtml5BaseParser
,Xhtml5Parser
,XhtmlBaseParser
,XhtmlParser
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.
- Since:
- 1.0
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
The Plexus lookup role.static final int
Text parser typestatic final int
Unknown parser typestatic final int
XML parser type -
Method Summary
Modifier and TypeMethodDescriptionint
getType()
boolean
Does the parser emit Doxia comments event when comments found in source?void
Parses the given source model and emits Doxia events into the given sink.void
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?Methods inherited from interface org.apache.maven.doxia.logging.LogEnabled
enableLogging
-
Field Details
-
ROLE
The Plexus lookup role. -
UNKNOWN_TYPE
static final int UNKNOWN_TYPEUnknown parser type- See Also:
-
TXT_TYPE
static final int TXT_TYPEText parser type- See Also:
-
XML_TYPE
static final int XML_TYPEXML parser type- See Also:
-
-
Method Details
-
parse
Parses the given source model and emits Doxia events into the given sink.- Parameters:
source
- not null reader that provides the source document. You could usenewReader
methods fromReaderFactory
.sink
- A sink that consumes the Doxia events.- Throws:
ParseException
- if the model could not be parsed.
-
parse
Parses the given source model and emits Doxia events into the given sink.- Parameters:
source
- not null reader that provides the source document. You could usenewReader
methods fromReaderFactory
.sink
- A sink that consumes the Doxia events.reference
- the reference- Throws:
ParseException
- if the model could not be parsed.
-
getType
int getType()- Returns:
- the type of Parser
-
setEmitComments
void setEmitComments(boolean emitComments) When comments are found in source markup, emit comment Doxia events or just ignore?- Parameters:
emitComments
-true
(default value) to emit comment Doxia events
-
isEmitComments
boolean isEmitComments()Does the parser emit Doxia comments event when comments found in source?- Returns:
true
(default value) if comment Doxia events are emitted
-