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

Class SiteXpp3Reader

java.lang.Object

org.apache.maven.doxia.site.io.xpp3.SiteXpp3Reader

public class SiteXpp3Reader
extends java.lang.Object

Class SiteXpp3Reader.

Version:

$Revision$ $Date$

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SiteXpp3Reader.ContentTransformer

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	Description
SiteXpp3Reader()
SiteXpp3Reader(SiteXpp3Reader.ContentTransformer contentTransformer)

Method Summary

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

Field contentTransformer.

Constructor Detail

SiteXpp3Reader

public SiteXpp3Reader()

SiteXpp3Reader

public SiteXpp3Reader(SiteXpp3Reader.ContentTransformer contentTransformer)

Method Detail

getAddDefaultEntities

public boolean getAddDefaultEntities()

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

Returns:

boolean

read

public SiteModel 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 - a parser object.

strict - a strict object.

Returns:

SiteModel

Throws:

java.io.IOException - IOException if any.

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

read

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

Parameters:

reader - a reader object.

strict - a strict object.

Returns:

SiteModel

Throws:

java.io.IOException - IOException if any.

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

See Also:

XmlStreamReader

read

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

Parameters:

reader - a reader object.

Returns:

SiteModel

Throws:

java.io.IOException - IOException if any.

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

See Also:

XmlStreamReader

read

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

Method read.

Parameters:

in - a in object.

strict - a strict object.

Returns:

SiteModel

Throws:

java.io.IOException - IOException if any.

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

read

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

Method read.

Parameters:

in - a in object.

Returns:

SiteModel

Throws:

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