|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.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 | |
---|---|
protected MacroManager |
macroManager
|
protected boolean |
secondParsing
Indicates that a second parsing is required. |
Fields inherited from interface org.apache.maven.doxia.parser.Parser |
---|
JUSTIFY_CENTER, JUSTIFY_LEFT, JUSTIFY_RIGHT, ROLE, TXT_TYPE, UNKNOWN_TYPE, XML_TYPE |
Constructor Summary | |
---|---|
AbstractParser()
|
Method Summary | |
---|---|
void |
executeMacro(java.lang.String macroId,
MacroRequest request,
org.apache.maven.doxia.sink.Sink sink)
Execute a macro on the given sink. |
protected java.io.File |
getBasedir()
Returns the current base directory. |
int |
getType()
The parser type value could be Parser.UNKNOWN_TYPE , Parser.TXT_TYPE or
Parser.XML_TYPE . |
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 |
Field Detail |
---|
protected boolean secondParsing
protected MacroManager macroManager
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(java.lang.String macroId, MacroRequest request, org.apache.maven.doxia.sink.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 java.io.File getBasedir()
public void setSecondParsing(boolean second)
secondParsing
to true, if we need a second parsing.
second
- True for second parsing.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |