Package 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 Object

Class JavadocOptionsXpp3Reader.

Version:

$Revision$ $Date$

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	JavadocOptionsXpp3Reader.ContentTransformer

Field Summary

Fields

Modifier and Type	Field	Description
JavadocOptionsXpp3Reader.ContentTransformer	contentTransformer	Field contentTransformer.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
boolean	getAddDefaultEntities()	Returns the state of the "add default entities" flag.
JavadocOptions	read(InputStream in)	Method read.
JavadocOptions	read(InputStream in, boolean strict)	Method read.
JavadocOptions	read(Reader reader)
JavadocOptions	read(Reader reader, boolean strict)
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

contentTransformer

public final JavadocOptionsXpp3Reader.ContentTransformer contentTransformer

Field contentTransformer.

Constructor Detail

JavadocOptionsXpp3Reader

public JavadocOptionsXpp3Reader()

JavadocOptionsXpp3Reader

public JavadocOptionsXpp3Reader(JavadocOptionsXpp3Reader.ContentTransformer contentTransformer)

Method Detail

getAddDefaultEntities

public boolean getAddDefaultEntities()

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

Returns:

boolean

read

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

Method read.

Parameters:

parser - a parser object.

strict - a strict object.

Returns:

JavadocOptions

Throws:

IOException - IOException if any.

org.codehaus.plexus.util.xml.pull.XmlPullParserException - XmlPullParserException if any.

read

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

Parameters:

reader - a reader object.

strict - a strict object.

Returns:

JavadocOptions

Throws:

IOException - IOException if any.

org.codehaus.plexus.util.xml.pull.XmlPullParserException - XmlPullParserException if any.

See Also:

XmlStreamReader

read

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

Parameters:

reader - a reader object.

Returns:

JavadocOptions

Throws:

IOException - IOException if any.

org.codehaus.plexus.util.xml.pull.XmlPullParserException - XmlPullParserException if any.

See Also:

XmlStreamReader

read

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

Method read.

Parameters:

in - a in object.

strict - a strict object.

Returns:

JavadocOptions

Throws:

IOException - IOException if any.

org.codehaus.plexus.util.xml.pull.XmlPullParserException - XmlPullParserException if any.

read

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

Method read.

Parameters:

in - a in object.

Returns:

JavadocOptions

Throws:

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.