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

Class DocumentXpp3Reader

java.lang.Object

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

public class DocumentXpp3Reader
extends Object

Class DocumentXpp3Reader.

Version:

$Revision$ $Date$

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DocumentXpp3Reader.ContentTransformer

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	addDefaultEntities	If set the parser will be loaded with all single characters from the XHTML specification.
final DocumentXpp3Reader.ContentTransformer	contentTransformer	Field contentTransformer.

Constructor Summary

Constructors

Constructor	Description
DocumentXpp3Reader()
DocumentXpp3Reader(DocumentXpp3Reader.ContentTransformer contentTransformer)

Method Summary

Modifier and Type	Method	Description
private boolean	checkFieldWithDuplicate(org.codehaus.plexus.util.xml.pull.XmlPullParser parser, String tagName, String alias, Set parsed)	Method checkFieldWithDuplicate.
private void	checkUnknownAttribute(org.codehaus.plexus.util.xml.pull.XmlPullParser parser, String attribute, 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(String s, String attribute, org.codehaus.plexus.util.xml.pull.XmlPullParser parser)	Method getBooleanValue.
private boolean	getBooleanValue(String s, String attribute, org.codehaus.plexus.util.xml.pull.XmlPullParser parser, String defaultValue)	Method getBooleanValue.
private byte	getByteValue(String s, String attribute, org.codehaus.plexus.util.xml.pull.XmlPullParser parser, boolean strict)	Method getByteValue.
private char	getCharacterValue(String s, String attribute, org.codehaus.plexus.util.xml.pull.XmlPullParser parser)	Method getCharacterValue.
private Date	getDateValue(String s, String attribute, String dateFormat, org.codehaus.plexus.util.xml.pull.XmlPullParser parser)	Method getDateValue.
private Date	getDateValue(String s, String attribute, org.codehaus.plexus.util.xml.pull.XmlPullParser parser)	Method getDateValue.
private double	getDoubleValue(String s, String attribute, org.codehaus.plexus.util.xml.pull.XmlPullParser parser, boolean strict)	Method getDoubleValue.
private float	getFloatValue(String s, String attribute, org.codehaus.plexus.util.xml.pull.XmlPullParser parser, boolean strict)	Method getFloatValue.
private int	getIntegerValue(String s, String attribute, org.codehaus.plexus.util.xml.pull.XmlPullParser parser, boolean strict)	Method getIntegerValue.
private long	getLongValue(String s, String attribute, org.codehaus.plexus.util.xml.pull.XmlPullParser parser, boolean strict)	Method getLongValue.
private String	getRequiredAttributeValue(String s, String attribute, org.codehaus.plexus.util.xml.pull.XmlPullParser parser, boolean strict)	Method getRequiredAttributeValue.
private short	getShortValue(String s, String attribute, org.codehaus.plexus.util.xml.pull.XmlPullParser parser, boolean strict)	Method getShortValue.
private String	getTrimmedValue(String s)	Method getTrimmedValue.
private String	interpolatedTrimmed(String value, 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(InputStream in)	Method read.
DocumentModel	read(InputStream in, boolean strict)	Method read.
DocumentModel	read(Reader reader)
DocumentModel	read(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 Details

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

contentTransformer

public final DocumentXpp3Reader.ContentTransformer contentTransformer

Field contentTransformer.

Constructor Details

DocumentXpp3Reader

public DocumentXpp3Reader()

DocumentXpp3Reader

public DocumentXpp3Reader(DocumentXpp3Reader.ContentTransformer contentTransformer)

Method Details

checkFieldWithDuplicate

private boolean checkFieldWithDuplicate(org.codehaus.plexus.util.xml.pull.XmlPullParser parser,
 String tagName,
 String alias,
 Set parsed)
                                 throws org.codehaus.plexus.util.xml.pull.XmlPullParserException

Method checkFieldWithDuplicate.

Parameters:

parser -

parsed -

alias -

tagName -

Returns:

boolean

Throws:

org.codehaus.plexus.util.xml.pull.XmlPullParserException

checkUnknownAttribute

private void checkUnknownAttribute(org.codehaus.plexus.util.xml.pull.XmlPullParser parser,
 String attribute,
 String tagName,
 boolean strict)
                            throws org.codehaus.plexus.util.xml.pull.XmlPullParserException,
IOException

Method checkUnknownAttribute.

Parameters:

parser -

strict -

tagName -

attribute -

Throws:

org.codehaus.plexus.util.xml.pull.XmlPullParserException

IOException

checkUnknownElement

private void checkUnknownElement(org.codehaus.plexus.util.xml.pull.XmlPullParser parser,
 boolean strict)
                          throws org.codehaus.plexus.util.xml.pull.XmlPullParserException,
IOException

Method checkUnknownElement.

Parameters:

parser -

strict -

Throws:

org.codehaus.plexus.util.xml.pull.XmlPullParserException

IOException

getAddDefaultEntities

public boolean getAddDefaultEntities()

Returns the state of the "add default entities" flag.

Returns:

boolean

getBooleanValue

private boolean getBooleanValue(String s,
 String attribute,
 org.codehaus.plexus.util.xml.pull.XmlPullParser parser)
                         throws org.codehaus.plexus.util.xml.pull.XmlPullParserException

Method getBooleanValue.

Parameters:

s -

parser -

attribute -

Returns:

boolean

Throws:

org.codehaus.plexus.util.xml.pull.XmlPullParserException

getBooleanValue

private boolean getBooleanValue(String s,
 String attribute,
 org.codehaus.plexus.util.xml.pull.XmlPullParser parser,
 String defaultValue)
                         throws org.codehaus.plexus.util.xml.pull.XmlPullParserException

Method getBooleanValue.

Parameters:

s -

defaultValue -

parser -

attribute -

Returns:

boolean

Throws:

org.codehaus.plexus.util.xml.pull.XmlPullParserException

getByteValue

private byte getByteValue(String s,
 String attribute,
 org.codehaus.plexus.util.xml.pull.XmlPullParser parser,
 boolean strict)
                   throws org.codehaus.plexus.util.xml.pull.XmlPullParserException

Method getByteValue.

Parameters:

s -

strict -

parser -

attribute -

Returns:

byte

Throws:

org.codehaus.plexus.util.xml.pull.XmlPullParserException

getCharacterValue

private char getCharacterValue(String s,
 String attribute,
 org.codehaus.plexus.util.xml.pull.XmlPullParser parser)
                        throws org.codehaus.plexus.util.xml.pull.XmlPullParserException

Method getCharacterValue.

Parameters:

s -

parser -

attribute -

Returns:

char

Throws:

org.codehaus.plexus.util.xml.pull.XmlPullParserException

getDateValue

private Date getDateValue(String s,
 String attribute,
 org.codehaus.plexus.util.xml.pull.XmlPullParser parser)
                   throws org.codehaus.plexus.util.xml.pull.XmlPullParserException

Method getDateValue.

Parameters:

s -

parser -

attribute -

Returns:

Date

Throws:

org.codehaus.plexus.util.xml.pull.XmlPullParserException

getDateValue

private Date getDateValue(String s,
 String attribute,
 String dateFormat,
 org.codehaus.plexus.util.xml.pull.XmlPullParser parser)
                   throws org.codehaus.plexus.util.xml.pull.XmlPullParserException

Method getDateValue.

Parameters:

s -

parser -

dateFormat -

attribute -

Returns:

Date

Throws:

org.codehaus.plexus.util.xml.pull.XmlPullParserException

getDoubleValue

private double getDoubleValue(String s,
 String attribute,
 org.codehaus.plexus.util.xml.pull.XmlPullParser parser,
 boolean strict)
                       throws org.codehaus.plexus.util.xml.pull.XmlPullParserException

Method getDoubleValue.

Parameters:

s -

strict -

parser -

attribute -

Returns:

double

Throws:

org.codehaus.plexus.util.xml.pull.XmlPullParserException

getFloatValue

private float getFloatValue(String s,
 String attribute,
 org.codehaus.plexus.util.xml.pull.XmlPullParser parser,
 boolean strict)
                     throws org.codehaus.plexus.util.xml.pull.XmlPullParserException

Method getFloatValue.

Parameters:

s -

strict -

parser -

attribute -

Returns:

float

Throws:

org.codehaus.plexus.util.xml.pull.XmlPullParserException

getIntegerValue

private int getIntegerValue(String s,
 String attribute,
 org.codehaus.plexus.util.xml.pull.XmlPullParser parser,
 boolean strict)
                     throws org.codehaus.plexus.util.xml.pull.XmlPullParserException

Method getIntegerValue.

Parameters:

s -

strict -

parser -

attribute -

Returns:

int

Throws:

org.codehaus.plexus.util.xml.pull.XmlPullParserException

getLongValue

private long getLongValue(String s,
 String attribute,
 org.codehaus.plexus.util.xml.pull.XmlPullParser parser,
 boolean strict)
                   throws org.codehaus.plexus.util.xml.pull.XmlPullParserException

Method getLongValue.

Parameters:

s -

strict -

parser -

attribute -

Returns:

long

Throws:

org.codehaus.plexus.util.xml.pull.XmlPullParserException

getRequiredAttributeValue

private String getRequiredAttributeValue(String s,
 String attribute,
 org.codehaus.plexus.util.xml.pull.XmlPullParser parser,
 boolean strict)
                                  throws org.codehaus.plexus.util.xml.pull.XmlPullParserException

Method getRequiredAttributeValue.

Parameters:

s -

strict -

parser -

attribute -

Returns:

String

Throws:

org.codehaus.plexus.util.xml.pull.XmlPullParserException

getShortValue

private short getShortValue(String s,
 String attribute,
 org.codehaus.plexus.util.xml.pull.XmlPullParser parser,
 boolean strict)
                     throws org.codehaus.plexus.util.xml.pull.XmlPullParserException

Method getShortValue.

Parameters:

s -

strict -

parser -

attribute -

Returns:

short

Throws:

org.codehaus.plexus.util.xml.pull.XmlPullParserException

getTrimmedValue

private String getTrimmedValue(String s)

Method getTrimmedValue.

Parameters:

s -

Returns:

String

interpolatedTrimmed

private String interpolatedTrimmed(String value,
 String context)

Method interpolatedTrimmed.

Parameters:

value -

context -

Returns:

String

nextTag

private int nextTag(org.codehaus.plexus.util.xml.pull.XmlPullParser parser)
             throws IOException,
org.codehaus.plexus.util.xml.pull.XmlPullParserException

Method nextTag.

Parameters:

parser -

Returns:

int

Throws:

IOException

org.codehaus.plexus.util.xml.pull.XmlPullParserException

read

public DocumentModel read(Reader reader,
 boolean strict)
                   throws IOException,
org.codehaus.plexus.util.xml.pull.XmlPullParserException

Parameters:

reader -

strict -

Returns:

DocumentModel

Throws:

IOException

org.codehaus.plexus.util.xml.pull.XmlPullParserException

See Also:

• ReaderFactory.newXmlReader(java.io.InputStream)

read

public DocumentModel read(Reader reader)
                   throws IOException,
org.codehaus.plexus.util.xml.pull.XmlPullParserException

Parameters:

reader -

Returns:

DocumentModel

Throws:

IOException

org.codehaus.plexus.util.xml.pull.XmlPullParserException

See Also:

• ReaderFactory.newXmlReader(java.io.InputStream)

read

public DocumentModel read(InputStream in,
 boolean strict)
                   throws IOException,
org.codehaus.plexus.util.xml.pull.XmlPullParserException

Method read.

Parameters:

in -

strict -

Returns:

DocumentModel

Throws:

IOException

org.codehaus.plexus.util.xml.pull.XmlPullParserException

read

public DocumentModel read(InputStream in)
                   throws IOException,
org.codehaus.plexus.util.xml.pull.XmlPullParserException

Method read.

Parameters:

in -

Returns:

DocumentModel

Throws:

IOException

org.codehaus.plexus.util.xml.pull.XmlPullParserException

parseDocumentAuthor

private DocumentAuthor parseDocumentAuthor(org.codehaus.plexus.util.xml.pull.XmlPullParser parser,
 boolean strict)
                                    throws IOException,
org.codehaus.plexus.util.xml.pull.XmlPullParserException

Method parseDocumentAuthor.

Parameters:

parser -

strict -

Returns:

DocumentAuthor

Throws:

IOException

org.codehaus.plexus.util.xml.pull.XmlPullParserException

parseDocumentCover

private DocumentCover parseDocumentCover(org.codehaus.plexus.util.xml.pull.XmlPullParser parser,
 boolean strict)
                                  throws IOException,
org.codehaus.plexus.util.xml.pull.XmlPullParserException

Method parseDocumentCover.

Parameters:

parser -

strict -

Returns:

DocumentCover

Throws:

IOException

org.codehaus.plexus.util.xml.pull.XmlPullParserException

parseDocumentHyperlinkBehaviour

private DocumentHyperlinkBehaviour parseDocumentHyperlinkBehaviour(org.codehaus.plexus.util.xml.pull.XmlPullParser parser,
 boolean strict)
                                                            throws IOException,
org.codehaus.plexus.util.xml.pull.XmlPullParserException

Method parseDocumentHyperlinkBehaviour.

Parameters:

parser -

strict -

Returns:

DocumentHyperlinkBehaviour

Throws:

IOException

org.codehaus.plexus.util.xml.pull.XmlPullParserException

parseDocumentMeta

private DocumentMeta parseDocumentMeta(org.codehaus.plexus.util.xml.pull.XmlPullParser parser,
 boolean strict)
                                throws IOException,
org.codehaus.plexus.util.xml.pull.XmlPullParserException

Method parseDocumentMeta.

Parameters:

parser -

strict -

Returns:

DocumentMeta

Throws:

IOException

org.codehaus.plexus.util.xml.pull.XmlPullParserException

parseDocumentModel

private DocumentModel parseDocumentModel(org.codehaus.plexus.util.xml.pull.XmlPullParser parser,
 boolean strict)
                                  throws IOException,
org.codehaus.plexus.util.xml.pull.XmlPullParserException

Method parseDocumentModel.

Parameters:

parser -

strict -

Returns:

DocumentModel

Throws:

IOException

org.codehaus.plexus.util.xml.pull.XmlPullParserException

parseDocumentStatistic

private DocumentStatistic parseDocumentStatistic(org.codehaus.plexus.util.xml.pull.XmlPullParser parser,
 boolean strict)
                                          throws IOException,
org.codehaus.plexus.util.xml.pull.XmlPullParserException

Method parseDocumentStatistic.

Parameters:

parser -

strict -

Returns:

DocumentStatistic

Throws:

IOException

org.codehaus.plexus.util.xml.pull.XmlPullParserException

parseDocumentTOC

private DocumentTOC parseDocumentTOC(org.codehaus.plexus.util.xml.pull.XmlPullParser parser,
 boolean strict)
                              throws IOException,
org.codehaus.plexus.util.xml.pull.XmlPullParserException

Method parseDocumentTOC.

Parameters:

parser -

strict -

Returns:

DocumentTOC

Throws:

IOException

org.codehaus.plexus.util.xml.pull.XmlPullParserException

parseDocumentTOCItem

private DocumentTOCItem parseDocumentTOCItem(org.codehaus.plexus.util.xml.pull.XmlPullParser parser,
 boolean strict)
                                      throws IOException,
org.codehaus.plexus.util.xml.pull.XmlPullParserException

Method parseDocumentTOCItem.

Parameters:

parser -

strict -

Returns:

DocumentTOCItem

Throws:

IOException

org.codehaus.plexus.util.xml.pull.XmlPullParserException

parseDocumentTemplate

private DocumentTemplate parseDocumentTemplate(org.codehaus.plexus.util.xml.pull.XmlPullParser parser,
 boolean strict)
                                        throws IOException,
org.codehaus.plexus.util.xml.pull.XmlPullParserException

Method parseDocumentTemplate.

Parameters:

parser -

strict -

Returns:

DocumentTemplate

Throws:

IOException

org.codehaus.plexus.util.xml.pull.XmlPullParserException

read

private DocumentModel read(org.codehaus.plexus.util.xml.pull.XmlPullParser parser,
 boolean strict)
                    throws IOException,
org.codehaus.plexus.util.xml.pull.XmlPullParserException

Method read.

Parameters:

parser -

strict -

Returns:

DocumentModel

Throws:

IOException

org.codehaus.plexus.util.xml.pull.XmlPullParserException

setAddDefaultEntities

public void setAddDefaultEntities(boolean addDefaultEntities)

Sets the state of the "add default entities" flag.

Parameters:

addDefaultEntities -