Package org.apache.maven.doxia

Class DefaultDoxia

  • All Implemented Interfaces:
    Doxia
    @Singleton
@Named
public class DefaultDoxia
extends java.lang.Object
implements Doxia
    Simple implementation of the Doxia interface: uses a ParserManager to lookup a parser.
    Since:
    1.0
    Author:
    Jason van Zyl

    • Constructor Summary

      Constructors 
      Constructor Description
      DefaultDoxia()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      Parser getParser​(java.lang.String parserId)
      Return a parser for the given parserId.
      void parse​(java.io.Reader source, java.lang.String parserId, org.apache.maven.doxia.sink.Sink sink)
      Parses the given source model using a parser with given id, and emits Doxia events into the given sink.
      void parse​(java.io.Reader source, java.lang.String parserId, org.apache.maven.doxia.sink.Sink sink, java.lang.String reference)
      Parses the given source model using a parser with given id, and emits Doxia events into the given sink.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • DefaultDoxia

        public DefaultDoxia()

    • Method Detail

      • parse

        public void parse​(java.io.Reader source,
                  java.lang.String parserId,
                  org.apache.maven.doxia.sink.Sink sink)
           throws ParserNotFoundException,
                  ParseException
        Description copied from interface: Doxia
        Parses the given source model using a parser with given id, and emits Doxia events into the given sink.
        Specified by:
        parse in interface Doxia
        Parameters:
        source - not null reader that provides the source document
        parserId - identifier for the parser to use
        sink - a sink that consumes the Doxia events
        Throws:
        ParserNotFoundException - if no parser could be found for the given id
        ParseException - if the model could not be parsed

      • parse

        public void parse​(java.io.Reader source,
                  java.lang.String parserId,
                  org.apache.maven.doxia.sink.Sink sink,
                  java.lang.String reference)
           throws ParserNotFoundException,
                  ParseException
        Description copied from interface: Doxia
        Parses the given source model using a parser with given id, and emits Doxia events into the given sink.
        Specified by:
        parse in interface Doxia
        Parameters:
        source - not null reader that provides the source document
        parserId - identifier for the parser to use
        sink - a sink that consumes the Doxia events
        reference - string containing the reference to the source (e.g. filename)
        Throws:
        ParserNotFoundException - if no parser could be found for the given id
        ParseException - if the model could not be parsed

      • getParser

        public Parser getParser​(java.lang.String parserId)
                 throws ParserNotFoundException
        Description copied from interface: Doxia
        Return a parser for the given parserId.
        Specified by:
        getParser in interface Doxia
        Parameters:
        parserId - identifier for the parser to use
        Returns:
        the parser identified by parserId
        Throws:
        ParserNotFoundException - if no parser could be found for the given id