Class TWikiParser
- java.lang.Object
-
- org.apache.maven.doxia.parser.AbstractParser
-
- org.apache.maven.doxia.parser.AbstractTextParser
-
- org.apache.maven.doxia.module.twiki.TWikiParser
-
- All Implemented Interfaces:
org.apache.maven.doxia.logging.LogEnabled
,org.apache.maven.doxia.markup.Markup
,org.apache.maven.doxia.markup.TextMarkup
,org.apache.maven.doxia.parser.Parser
@Component(role=org.apache.maven.doxia.parser.Parser.class, hint="twiki") public class TWikiParser extends org.apache.maven.doxia.parser.AbstractTextParser
Parse the twiki file format- Since:
- 1.0
- Author:
- Juan F. Codagnone
-
-
Field Summary
-
Fields inherited from interface org.apache.maven.doxia.markup.Markup
COLON, EOL, EQUAL, GREATER_THAN, LEFT_CURLY_BRACKET, LEFT_SQUARE_BRACKET, LESS_THAN, MINUS, PLUS, QUOTE, RIGHT_CURLY_BRACKET, RIGHT_SQUARE_BRACKET, SEMICOLON, SLASH, SPACE, STAR
-
-
Constructor Summary
Constructors Constructor Description TWikiParser()
Creates the TWikiParser.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
getTitle(java.util.List<Block> blocks, org.apache.maven.doxia.util.ByLineSource source)
Guess a title for the page.protected void
init()
void
parse(java.io.Reader source, org.apache.maven.doxia.sink.Sink sink)
void
parse(java.io.Reader source, org.apache.maven.doxia.sink.Sink sink, java.lang.String reference)
java.util.List<Block>
parse(org.apache.maven.doxia.util.ByLineSource source)
parse.
-
-
-
Method Detail
-
parse
public final java.util.List<Block> parse(org.apache.maven.doxia.util.ByLineSource source) throws org.apache.maven.doxia.parser.ParseException
parse.
- Parameters:
source
- source to parse.- Returns:
- the blocks that represent source.
- Throws:
org.apache.maven.doxia.parser.ParseException
- on error.
-
parse
public void parse(java.io.Reader source, org.apache.maven.doxia.sink.Sink sink) throws org.apache.maven.doxia.parser.ParseException
- Throws:
org.apache.maven.doxia.parser.ParseException
-
parse
public final void parse(java.io.Reader source, org.apache.maven.doxia.sink.Sink sink, java.lang.String reference) throws org.apache.maven.doxia.parser.ParseException
- Specified by:
parse
in interfaceorg.apache.maven.doxia.parser.Parser
- Overrides:
parse
in classorg.apache.maven.doxia.parser.AbstractParser
- Throws:
org.apache.maven.doxia.parser.ParseException
-
getTitle
public final java.lang.String getTitle(java.util.List<Block> blocks, org.apache.maven.doxia.util.ByLineSource source)
Guess a title for the page. It uses the first section that it finds. If it doesn't find any section tries to get it fromByLineReaderSource.getName()
- Parameters:
blocks
- blocks to parsesource
- source to parse- Returns:
- a title for a page
- Since:
- 1.1
-
init
protected void init()
- Overrides:
init
in classorg.apache.maven.doxia.parser.AbstractParser
-
-