org.apache.maven.plugins.javadoc.options.io.xpp3

Class JavadocOptionsXpp3Reader

java.lang.Object

org.apache.maven.plugins.javadoc.options.io.xpp3.JavadocOptionsXpp3Reader

public class JavadocOptionsXpp3Reader
extends java.lang.Object

Class JavadocOptionsXpp3Reader.

Version:

$Revision$ $Date$

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	JavadocOptionsXpp3Reader.ContentTransformer

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
JavadocOptionsXpp3Reader()
JavadocOptionsXpp3Reader(JavadocOptionsXpp3Reader.ContentTransformer contentTransformer)

Method Summary

Modifier and Type	Method and 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 BootclasspathArtifact	parseBootclasspathArtifact(org.codehaus.plexus.util.xml.pull.XmlPullParser parser, boolean strict) Method parseBootclasspathArtifact.
private DocletArtifact	parseDocletArtifact(org.codehaus.plexus.util.xml.pull.XmlPullParser parser, boolean strict) Method parseDocletArtifact.
private Group	parseGroup(org.codehaus.plexus.util.xml.pull.XmlPullParser parser, boolean strict) Method parseGroup.
private JavadocOptions	parseJavadocOptions(org.codehaus.plexus.util.xml.pull.XmlPullParser parser, boolean strict) Method parseJavadocOptions.
private JavadocPathArtifact	parseJavadocPathArtifact(org.codehaus.plexus.util.xml.pull.XmlPullParser parser, boolean strict) Method parseJavadocPathArtifact.
private OfflineLink	parseOfflineLink(org.codehaus.plexus.util.xml.pull.XmlPullParser parser, boolean strict) Method parseOfflineLink.
private ResourcesArtifact	parseResourcesArtifact(org.codehaus.plexus.util.xml.pull.XmlPullParser parser, boolean strict) Method parseResourcesArtifact.
private Tag	parseTag(org.codehaus.plexus.util.xml.pull.XmlPullParser parser, boolean strict) Method parseTag.
private Taglet	parseTaglet(org.codehaus.plexus.util.xml.pull.XmlPullParser parser, boolean strict) Method parseTaglet.
private TagletArtifact	parseTagletArtifact(org.codehaus.plexus.util.xml.pull.XmlPullParser parser, boolean strict) Method parseTagletArtifact.
JavadocOptions	read(java.io.InputStream in) Method read.
JavadocOptions	read(java.io.InputStream in, boolean strict) Method read.
JavadocOptions	read(java.io.Reader reader)
JavadocOptions	read(java.io.Reader reader, boolean strict)
private JavadocOptions	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

contentTransformer

public final JavadocOptionsXpp3Reader.ContentTransformer contentTransformer

Field contentTransformer.

Constructor Detail

JavadocOptionsXpp3Reader

public JavadocOptionsXpp3Reader()

JavadocOptionsXpp3Reader

public JavadocOptionsXpp3Reader(JavadocOptionsXpp3Reader.ContentTransformer contentTransformer)

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 -

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,
                                   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 -

strict -

tagName -

attribute -

Throws:

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

java.io.IOException

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 -

strict -

Throws:

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

java.io.IOException

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 -

parser -

attribute -

Returns:

boolean

Throws:

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

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 -

defaultValue -

parser -

attribute -

Returns:

boolean

Throws:

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

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 -

strict -

parser -

attribute -

Returns:

byte

Throws:

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

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 -

parser -

attribute -

Returns:

char

Throws:

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

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 -

parser -

attribute -

Returns:

Date

Throws:

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

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 -

parser -

dateFormat -

attribute -

Returns:

Date

Throws:

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

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 -

strict -

parser -

attribute -

Returns:

double

Throws:

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

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 -

strict -

parser -

attribute -

Returns:

float

Throws:

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

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 -

strict -

parser -

attribute -

Returns:

int

Throws:

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

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 -

strict -

parser -

attribute -

Returns:

long

Throws:

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

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 -

strict -

parser -

attribute -

Returns:

String

Throws:

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

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 -

strict -

parser -

attribute -

Returns:

short

Throws:

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

getTrimmedValue

private java.lang.String getTrimmedValue(java.lang.String s)

Method getTrimmedValue.

Parameters:

s -

Returns:

String

interpolatedTrimmed

private java.lang.String interpolatedTrimmed(java.lang.String value,
                                             java.lang.String context)

Method interpolatedTrimmed.

Parameters:

value -

context -

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 -

Returns:

int

Throws:

java.io.IOException

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

read

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

Parameters:

reader -

strict -

Returns:

JavadocOptions

Throws:

java.io.IOException

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

See Also:

ReaderFactory.newXmlReader(java.io.InputStream)

read

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

Parameters:

reader -

Returns:

JavadocOptions

Throws:

java.io.IOException

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

See Also:

ReaderFactory.newXmlReader(java.io.InputStream)

read

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

Method read.

Parameters:

in -

strict -

Returns:

JavadocOptions

Throws:

java.io.IOException

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

read

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

Method read.

Parameters:

in -

Returns:

JavadocOptions

Throws:

java.io.IOException

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

parseBootclasspathArtifact

private BootclasspathArtifact parseBootclasspathArtifact(org.codehaus.plexus.util.xml.pull.XmlPullParser parser,
                                                         boolean strict)
                                                  throws java.io.IOException,
                                                         org.codehaus.plexus.util.xml.pull.XmlPullParserException

Method parseBootclasspathArtifact.

Parameters:

parser -

strict -

Returns:

BootclasspathArtifact

Throws:

java.io.IOException

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

parseDocletArtifact

private DocletArtifact parseDocletArtifact(org.codehaus.plexus.util.xml.pull.XmlPullParser parser,
                                           boolean strict)
                                    throws java.io.IOException,
                                           org.codehaus.plexus.util.xml.pull.XmlPullParserException

Method parseDocletArtifact.

Parameters:

parser -

strict -

Returns:

DocletArtifact

Throws:

java.io.IOException

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

parseGroup

private Group parseGroup(org.codehaus.plexus.util.xml.pull.XmlPullParser parser,
                         boolean strict)
                  throws java.io.IOException,
                         org.codehaus.plexus.util.xml.pull.XmlPullParserException

Method parseGroup.

Parameters:

parser -

strict -

Returns:

Group

Throws:

java.io.IOException

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

parseJavadocOptions

private JavadocOptions parseJavadocOptions(org.codehaus.plexus.util.xml.pull.XmlPullParser parser,
                                           boolean strict)
                                    throws java.io.IOException,
                                           org.codehaus.plexus.util.xml.pull.XmlPullParserException

Method parseJavadocOptions.

Parameters:

parser -

strict -

Returns:

JavadocOptions

Throws:

java.io.IOException

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

parseJavadocPathArtifact

private JavadocPathArtifact parseJavadocPathArtifact(org.codehaus.plexus.util.xml.pull.XmlPullParser parser,
                                                     boolean strict)
                                              throws java.io.IOException,
                                                     org.codehaus.plexus.util.xml.pull.XmlPullParserException

Method parseJavadocPathArtifact.

Parameters:

parser -

strict -

Returns:

JavadocPathArtifact

Throws:

java.io.IOException

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

parseOfflineLink

private OfflineLink parseOfflineLink(org.codehaus.plexus.util.xml.pull.XmlPullParser parser,
                                     boolean strict)
                              throws java.io.IOException,
                                     org.codehaus.plexus.util.xml.pull.XmlPullParserException

Method parseOfflineLink.

Parameters:

parser -

strict -

Returns:

OfflineLink

Throws:

java.io.IOException

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

parseResourcesArtifact

private ResourcesArtifact parseResourcesArtifact(org.codehaus.plexus.util.xml.pull.XmlPullParser parser,
                                                 boolean strict)
                                          throws java.io.IOException,
                                                 org.codehaus.plexus.util.xml.pull.XmlPullParserException

Method parseResourcesArtifact.

Parameters:

parser -

strict -

Returns:

ResourcesArtifact

Throws:

java.io.IOException

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

parseTag

private Tag parseTag(org.codehaus.plexus.util.xml.pull.XmlPullParser parser,
                     boolean strict)
              throws java.io.IOException,
                     org.codehaus.plexus.util.xml.pull.XmlPullParserException

Method parseTag.

Parameters:

parser -

strict -

Returns:

Tag

Throws:

java.io.IOException

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

parseTaglet

private Taglet parseTaglet(org.codehaus.plexus.util.xml.pull.XmlPullParser parser,
                           boolean strict)
                    throws java.io.IOException,
                           org.codehaus.plexus.util.xml.pull.XmlPullParserException

Method parseTaglet.

Parameters:

parser -

strict -

Returns:

Taglet

Throws:

java.io.IOException

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

parseTagletArtifact

private TagletArtifact parseTagletArtifact(org.codehaus.plexus.util.xml.pull.XmlPullParser parser,
                                           boolean strict)
                                    throws java.io.IOException,
                                           org.codehaus.plexus.util.xml.pull.XmlPullParserException

Method parseTagletArtifact.

Parameters:

parser -

strict -

Returns:

TagletArtifact

Throws:

java.io.IOException

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

read

private JavadocOptions 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 -

strict -

Returns:

JavadocOptions

Throws:

java.io.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 -