Interface Parser

All Superinterfaces:
LogEnabled
All Known Implementing Classes:
AbstractParser, AbstractTextParser, AbstractXmlParser, AptParser, ConfluenceParser, DocBookParser, FmlContentParser, FmlParser, TWikiParser, XdocParser, Xhtml5BaseParser, Xhtml5Parser, XhtmlBaseParser, XhtmlParser

public interface Parser extends LogEnabled
A Parser is responsible for parsing any document in a supported front-end format, and emitting the standard Doxia events, which can then be consumed by any Doxia Sink.
Since:
1.0
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    The Plexus lookup role.
    static final int
    Text parser type
    static final int
    Unknown parser type
    static final int
    XML parser type
  • Method Summary

    Modifier and Type
    Method
    Description
    int
    The parser type value could be UNKNOWN_TYPE, TXT_TYPE or XML_TYPE.
    boolean
    Does the parser emit Doxia comments event when comments found in source?
    void
    parse(Reader source, Sink sink)
    Parses the given source model and emits Doxia events into the given sink.
    void
    parse(Reader source, Sink sink, String reference)
    Parses the given source model and emits Doxia events into the given sink.
    void
    setEmitComments(boolean emitComments)
    When comments are found in source markup, emit comment Doxia events or just ignore?

    Methods inherited from interface org.apache.maven.doxia.logging.LogEnabled

    enableLogging
  • Field Details

  • Method Details

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

      int getType()
      The parser type value could be UNKNOWN_TYPE, TXT_TYPE or XML_TYPE.
      Returns:
      the type of Parser
    • 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