org.xwiki.rendering.parser
Interface HighlightParser

All Superinterfaces:
Parser
All Known Implementing Classes:
AbstractHighlightParser, PygmentsParser

@Role
public interface HighlightParser
extends Parser

Convert provided source to an highlighted version.

Since:
1.7RC1

Method Summary
 List<Block> highlight(String syntaxId, Reader source)
          Return a highlighted version of the provided content.
 
Methods inherited from interface org.xwiki.rendering.parser.Parser
getSyntax, parse
 

Method Detail

highlight

List<Block> highlight(String syntaxId,
                      Reader source)
                      throws ParseException
Return a highlighted version of the provided content.

Parameters:
syntaxId - the identifier of the source syntax.
source - the content to highlight.
Returns:
the highlighted version of the provided source.
Throws:
ParseException - the highlighting failed.