Package org.apache.maven.doxia.document.io.xpp3

Class DocumentXpp3Reader

  • public class DocumentXpp3Reader
extends java.lang.Object
    Class DocumentXpp3Reader.
    Version:
    $Revision$ $Date$

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      private boolean checkFieldWithDuplicate​(org.codehaus.plexus.util.xml.pull.XmlPullParser parser, java.lang.String tagName, java.lang.String alias, java.util.Set parsed)
      Method checkFieldWithDuplicate.
      private void checkUnknownAttribute​(org.codehaus.plexus.util.xml.pull.XmlPullParser parser, java.lang.String attribute, java.lang.String tagName, boolean strict)
      Method checkUnknownAttribute.
      private void checkUnknownElement​(org.codehaus.plexus.util.xml.pull.XmlPullParser parser, boolean strict)
      Method checkUnknownElement.
      boolean getAddDefaultEntities()
      Returns the state of the "add default entities" flag.
      private boolean getBooleanValue​(java.lang.String s, java.lang.String attribute, org.codehaus.plexus.util.xml.pull.XmlPullParser parser)
      Method getBooleanValue.
      private boolean getBooleanValue​(java.lang.String s, java.lang.String attribute, org.codehaus.plexus.util.xml.pull.XmlPullParser parser, java.lang.String defaultValue)
      Method getBooleanValue.
      private byte getByteValue​(java.lang.String s, java.lang.String attribute, org.codehaus.plexus.util.xml.pull.XmlPullParser parser, boolean strict)
      Method getByteValue.
      private char getCharacterValue​(java.lang.String s, java.lang.String attribute, org.codehaus.plexus.util.xml.pull.XmlPullParser parser)
      Method getCharacterValue.
      private java.util.Date getDateValue​(java.lang.String s, java.lang.String attribute, java.lang.String dateFormat, org.codehaus.plexus.util.xml.pull.XmlPullParser parser)
      Method getDateValue.
      private java.util.Date getDateValue​(java.lang.String s, java.lang.String attribute, org.codehaus.plexus.util.xml.pull.XmlPullParser parser)
      Method getDateValue.
      private double getDoubleValue​(java.lang.String s, java.lang.String attribute, org.codehaus.plexus.util.xml.pull.XmlPullParser parser, boolean strict)
      Method getDoubleValue.
      private float getFloatValue​(java.lang.String s, java.lang.String attribute, org.codehaus.plexus.util.xml.pull.XmlPullParser parser, boolean strict)
      Method getFloatValue.
      private int getIntegerValue​(java.lang.String s, java.lang.String attribute, org.codehaus.plexus.util.xml.pull.XmlPullParser parser, boolean strict)
      Method getIntegerValue.
      private long getLongValue​(java.lang.String s, java.lang.String attribute, org.codehaus.plexus.util.xml.pull.XmlPullParser parser, boolean strict)
      Method getLongValue.
      private java.lang.String getRequiredAttributeValue​(java.lang.String s, java.lang.String attribute, org.codehaus.plexus.util.xml.pull.XmlPullParser parser, boolean strict)
      Method getRequiredAttributeValue.
      private short getShortValue​(java.lang.String s, java.lang.String attribute, org.codehaus.plexus.util.xml.pull.XmlPullParser parser, boolean strict)
      Method getShortValue.
      private java.lang.String getTrimmedValue​(java.lang.String s)
      Method getTrimmedValue.
      private java.lang.String interpolatedTrimmed​(java.lang.String value, java.lang.String context)
      Method interpolatedTrimmed.
      private int nextTag​(org.codehaus.plexus.util.xml.pull.XmlPullParser parser)
      Method nextTag.
      private DocumentAuthor parseDocumentAuthor​(org.codehaus.plexus.util.xml.pull.XmlPullParser parser, boolean strict)
      Method parseDocumentAuthor.
      private DocumentCover parseDocumentCover​(org.codehaus.plexus.util.xml.pull.XmlPullParser parser, boolean strict)
      Method parseDocumentCover.
      private DocumentHyperlinkBehaviour parseDocumentHyperlinkBehaviour​(org.codehaus.plexus.util.xml.pull.XmlPullParser parser, boolean strict)
      Method parseDocumentHyperlinkBehaviour.
      private DocumentMeta parseDocumentMeta​(org.codehaus.plexus.util.xml.pull.XmlPullParser parser, boolean strict)
      Method parseDocumentMeta.
      private DocumentModel parseDocumentModel​(org.codehaus.plexus.util.xml.pull.XmlPullParser parser, boolean strict)
      Method parseDocumentModel.
      private DocumentStatistic parseDocumentStatistic​(org.codehaus.plexus.util.xml.pull.XmlPullParser parser, boolean strict)
      Method parseDocumentStatistic.
      private DocumentTemplate parseDocumentTemplate​(org.codehaus.plexus.util.xml.pull.XmlPullParser parser, boolean strict)
      Method parseDocumentTemplate.
      private DocumentTOC parseDocumentTOC​(org.codehaus.plexus.util.xml.pull.XmlPullParser parser, boolean strict)
      Method parseDocumentTOC.
      private DocumentTOCItem parseDocumentTOCItem​(org.codehaus.plexus.util.xml.pull.XmlPullParser parser, boolean strict)
      Method parseDocumentTOCItem.
      DocumentModel read​(java.io.InputStream in)
      Method read.
      DocumentModel read​(java.io.InputStream in, boolean strict)
      Method read.
      DocumentModel read​(java.io.Reader reader)  
      DocumentModel read​(java.io.Reader reader, boolean strict)  
      private DocumentModel read​(org.codehaus.plexus.util.xml.pull.XmlPullParser parser, boolean strict)
      Method read.
      void setAddDefaultEntities​(boolean addDefaultEntities)
      Sets the state of the "add default entities" flag.

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • addDefaultEntities

        private boolean addDefaultEntities
        If set the parser will be loaded with all single characters from the XHTML specification. The entities used:
        • http://www.w3.org/TR/xhtml1/DTD/xhtml-lat1.ent
        • http://www.w3.org/TR/xhtml1/DTD/xhtml-special.ent
        • http://www.w3.org/TR/xhtml1/DTD/xhtml-symbol.ent

    • Method Detail

      • checkFieldWithDuplicate

        private boolean checkFieldWithDuplicate​(org.codehaus.plexus.util.xml.pull.XmlPullParser parser,
                                        java.lang.String tagName,
                                        java.lang.String alias,
                                        java.util.Set parsed)
                                 throws org.codehaus.plexus.util.xml.pull.XmlPullParserException
        Method checkFieldWithDuplicate.
        Parameters:
        parser - a parser object.
        parsed - a parsed object.
        alias - a alias object.
        tagName - a tagName object.
        Returns:
        boolean
        Throws:
        org.codehaus.plexus.util.xml.pull.XmlPullParserException - XmlPullParserException if any.

      • checkUnknownAttribute

        private void checkUnknownAttribute​(org.codehaus.plexus.util.xml.pull.XmlPullParser parser,
                                   java.lang.String attribute,
                                   java.lang.String tagName,
                                   boolean strict)
                            throws org.codehaus.plexus.util.xml.pull.XmlPullParserException,
                                   java.io.IOException
        Method checkUnknownAttribute.
        Parameters:
        parser - a parser object.
        strict - a strict object.
        tagName - a tagName object.
        attribute - a attribute object.
        Throws:
        org.codehaus.plexus.util.xml.pull.XmlPullParserException - XmlPullParserException if any.
        java.io.IOException - IOException if any.

      • checkUnknownElement

        private void checkUnknownElement​(org.codehaus.plexus.util.xml.pull.XmlPullParser parser,
                                 boolean strict)
                          throws org.codehaus.plexus.util.xml.pull.XmlPullParserException,
                                 java.io.IOException
        Method checkUnknownElement.
        Parameters:
        parser - a parser object.
        strict - a strict object.
        Throws:
        org.codehaus.plexus.util.xml.pull.XmlPullParserException - XmlPullParserException if any.
        java.io.IOException - IOException if any.

      • getAddDefaultEntities

        public boolean getAddDefaultEntities()
        Returns the state of the "add default entities" flag.
        Returns:
        boolean

      • getBooleanValue

        private boolean getBooleanValue​(java.lang.String s,
                                java.lang.String attribute,
                                org.codehaus.plexus.util.xml.pull.XmlPullParser parser)
                         throws org.codehaus.plexus.util.xml.pull.XmlPullParserException
        Method getBooleanValue.
        Parameters:
        s - a s object.
        parser - a parser object.
        attribute - a attribute object.
        Returns:
        boolean
        Throws:
        org.codehaus.plexus.util.xml.pull.XmlPullParserException - XmlPullParserException if any.

      • getBooleanValue

        private boolean getBooleanValue​(java.lang.String s,
                                java.lang.String attribute,
                                org.codehaus.plexus.util.xml.pull.XmlPullParser parser,
                                java.lang.String defaultValue)
                         throws org.codehaus.plexus.util.xml.pull.XmlPullParserException
        Method getBooleanValue.
        Parameters:
        s - a s object.
        defaultValue - a defaultValue object.
        parser - a parser object.
        attribute - a attribute object.
        Returns:
        boolean
        Throws:
        org.codehaus.plexus.util.xml.pull.XmlPullParserException - XmlPullParserException if any.

      • getByteValue

        private byte getByteValue​(java.lang.String s,
                          java.lang.String attribute,
                          org.codehaus.plexus.util.xml.pull.XmlPullParser parser,
                          boolean strict)
                   throws org.codehaus.plexus.util.xml.pull.XmlPullParserException
        Method getByteValue.
        Parameters:
        s - a s object.
        strict - a strict object.
        parser - a parser object.
        attribute - a attribute object.
        Returns:
        byte
        Throws:
        org.codehaus.plexus.util.xml.pull.XmlPullParserException - XmlPullParserException if any.

      • getCharacterValue

        private char getCharacterValue​(java.lang.String s,
                               java.lang.String attribute,
                               org.codehaus.plexus.util.xml.pull.XmlPullParser parser)
                        throws org.codehaus.plexus.util.xml.pull.XmlPullParserException
        Method getCharacterValue.
        Parameters:
        s - a s object.
        parser - a parser object.
        attribute - a attribute object.
        Returns:
        char
        Throws:
        org.codehaus.plexus.util.xml.pull.XmlPullParserException - XmlPullParserException if any.

      • getDateValue

        private java.util.Date getDateValue​(java.lang.String s,
                                    java.lang.String attribute,
                                    org.codehaus.plexus.util.xml.pull.XmlPullParser parser)
                             throws org.codehaus.plexus.util.xml.pull.XmlPullParserException
        Method getDateValue.
        Parameters:
        s - a s object.
        parser - a parser object.
        attribute - a attribute object.
        Returns:
        Date
        Throws:
        org.codehaus.plexus.util.xml.pull.XmlPullParserException - XmlPullParserException if any.

      • getDateValue

        private java.util.Date getDateValue​(java.lang.String s,
                                    java.lang.String attribute,
                                    java.lang.String dateFormat,
                                    org.codehaus.plexus.util.xml.pull.XmlPullParser parser)
                             throws org.codehaus.plexus.util.xml.pull.XmlPullParserException
        Method getDateValue.
        Parameters:
        s - a s object.
        parser - a parser object.
        dateFormat - a dateFormat object.
        attribute - a attribute object.
        Returns:
        Date
        Throws:
        org.codehaus.plexus.util.xml.pull.XmlPullParserException - XmlPullParserException if any.

      • getDoubleValue

        private double getDoubleValue​(java.lang.String s,
                              java.lang.String attribute,
                              org.codehaus.plexus.util.xml.pull.XmlPullParser parser,
                              boolean strict)
                       throws org.codehaus.plexus.util.xml.pull.XmlPullParserException
        Method getDoubleValue.
        Parameters:
        s - a s object.
        strict - a strict object.
        parser - a parser object.
        attribute - a attribute object.
        Returns:
        double
        Throws:
        org.codehaus.plexus.util.xml.pull.XmlPullParserException - XmlPullParserException if any.

      • getFloatValue

        private float getFloatValue​(java.lang.String s,
                            java.lang.String attribute,
                            org.codehaus.plexus.util.xml.pull.XmlPullParser parser,
                            boolean strict)
                     throws org.codehaus.plexus.util.xml.pull.XmlPullParserException
        Method getFloatValue.
        Parameters:
        s - a s object.
        strict - a strict object.
        parser - a parser object.
        attribute - a attribute object.
        Returns:
        float
        Throws:
        org.codehaus.plexus.util.xml.pull.XmlPullParserException - XmlPullParserException if any.

      • getIntegerValue

        private int getIntegerValue​(java.lang.String s,
                            java.lang.String attribute,
                            org.codehaus.plexus.util.xml.pull.XmlPullParser parser,
                            boolean strict)
                     throws org.codehaus.plexus.util.xml.pull.XmlPullParserException
        Method getIntegerValue.
        Parameters:
        s - a s object.
        strict - a strict object.
        parser - a parser object.
        attribute - a attribute object.
        Returns:
        int
        Throws:
        org.codehaus.plexus.util.xml.pull.XmlPullParserException - XmlPullParserException if any.

      • getLongValue

        private long getLongValue​(java.lang.String s,
                          java.lang.String attribute,
                          org.codehaus.plexus.util.xml.pull.XmlPullParser parser,
                          boolean strict)
                   throws org.codehaus.plexus.util.xml.pull.XmlPullParserException
        Method getLongValue.
        Parameters:
        s - a s object.
        strict - a strict object.
        parser - a parser object.
        attribute - a attribute object.
        Returns:
        long
        Throws:
        org.codehaus.plexus.util.xml.pull.XmlPullParserException - XmlPullParserException if any.

      • getRequiredAttributeValue

        private java.lang.String getRequiredAttributeValue​(java.lang.String s,
                                                   java.lang.String attribute,
                                                   org.codehaus.plexus.util.xml.pull.XmlPullParser parser,
                                                   boolean strict)
                                            throws org.codehaus.plexus.util.xml.pull.XmlPullParserException
        Method getRequiredAttributeValue.
        Parameters:
        s - a s object.
        strict - a strict object.
        parser - a parser object.
        attribute - a attribute object.
        Returns:
        String
        Throws:
        org.codehaus.plexus.util.xml.pull.XmlPullParserException - XmlPullParserException if any.

      • getShortValue

        private short getShortValue​(java.lang.String s,
                            java.lang.String attribute,
                            org.codehaus.plexus.util.xml.pull.XmlPullParser parser,
                            boolean strict)
                     throws org.codehaus.plexus.util.xml.pull.XmlPullParserException
        Method getShortValue.
        Parameters:
        s - a s object.
        strict - a strict object.
        parser - a parser object.
        attribute - a attribute object.
        Returns:
        short
        Throws:
        org.codehaus.plexus.util.xml.pull.XmlPullParserException - XmlPullParserException if any.

      • getTrimmedValue

        private java.lang.String getTrimmedValue​(java.lang.String s)
        Method getTrimmedValue.
        Parameters:
        s - a s object.
        Returns:
        String

      • interpolatedTrimmed

        private java.lang.String interpolatedTrimmed​(java.lang.String value,
                                             java.lang.String context)
        Method interpolatedTrimmed.
        Parameters:
        value - a value object.
        context - a context object.
        Returns:
        String

      • nextTag

        private int nextTag​(org.codehaus.plexus.util.xml.pull.XmlPullParser parser)
             throws java.io.IOException,
                    org.codehaus.plexus.util.xml.pull.XmlPullParserException
        Method nextTag.
        Parameters:
        parser - a parser object.
        Returns:
        int
        Throws:
        java.io.IOException - IOException if any.
        org.codehaus.plexus.util.xml.pull.XmlPullParserException - XmlPullParserException if any.

      • read

        public DocumentModel read​(java.io.Reader reader,
                          boolean strict)
                   throws java.io.IOException,
                          org.codehaus.plexus.util.xml.pull.XmlPullParserException
        Parameters:
        reader - a reader object.
        strict - a strict object.
        Returns:
        DocumentModel
        Throws:
        java.io.IOException - IOException if any.
        org.codehaus.plexus.util.xml.pull.XmlPullParserException - XmlPullParserException if any.
        See Also:
        ReaderFactory.newXmlReader(java.io.InputStream)

      • read

        public DocumentModel read​(java.io.Reader reader)
                   throws java.io.IOException,
                          org.codehaus.plexus.util.xml.pull.XmlPullParserException
        Parameters:
        reader - a reader object.
        Returns:
        DocumentModel
        Throws:
        java.io.IOException - IOException if any.
        org.codehaus.plexus.util.xml.pull.XmlPullParserException - XmlPullParserException if any.
        See Also:
        ReaderFactory.newXmlReader(java.io.InputStream)

      • read

        public DocumentModel read​(java.io.InputStream in,
                          boolean strict)
                   throws java.io.IOException,
                          org.codehaus.plexus.util.xml.pull.XmlPullParserException
        Method read.
        Parameters:
        in - a in object.
        strict - a strict object.
        Returns:
        DocumentModel
        Throws:
        java.io.IOException - IOException if any.
        org.codehaus.plexus.util.xml.pull.XmlPullParserException - XmlPullParserException if any.

      • read

        public DocumentModel read​(java.io.InputStream in)
                   throws java.io.IOException,
                          org.codehaus.plexus.util.xml.pull.XmlPullParserException
        Method read.
        Parameters:
        in - a in object.
        Returns:
        DocumentModel
        Throws:
        java.io.IOException - IOException if any.
        org.codehaus.plexus.util.xml.pull.XmlPullParserException - XmlPullParserException if any.

      • parseDocumentAuthor

        private DocumentAuthor parseDocumentAuthor​(org.codehaus.plexus.util.xml.pull.XmlPullParser parser,
                                           boolean strict)
                                    throws java.io.IOException,
                                           org.codehaus.plexus.util.xml.pull.XmlPullParserException
        Method parseDocumentAuthor.
        Parameters:
        parser - a parser object.
        strict - a strict object.
        Returns:
        DocumentAuthor
        Throws:
        java.io.IOException - IOException if any.
        org.codehaus.plexus.util.xml.pull.XmlPullParserException - XmlPullParserException if any.

      • parseDocumentCover

        private DocumentCover parseDocumentCover​(org.codehaus.plexus.util.xml.pull.XmlPullParser parser,
                                         boolean strict)
                                  throws java.io.IOException,
                                         org.codehaus.plexus.util.xml.pull.XmlPullParserException
        Method parseDocumentCover.
        Parameters:
        parser - a parser object.
        strict - a strict object.
        Returns:
        DocumentCover
        Throws:
        java.io.IOException - IOException if any.
        org.codehaus.plexus.util.xml.pull.XmlPullParserException - XmlPullParserException if any.

      • parseDocumentHyperlinkBehaviour

        private DocumentHyperlinkBehaviour parseDocumentHyperlinkBehaviour​(org.codehaus.plexus.util.xml.pull.XmlPullParser parser,
                                                                   boolean strict)
                                                            throws java.io.IOException,
                                                                   org.codehaus.plexus.util.xml.pull.XmlPullParserException
        Method parseDocumentHyperlinkBehaviour.
        Parameters:
        parser - a parser object.
        strict - a strict object.
        Returns:
        DocumentHyperlinkBehaviour
        Throws:
        java.io.IOException - IOException if any.
        org.codehaus.plexus.util.xml.pull.XmlPullParserException - XmlPullParserException if any.

      • parseDocumentMeta

        private DocumentMeta parseDocumentMeta​(org.codehaus.plexus.util.xml.pull.XmlPullParser parser,
                                       boolean strict)
                                throws java.io.IOException,
                                       org.codehaus.plexus.util.xml.pull.XmlPullParserException
        Method parseDocumentMeta.
        Parameters:
        parser - a parser object.
        strict - a strict object.
        Returns:
        DocumentMeta
        Throws:
        java.io.IOException - IOException if any.
        org.codehaus.plexus.util.xml.pull.XmlPullParserException - XmlPullParserException if any.

      • parseDocumentModel

        private DocumentModel parseDocumentModel​(org.codehaus.plexus.util.xml.pull.XmlPullParser parser,
                                         boolean strict)
                                  throws java.io.IOException,
                                         org.codehaus.plexus.util.xml.pull.XmlPullParserException
        Method parseDocumentModel.
        Parameters:
        parser - a parser object.
        strict - a strict object.
        Returns:
        DocumentModel
        Throws:
        java.io.IOException - IOException if any.
        org.codehaus.plexus.util.xml.pull.XmlPullParserException - XmlPullParserException if any.

      • parseDocumentStatistic

        private DocumentStatistic parseDocumentStatistic​(org.codehaus.plexus.util.xml.pull.XmlPullParser parser,
                                                 boolean strict)
                                          throws java.io.IOException,
                                                 org.codehaus.plexus.util.xml.pull.XmlPullParserException
        Method parseDocumentStatistic.
        Parameters:
        parser - a parser object.
        strict - a strict object.
        Returns:
        DocumentStatistic
        Throws:
        java.io.IOException - IOException if any.
        org.codehaus.plexus.util.xml.pull.XmlPullParserException - XmlPullParserException if any.

      • parseDocumentTOC

        private DocumentTOC parseDocumentTOC​(org.codehaus.plexus.util.xml.pull.XmlPullParser parser,
                                     boolean strict)
                              throws java.io.IOException,
                                     org.codehaus.plexus.util.xml.pull.XmlPullParserException
        Method parseDocumentTOC.
        Parameters:
        parser - a parser object.
        strict - a strict object.
        Returns:
        DocumentTOC
        Throws:
        java.io.IOException - IOException if any.
        org.codehaus.plexus.util.xml.pull.XmlPullParserException - XmlPullParserException if any.

      • parseDocumentTOCItem

        private DocumentTOCItem parseDocumentTOCItem​(org.codehaus.plexus.util.xml.pull.XmlPullParser parser,
                                             boolean strict)
                                      throws java.io.IOException,
                                             org.codehaus.plexus.util.xml.pull.XmlPullParserException
        Method parseDocumentTOCItem.
        Parameters:
        parser - a parser object.
        strict - a strict object.
        Returns:
        DocumentTOCItem
        Throws:
        java.io.IOException - IOException if any.
        org.codehaus.plexus.util.xml.pull.XmlPullParserException - XmlPullParserException if any.

      • parseDocumentTemplate

        private DocumentTemplate parseDocumentTemplate​(org.codehaus.plexus.util.xml.pull.XmlPullParser parser,
                                               boolean strict)
                                        throws java.io.IOException,
                                               org.codehaus.plexus.util.xml.pull.XmlPullParserException
        Method parseDocumentTemplate.
        Parameters:
        parser - a parser object.
        strict - a strict object.
        Returns:
        DocumentTemplate
        Throws:
        java.io.IOException - IOException if any.
        org.codehaus.plexus.util.xml.pull.XmlPullParserException - XmlPullParserException if any.

      • read

        private DocumentModel read​(org.codehaus.plexus.util.xml.pull.XmlPullParser parser,
                           boolean strict)
                    throws java.io.IOException,
                           org.codehaus.plexus.util.xml.pull.XmlPullParserException
        Method read.
        Parameters:
        parser - a parser object.
        strict - a strict object.
        Returns:
        DocumentModel
        Throws:
        java.io.IOException - IOException if any.
        org.codehaus.plexus.util.xml.pull.XmlPullParserException - XmlPullParserException if any.

      • setAddDefaultEntities

        public void setAddDefaultEntities​(boolean addDefaultEntities)
        Sets the state of the "add default entities" flag.
        Parameters:
        addDefaultEntities - a addDefaultEntities object.