Interface Parser

    • Method Detail

      • parse

        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.
      • parse

        void parse​(Reader source,
                   Sink sink,
                   String reference)
            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.
        reference - the reference
        Throws:
        ParseException - if the model could not be parsed.
      • setEmitComments

        void setEmitComments​(boolean emitComments)
        When comments are found in source markup, emit comment Doxia events or just ignore?
        Parameters:
        emitComments - true (default value) to emit comment Doxia events
      • isEmitComments

        boolean isEmitComments()
        Does the parser emit Doxia comments event when comments found in source?
        Returns:
        true (default value) if comment Doxia events are emitted