org.apache.maven.doxia.module.confluence
Class ConfluenceParser

java.lang.Object
  extended by org.apache.maven.doxia.parser.AbstractParser
      extended by org.apache.maven.doxia.parser.AbstractTextParser
          extended by org.apache.maven.doxia.module.confluence.ConfluenceParser
All Implemented Interfaces:
LogEnabled, Markup, TextMarkup, Parser

public class ConfluenceParser
extends AbstractTextParser

Parse the Confluence. See Confluence Notation Guide Overview

Since:
1.0
Version:
$Id: ConfluenceParser.java 1090706 2011-04-09 23:15:28Z hboutemy $
Plexus component:
role:
"org.apache.maven.doxia.parser.Parser"
role-hint:
"confluence"

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
ConfluenceParser()
          Constructor for ConfluenceParser.
 
Method Summary
protected  void init()
          Initialize the parser.
 void parse(Reader source, Sink sink)
          Parses the given source model and emits Doxia events into the given sink.
 
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, isSecondParsing, parse, setSecondParsing
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ConfluenceParser

public ConfluenceParser()

Constructor for ConfluenceParser.

Method Detail

parse

public void parse(Reader source,
                  Sink sink)
           throws ParseException
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 use newReader methods from ReaderFactory.
sink - A sink that consumes the Doxia events.
Throws:
ParseException - if the model could not be parsed.

init

protected void init()
Initialize the parser. This is called first by 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.

Overrides:
init in class AbstractParser


Copyright © 2005-2012 The Apache Software Foundation. All Rights Reserved.