Interface HighlightParser

  • All Superinterfaces:
    org.xwiki.rendering.parser.Parser
    All Known Implementing Classes:
    AbstractHighlightParser

    @Role
    public interface HighlightParser
    extends org.xwiki.rendering.parser.Parser
    Convert provided source to an highlighted version.
    Since:
    1.7RC1
    Version:
    $Id: 40ff60bc2fb57be51b2878b3116359602843e482 $
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      List<org.xwiki.rendering.block.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, parse
    • Method Detail

      • highlight

        List<org.xwiki.rendering.block.Block> highlight​(String syntaxId,
                                                        Reader source)
                                                 throws org.xwiki.rendering.parser.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:
        org.xwiki.rendering.parser.ParseException - the highlighting failed.