|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.maven.doxia.parser.AbstractParser
public abstract class AbstractParser
An abstract base class that defines some convenience methods for parsers. Provides a macro mechanism to give dynamic functionalities for the parsing.
Field Summary |
---|
Fields inherited from interface org.apache.maven.doxia.parser.Parser |
---|
ROLE, TXT_TYPE, UNKNOWN_TYPE, XML_TYPE |
Constructor Summary | |
---|---|
AbstractParser()
|
Method Summary | |
---|---|
protected static String |
doxiaVersion()
The current Doxia version. |
void |
enableLogging(Log log)
Enable a Doxia logger for this Doxia component. |
void |
executeMacro(String macroId,
MacroRequest request,
Sink sink)
Execute a macro on the given sink. |
protected File |
getBasedir()
Deprecated. this does not work in multi-module builds, see DOXIA-373 |
protected Log |
getLog()
Returns the current logger for this parser. |
protected MacroManager |
getMacroManager()
Gets the current MacroManager . |
int |
getType()
The parser type value could be Parser.UNKNOWN_TYPE , Parser.TXT_TYPE or
Parser.XML_TYPE . |
protected void |
init()
Initialize the parser. |
protected boolean |
isSecondParsing()
Indicates if we are currently parsing a second time. |
void |
parse(String string,
Sink sink)
Convenience method to parse an arbitrary string and emit events into the given sink. |
void |
setSecondParsing(boolean second)
Set secondParsing to true, if we need a second parsing. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface org.apache.maven.doxia.parser.Parser |
---|
parse |
Constructor Detail |
---|
public AbstractParser()
Method Detail |
---|
public int getType()
Parser.UNKNOWN_TYPE
, Parser.TXT_TYPE
or
Parser.XML_TYPE
.
getType
in interface Parser
public void executeMacro(String macroId, MacroRequest request, Sink sink) throws MacroExecutionException, MacroNotFoundException
macroId
- An id to lookup the macro.request
- The corresponding MacroRequest.sink
- The sink to receive the events.
MacroExecutionException
- if an error occurred during execution.
MacroNotFoundException
- if the macro could not be found.protected File getBasedir()
public void parse(String string, Sink sink) throws ParseException
string
- A string that provides the source input.sink
- A sink that consumes the Doxia events.
ParseException
- if the string could not be parsed.public void setSecondParsing(boolean second)
secondParsing
to true, if we need a second parsing.
second
- True for second parsing.protected boolean isSecondParsing()
public void enableLogging(Log log)
Doxia
logger for this Doxia
component.
enableLogging
in interface LogEnabled
log
- a Log.protected Log getLog()
protected MacroManager getMacroManager()
MacroManager
.
MacroManager
.protected void init()
Parser.parse(java.io.Reader, org.apache.maven.doxia.sink.Sink)
and can be used
to set the parser into a clear state so it can be re-used.
protected static String doxiaVersion()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |