org.xwiki.rendering.parser
Interface StreamParser

All Known Implementing Classes:

PlainTextStreamParser

@ComponentRole
public interface StreamParser

Streaming based parser. Instead of returning a resulting XDOM it send events during the parsing.

Since:

2.1M1

Version:

$Id$

Method Summary

Syntax	getSyntax()
void	parse(Reader source, Listener listener)

Method Detail

getSyntax

Syntax getSyntax()

Returns:

the wiki syntax the parser is implementing

parse

void parse(Reader source,
           Listener listener)
           throws ParseException

Parameters:

source - the content to parse

listener - receive event for each element

Throws:

ParseException - if the source cannot be read or an unexpected error happens during the parsing. Parsers should be written to not generate any error as much as possible.