Package org.apache.maven.usability.plugin.io.xpp3

Class ParamdocXpp3Reader

java.lang.Object

org.apache.maven.usability.plugin.io.xpp3.ParamdocXpp3Reader

public class ParamdocXpp3Reader
extends Object

Class ParamdocXpp3Reader.

Version:

$Revision$ $Date$

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ParamdocXpp3Reader.ContentTransformer

Field Summary

Fields

Modifier and Type	Field	Description
final ParamdocXpp3Reader.ContentTransformer	contentTransformer	Field contentTransformer.

Constructor Summary

Constructors

Constructor	Description
ParamdocXpp3Reader()
ParamdocXpp3Reader(ParamdocXpp3Reader.ContentTransformer contentTransformer)

Method Summary

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

contentTransformer

public final ParamdocXpp3Reader.ContentTransformer contentTransformer

Field contentTransformer.

Constructor Details

ParamdocXpp3Reader

public ParamdocXpp3Reader()

ParamdocXpp3Reader

public ParamdocXpp3Reader(ParamdocXpp3Reader.ContentTransformer contentTransformer)

Method Details

getAddDefaultEntities

public boolean getAddDefaultEntities()

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

Returns:

boolean

read

public ExpressionDocumentation read(XmlPullParser parser,
 boolean strict)
                             throws IOException,
XmlPullParserException

Method read.

Parameters:

parser - a parser object.

strict - a strict object.

Returns:

ExpressionDocumentation

Throws:

IOException - IOException if any.

XmlPullParserException - XmlPullParserException if any.

read

public ExpressionDocumentation read(Reader reader,
 boolean strict)
                             throws IOException,
XmlPullParserException

Parameters:

reader - a reader object.

strict - a strict object.

Returns:

ExpressionDocumentation

Throws:

IOException - IOException if any.

XmlPullParserException - XmlPullParserException if any.

See Also:

• ReaderFactory.newXmlReader(java.io.InputStream)

read

public ExpressionDocumentation read(Reader reader)
                             throws IOException,
XmlPullParserException

Parameters:

reader - a reader object.

Returns:

ExpressionDocumentation

Throws:

IOException - IOException if any.

XmlPullParserException - XmlPullParserException if any.

See Also:

• ReaderFactory.newXmlReader(java.io.InputStream)

read

public ExpressionDocumentation read(InputStream in,
 boolean strict)
                             throws IOException,
XmlPullParserException

Method read.

Parameters:

in - a in object.

strict - a strict object.

Returns:

ExpressionDocumentation

Throws:

IOException - IOException if any.

XmlPullParserException - XmlPullParserException if any.

read

public ExpressionDocumentation read(InputStream in)
                             throws IOException,
XmlPullParserException

Method read.

Parameters:

in - a in object.

Returns:

ExpressionDocumentation

Throws:

IOException - IOException if any.

XmlPullParserException - XmlPullParserException if any.

setAddDefaultEntities

public void setAddDefaultEntities(boolean addDefaultEntities)

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

Parameters:

addDefaultEntities - a addDefaultEntities object.