Class DecorationXpp3Reader
java.lang.Object
org.apache.maven.doxia.site.decoration.io.xpp3.DecorationXpp3Reader
Class DecorationXpp3Reader.
- Version:
- $Revision$ $Date$
-
Nested Class Summary
Nested Classes -
Field Summary
FieldsModifier and TypeFieldDescriptionprivate boolean
If set the parser will be loaded with all single characters from the XHTML specification.Field contentTransformer. -
Constructor Summary
ConstructorsConstructorDescriptionDecorationXpp3Reader
(DecorationXpp3Reader.ContentTransformer contentTransformer) -
Method Summary
Modifier and TypeMethodDescriptionprivate boolean
checkFieldWithDuplicate
(org.codehaus.plexus.util.xml.pull.XmlPullParser parser, String tagName, String alias, Set parsed) Method checkFieldWithDuplicate.private void
checkUnknownAttribute
(org.codehaus.plexus.util.xml.pull.XmlPullParser parser, String attribute, String tagName, boolean strict) Method checkUnknownAttribute.private void
checkUnknownElement
(org.codehaus.plexus.util.xml.pull.XmlPullParser parser, boolean strict) Method checkUnknownElement.boolean
Returns the state of the "add default entities" flag.private boolean
getBooleanValue
(String s, String attribute, org.codehaus.plexus.util.xml.pull.XmlPullParser parser) Method getBooleanValue.private boolean
getBooleanValue
(String s, String attribute, org.codehaus.plexus.util.xml.pull.XmlPullParser parser, String defaultValue) Method getBooleanValue.private byte
getByteValue
(String s, String attribute, org.codehaus.plexus.util.xml.pull.XmlPullParser parser, boolean strict) Method getByteValue.private char
getCharacterValue
(String s, String attribute, org.codehaus.plexus.util.xml.pull.XmlPullParser parser) Method getCharacterValue.private Date
getDateValue
(String s, String attribute, String dateFormat, org.codehaus.plexus.util.xml.pull.XmlPullParser parser) Method getDateValue.private Date
getDateValue
(String s, String attribute, org.codehaus.plexus.util.xml.pull.XmlPullParser parser) Method getDateValue.private double
getDoubleValue
(String s, String attribute, org.codehaus.plexus.util.xml.pull.XmlPullParser parser, boolean strict) Method getDoubleValue.private float
getFloatValue
(String s, String attribute, org.codehaus.plexus.util.xml.pull.XmlPullParser parser, boolean strict) Method getFloatValue.private int
getIntegerValue
(String s, String attribute, org.codehaus.plexus.util.xml.pull.XmlPullParser parser, boolean strict) Method getIntegerValue.private long
getLongValue
(String s, String attribute, org.codehaus.plexus.util.xml.pull.XmlPullParser parser, boolean strict) Method getLongValue.private String
getRequiredAttributeValue
(String s, String attribute, org.codehaus.plexus.util.xml.pull.XmlPullParser parser, boolean strict) Method getRequiredAttributeValue.private short
getShortValue
(String s, String attribute, org.codehaus.plexus.util.xml.pull.XmlPullParser parser, boolean strict) Method getShortValue.private String
Method getTrimmedValue.private String
interpolatedTrimmed
(String value, String context) Method interpolatedTrimmed.private int
nextTag
(org.codehaus.plexus.util.xml.pull.XmlPullParser parser) Method nextTag.private Banner
parseBanner
(org.codehaus.plexus.util.xml.pull.XmlPullParser parser, boolean strict) Method parseBanner.private Body
parseBody
(org.codehaus.plexus.util.xml.pull.XmlPullParser parser, boolean strict) Method parseBody.private DecorationModel
parseDecorationModel
(org.codehaus.plexus.util.xml.pull.XmlPullParser parser, boolean strict) Method parseDecorationModel.private LinkItem
parseLinkItem
(org.codehaus.plexus.util.xml.pull.XmlPullParser parser, boolean strict) Method parseLinkItem.private Logo
parseLogo
(org.codehaus.plexus.util.xml.pull.XmlPullParser parser, boolean strict) Method parseLogo.private Menu
parseMenu
(org.codehaus.plexus.util.xml.pull.XmlPullParser parser, boolean strict) Method parseMenu.private MenuItem
parseMenuItem
(org.codehaus.plexus.util.xml.pull.XmlPullParser parser, boolean strict) Method parseMenuItem.private PublishDate
parsePublishDate
(org.codehaus.plexus.util.xml.pull.XmlPullParser parser, boolean strict) Method parsePublishDate.private Skin
parseSkin
(org.codehaus.plexus.util.xml.pull.XmlPullParser parser, boolean strict) Method parseSkin.private Version
parseVersion
(org.codehaus.plexus.util.xml.pull.XmlPullParser parser, boolean strict) Method parseVersion.read
(InputStream in) Method read.read
(InputStream in, boolean strict) Method read.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.
-
Field Details
-
addDefaultEntities
private boolean addDefaultEntitiesIf 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
Field contentTransformer.
-
-
Constructor Details
-
DecorationXpp3Reader
public DecorationXpp3Reader() -
DecorationXpp3Reader
-
-
Method Details
-
checkFieldWithDuplicate
private boolean checkFieldWithDuplicate(org.codehaus.plexus.util.xml.pull.XmlPullParser parser, String tagName, String alias, Set parsed) throws org.codehaus.plexus.util.xml.pull.XmlPullParserException Method checkFieldWithDuplicate.- Parameters:
parser
- a parser object.tagName
- a tagName object.alias
- a alias object.parsed
- a parsed object.- Returns:
- boolean
- Throws:
org.codehaus.plexus.util.xml.pull.XmlPullParserException
- XmlPullParserException if any.
-
checkUnknownAttribute
private void checkUnknownAttribute(org.codehaus.plexus.util.xml.pull.XmlPullParser parser, String attribute, String tagName, boolean strict) throws org.codehaus.plexus.util.xml.pull.XmlPullParserException, IOException Method checkUnknownAttribute.- Parameters:
parser
- a parser object.attribute
- a attribute object.tagName
- a tagName object.strict
- a strict object.- Throws:
org.codehaus.plexus.util.xml.pull.XmlPullParserException
- XmlPullParserException if any.IOException
- IOException if any.
-
checkUnknownElement
private void checkUnknownElement(org.codehaus.plexus.util.xml.pull.XmlPullParser parser, boolean strict) throws org.codehaus.plexus.util.xml.pull.XmlPullParserException, IOException Method checkUnknownElement.- Parameters:
parser
- a parser object.strict
- a strict object.- Throws:
org.codehaus.plexus.util.xml.pull.XmlPullParserException
- XmlPullParserException if any.IOException
- IOException if any.
-
getAddDefaultEntities
public boolean getAddDefaultEntities()Returns the state of the "add default entities" flag.- Returns:
- boolean
-
getBooleanValue
private boolean getBooleanValue(String s, String attribute, org.codehaus.plexus.util.xml.pull.XmlPullParser parser) throws org.codehaus.plexus.util.xml.pull.XmlPullParserException Method getBooleanValue.- Parameters:
s
- a s object.attribute
- a attribute object.parser
- a parser object.- Returns:
- boolean
- Throws:
org.codehaus.plexus.util.xml.pull.XmlPullParserException
- XmlPullParserException if any.
-
getBooleanValue
private boolean getBooleanValue(String s, String attribute, org.codehaus.plexus.util.xml.pull.XmlPullParser parser, String defaultValue) throws org.codehaus.plexus.util.xml.pull.XmlPullParserException Method getBooleanValue.- Parameters:
s
- a s object.attribute
- a attribute object.parser
- a parser object.defaultValue
- a defaultValue object.- Returns:
- boolean
- Throws:
org.codehaus.plexus.util.xml.pull.XmlPullParserException
- XmlPullParserException if any.
-
getByteValue
private byte getByteValue(String s, String attribute, org.codehaus.plexus.util.xml.pull.XmlPullParser parser, boolean strict) throws org.codehaus.plexus.util.xml.pull.XmlPullParserException Method getByteValue.- Parameters:
s
- a s object.attribute
- a attribute object.parser
- a parser object.strict
- a strict object.- Returns:
- byte
- Throws:
org.codehaus.plexus.util.xml.pull.XmlPullParserException
- XmlPullParserException if any.
-
getCharacterValue
private char getCharacterValue(String s, String attribute, org.codehaus.plexus.util.xml.pull.XmlPullParser parser) throws org.codehaus.plexus.util.xml.pull.XmlPullParserException Method getCharacterValue.- Parameters:
s
- a s object.attribute
- a attribute object.parser
- a parser object.- Returns:
- char
- Throws:
org.codehaus.plexus.util.xml.pull.XmlPullParserException
- XmlPullParserException if any.
-
getDateValue
private Date getDateValue(String s, String attribute, org.codehaus.plexus.util.xml.pull.XmlPullParser parser) throws org.codehaus.plexus.util.xml.pull.XmlPullParserException Method getDateValue.- Parameters:
s
- a s object.attribute
- a attribute object.parser
- a parser object.- Returns:
- Date
- Throws:
org.codehaus.plexus.util.xml.pull.XmlPullParserException
- XmlPullParserException if any.
-
getDateValue
private Date getDateValue(String s, String attribute, String dateFormat, org.codehaus.plexus.util.xml.pull.XmlPullParser parser) throws org.codehaus.plexus.util.xml.pull.XmlPullParserException Method getDateValue.- Parameters:
s
- a s object.attribute
- a attribute object.dateFormat
- a dateFormat object.parser
- a parser object.- Returns:
- Date
- Throws:
org.codehaus.plexus.util.xml.pull.XmlPullParserException
- XmlPullParserException if any.
-
getDoubleValue
private double getDoubleValue(String s, String attribute, org.codehaus.plexus.util.xml.pull.XmlPullParser parser, boolean strict) throws org.codehaus.plexus.util.xml.pull.XmlPullParserException Method getDoubleValue.- Parameters:
s
- a s object.attribute
- a attribute object.parser
- a parser object.strict
- a strict object.- Returns:
- double
- Throws:
org.codehaus.plexus.util.xml.pull.XmlPullParserException
- XmlPullParserException if any.
-
getFloatValue
private float getFloatValue(String s, String attribute, org.codehaus.plexus.util.xml.pull.XmlPullParser parser, boolean strict) throws org.codehaus.plexus.util.xml.pull.XmlPullParserException Method getFloatValue.- Parameters:
s
- a s object.attribute
- a attribute object.parser
- a parser object.strict
- a strict object.- Returns:
- float
- Throws:
org.codehaus.plexus.util.xml.pull.XmlPullParserException
- XmlPullParserException if any.
-
getIntegerValue
private int getIntegerValue(String s, String attribute, org.codehaus.plexus.util.xml.pull.XmlPullParser parser, boolean strict) throws org.codehaus.plexus.util.xml.pull.XmlPullParserException Method getIntegerValue.- Parameters:
s
- a s object.attribute
- a attribute object.parser
- a parser object.strict
- a strict object.- Returns:
- int
- Throws:
org.codehaus.plexus.util.xml.pull.XmlPullParserException
- XmlPullParserException if any.
-
getLongValue
private long getLongValue(String s, String attribute, org.codehaus.plexus.util.xml.pull.XmlPullParser parser, boolean strict) throws org.codehaus.plexus.util.xml.pull.XmlPullParserException Method getLongValue.- Parameters:
s
- a s object.attribute
- a attribute object.parser
- a parser object.strict
- a strict object.- Returns:
- long
- Throws:
org.codehaus.plexus.util.xml.pull.XmlPullParserException
- XmlPullParserException if any.
-
getRequiredAttributeValue
private String getRequiredAttributeValue(String s, String attribute, org.codehaus.plexus.util.xml.pull.XmlPullParser parser, boolean strict) throws org.codehaus.plexus.util.xml.pull.XmlPullParserException Method getRequiredAttributeValue.- Parameters:
s
- a s object.attribute
- a attribute object.parser
- a parser object.strict
- a strict object.- Returns:
- String
- Throws:
org.codehaus.plexus.util.xml.pull.XmlPullParserException
- XmlPullParserException if any.
-
getShortValue
private short getShortValue(String s, String attribute, org.codehaus.plexus.util.xml.pull.XmlPullParser parser, boolean strict) throws org.codehaus.plexus.util.xml.pull.XmlPullParserException Method getShortValue.- Parameters:
s
- a s object.attribute
- a attribute object.parser
- a parser object.strict
- a strict object.- Returns:
- short
- Throws:
org.codehaus.plexus.util.xml.pull.XmlPullParserException
- XmlPullParserException if any.
-
getTrimmedValue
Method getTrimmedValue.- Parameters:
s
- a s object.- Returns:
- String
-
interpolatedTrimmed
Method interpolatedTrimmed.- Parameters:
value
- a value object.context
- a context object.- Returns:
- String
-
nextTag
private int nextTag(org.codehaus.plexus.util.xml.pull.XmlPullParser parser) throws IOException, org.codehaus.plexus.util.xml.pull.XmlPullParserException Method nextTag.- Parameters:
parser
- a parser object.- Returns:
- int
- Throws:
IOException
- IOException if any.org.codehaus.plexus.util.xml.pull.XmlPullParserException
- XmlPullParserException if any.
-
read
public DecorationModel 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:
- DecorationModel
- Throws:
IOException
- IOException if any.org.codehaus.plexus.util.xml.pull.XmlPullParserException
- XmlPullParserException if any.
-
read
public DecorationModel read(Reader reader, boolean strict) throws IOException, org.codehaus.plexus.util.xml.pull.XmlPullParserException - Parameters:
reader
- a reader object.strict
- a strict object.- Returns:
- DecorationModel
- Throws:
IOException
- IOException if any.org.codehaus.plexus.util.xml.pull.XmlPullParserException
- XmlPullParserException if any.- See Also:
-
read
public DecorationModel read(Reader reader) throws IOException, org.codehaus.plexus.util.xml.pull.XmlPullParserException - Parameters:
reader
- a reader object.- Returns:
- DecorationModel
- Throws:
IOException
- IOException if any.org.codehaus.plexus.util.xml.pull.XmlPullParserException
- XmlPullParserException if any.- See Also:
-
read
public DecorationModel 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:
- DecorationModel
- Throws:
IOException
- IOException if any.org.codehaus.plexus.util.xml.pull.XmlPullParserException
- XmlPullParserException if any.
-
read
public DecorationModel read(InputStream in) throws IOException, org.codehaus.plexus.util.xml.pull.XmlPullParserException Method read.- Parameters:
in
- a in object.- Returns:
- DecorationModel
- Throws:
IOException
- IOException if any.org.codehaus.plexus.util.xml.pull.XmlPullParserException
- XmlPullParserException if any.
-
parseBanner
private Banner parseBanner(org.codehaus.plexus.util.xml.pull.XmlPullParser parser, boolean strict) throws IOException, org.codehaus.plexus.util.xml.pull.XmlPullParserException Method parseBanner.- Parameters:
parser
- a parser object.strict
- a strict object.- Returns:
- Banner
- Throws:
IOException
- IOException if any.org.codehaus.plexus.util.xml.pull.XmlPullParserException
- XmlPullParserException if any.
-
parseBody
private Body parseBody(org.codehaus.plexus.util.xml.pull.XmlPullParser parser, boolean strict) throws IOException, org.codehaus.plexus.util.xml.pull.XmlPullParserException Method parseBody.- Parameters:
parser
- a parser object.strict
- a strict object.- Returns:
- Body
- Throws:
IOException
- IOException if any.org.codehaus.plexus.util.xml.pull.XmlPullParserException
- XmlPullParserException if any.
-
parseDecorationModel
private DecorationModel parseDecorationModel(org.codehaus.plexus.util.xml.pull.XmlPullParser parser, boolean strict) throws IOException, org.codehaus.plexus.util.xml.pull.XmlPullParserException Method parseDecorationModel.- Parameters:
parser
- a parser object.strict
- a strict object.- Returns:
- DecorationModel
- Throws:
IOException
- IOException if any.org.codehaus.plexus.util.xml.pull.XmlPullParserException
- XmlPullParserException if any.
-
parseLinkItem
private LinkItem parseLinkItem(org.codehaus.plexus.util.xml.pull.XmlPullParser parser, boolean strict) throws IOException, org.codehaus.plexus.util.xml.pull.XmlPullParserException Method parseLinkItem.- Parameters:
parser
- a parser object.strict
- a strict object.- Returns:
- LinkItem
- Throws:
IOException
- IOException if any.org.codehaus.plexus.util.xml.pull.XmlPullParserException
- XmlPullParserException if any.
-
parseLogo
private Logo parseLogo(org.codehaus.plexus.util.xml.pull.XmlPullParser parser, boolean strict) throws IOException, org.codehaus.plexus.util.xml.pull.XmlPullParserException Method parseLogo.- Parameters:
parser
- a parser object.strict
- a strict object.- Returns:
- Logo
- Throws:
IOException
- IOException if any.org.codehaus.plexus.util.xml.pull.XmlPullParserException
- XmlPullParserException if any.
-
parseMenu
private Menu parseMenu(org.codehaus.plexus.util.xml.pull.XmlPullParser parser, boolean strict) throws IOException, org.codehaus.plexus.util.xml.pull.XmlPullParserException Method parseMenu.- Parameters:
parser
- a parser object.strict
- a strict object.- Returns:
- Menu
- Throws:
IOException
- IOException if any.org.codehaus.plexus.util.xml.pull.XmlPullParserException
- XmlPullParserException if any.
-
parseMenuItem
private MenuItem parseMenuItem(org.codehaus.plexus.util.xml.pull.XmlPullParser parser, boolean strict) throws IOException, org.codehaus.plexus.util.xml.pull.XmlPullParserException Method parseMenuItem.- Parameters:
parser
- a parser object.strict
- a strict object.- Returns:
- MenuItem
- Throws:
IOException
- IOException if any.org.codehaus.plexus.util.xml.pull.XmlPullParserException
- XmlPullParserException if any.
-
parsePublishDate
private PublishDate parsePublishDate(org.codehaus.plexus.util.xml.pull.XmlPullParser parser, boolean strict) throws IOException, org.codehaus.plexus.util.xml.pull.XmlPullParserException Method parsePublishDate.- Parameters:
parser
- a parser object.strict
- a strict object.- Returns:
- PublishDate
- Throws:
IOException
- IOException if any.org.codehaus.plexus.util.xml.pull.XmlPullParserException
- XmlPullParserException if any.
-
parseSkin
private Skin parseSkin(org.codehaus.plexus.util.xml.pull.XmlPullParser parser, boolean strict) throws IOException, org.codehaus.plexus.util.xml.pull.XmlPullParserException Method parseSkin.- Parameters:
parser
- a parser object.strict
- a strict object.- Returns:
- Skin
- Throws:
IOException
- IOException if any.org.codehaus.plexus.util.xml.pull.XmlPullParserException
- XmlPullParserException if any.
-
parseVersion
private Version parseVersion(org.codehaus.plexus.util.xml.pull.XmlPullParser parser, boolean strict) throws IOException, org.codehaus.plexus.util.xml.pull.XmlPullParserException Method parseVersion.- Parameters:
parser
- a parser object.strict
- a strict object.- Returns:
- Version
- 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.
-