Interface Parser


  • @Role
    public interface Parser
    Parse content into a XDOM (a tree of Blocks).
    Since:
    1.5M2
    Version:
    $Id: 235687e107afcb5a6926bf3c857faa7070941b70 $
    • Method Detail

      • getSyntax

        Syntax getSyntax()
        Returns:
        the syntax the parser is implementing
      • parse

        XDOM parse​(Reader source)
            throws ParseException
        Parameters:
        source - the content to parse
        Returns:
        the tree representation of the content as Blocks
        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.
      • parse

        @Unstable
        default XDOM parse​(Reader source,
                           IdGenerator idGenerator)
                    throws ParseException
        Parameters:
        source - the content to parse
        idGenerator - the id generator to use for automatically generating ids during parsing
        Returns:
        the tree representation of the content as Blocks
        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.
        Since:
        14.2RC1