org.apache.maven.plugins.pmd.model.io.xpp3

Class PmdXpp3Reader

java.lang.Object

org.apache.maven.plugins.pmd.model.io.xpp3.PmdXpp3Reader

public class PmdXpp3Reader
extends Object

Class PmdXpp3Reader.

Version:

$Revision$ $Date$

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	PmdXpp3Reader.ContentTransformer

Field Summary

Fields

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

Constructor Summary

Constructors

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

Method Summary

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

Field contentTransformer.

Constructor Detail

PmdXpp3Reader

public PmdXpp3Reader()

PmdXpp3Reader

public PmdXpp3Reader(PmdXpp3Reader.ContentTransformer contentTransformer)

Method Detail

getAddDefaultEntities

public boolean getAddDefaultEntities()

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

Returns:

boolean

read

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

Parameters:

reader - a reader object.

strict - a strict object.

Returns:

PmdErrorDetail

Throws:

IOException - IOException if any.

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

See Also:

ReaderFactory.newXmlReader(java.io.InputStream)

read

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

Parameters:

reader - a reader object.

Returns:

PmdErrorDetail

Throws:

IOException - IOException if any.

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

See Also:

ReaderFactory.newXmlReader(java.io.InputStream)

read

public PmdErrorDetail 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:

PmdErrorDetail

Throws:

IOException - IOException if any.

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

read

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

Method read.

Parameters:

in - a in object.

Returns:

PmdErrorDetail

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.