org.apache.maven.doxia.module.twiki

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

Version:

$Id: TWikiParser.java 1726913 2016-01-26 22:01:54Z rfscholte $

Author:

Juan F. Codagnone

Field Summary

Fields inherited from interface org.apache.maven.doxia.markup.TextMarkup

PIPE

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

Fields inherited from interface org.apache.maven.doxia.parser.Parser

ROLE, TXT_TYPE, UNKNOWN_TYPE, XML_TYPE

Constructor Summary

Constructors

Constructor and Description
TWikiParser() Creates the TWikiParser.

Method Summary

Modifier and Type	Method and 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()
java.util.List<Block>	parse(org.apache.maven.doxia.util.ByLineSource source) parse.
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)

Methods inherited from class org.apache.maven.doxia.parser.AbstractTextParser

getType

Methods inherited from class org.apache.maven.doxia.parser.AbstractParser

doxiaVersion, enableLogging, executeMacro, getBasedir, getLog, getMacroManager, isEmitComments, isSecondParsing, parse, setEmitComments, setSecondParsing

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TWikiParser

public TWikiParser()

Creates the TWikiParser.

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 interface org.apache.maven.doxia.parser.Parser

Overrides:

parse in class org.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 from ByLineReaderSource.getName()

Parameters:

blocks - blocks to parse

source - source to parse

Returns:

a title for a page

Since:

1.1

init

protected void init()

Overrides:

init in class org.apache.maven.doxia.parser.AbstractParser