Package com.l2fprod.contrib.nanoxml
Class XMLElement
java.lang.Object
com.l2fprod.contrib.nanoxml.XMLElement
- All Implemented Interfaces:
Serializable
XMLElement is a representation of an XML object. The object is able to parse
XML code.
Note that NanoXML is not 100% XML 1.0 compliant:
- The parser is non-validating.
- The DTD is fully ignored, including
<!ENTITY...>
. - There is no support for mixed content (elements containing both subelements and CDATA elements)
You can opt to use a SAX compatible API, by including both nanoxml.jar
and nanoxml-sax.jar
in your classpath and setting the property
org.xml.sax.parser
to nanoxml.sax.SAXParser
$Revision: 1.3 $
$Date: 2005/11/19 09:15:30 $
- Version:
- 1.6
- Author:
- Marc De Scheemaecker < Marc.DeScheemaecker@advalvas.be >
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final int
Major version of NanoXML.static final int
Minor version of NanoXML. -
Constructor Summary
ConstructorsModifierConstructorDescriptionCreates a new XML element.XMLElement
(boolean skipLeadingWhitespace) Creates a new XML element.XMLElement
(Properties conversionTable) Creates a new XML element.XMLElement
(Properties conversionTable, boolean skipLeadingWhitespace) Creates a new XML element.XMLElement
(Properties conversionTable, boolean skipLeadingWhitespace, boolean ignoreCase) Creates a new XML element.protected
XMLElement
(Properties conversionTable, boolean skipLeadingWhitespace, boolean fillBasicConversionTable, boolean ignoreCase) Creates a new XML element. -
Method Summary
Modifier and TypeMethodDescriptionvoid
addChild
(XMLElement child) Adds a subobject.void
addProperty
(String key, double value) Adds a property.void
addProperty
(String key, int value) Adds a property.void
addProperty
(String key, Object value) Adds a property.int
Returns the number of subobjects of the object.protected XMLElement
Creates a new XML element.protected String
decodeString
(String s, int lineNr) Converts &...; sequences to "normal" chars.Enumerates the subobjects of the object.Enumerates the attribute names.Returns the subobjects of the object.Returns the #PCDATA content of the object.int
getIntProperty
(String key, Hashtable valueSet, String defaultValue) Returns a property by looking up a key in a hashtable.int
Returns the line nr on which the element is found.getProperty
(String key) Returns a property of the object.double
getProperty
(String key, double defaultValue) Returns a floating point property of the object.int
getProperty
(String key, int defaultValue) Returns an integer property of the object.getProperty
(String key, String defaultValue) Returns a property of the object.boolean
getProperty
(String key, String trueValue, String falseValue, boolean defaultValue) Returns a boolean property of the object.getProperty
(String key, Hashtable valueSet, String defaultValue) Returns a property by looking up a key in the hashtable valueSet If the property doesn't exist, the value corresponding to defaultValue is returned.double
getSpecialDoubleProperty
(String key, Hashtable valueSet, String defaultValue) Returns a property by looking up a key in the hashtable valueSet .int
getSpecialIntProperty
(String key, Hashtable valueSet, String defaultValue) Returns a property by looking up a key in the hashtable valueSet .getStringProperty
(String key, Hashtable valueSet, String defaultValue) Returns a property by looking up a key in the hashtable valueSet .Returns the class (i.e.int
parseCharArray
(char[] input, int offset, int end) Parses an XML definition starting at offset .int
parseCharArray
(char[] input, int offset, int end, int startingLineNr) Parses an XML definition starting at offset .void
parseFromReader
(Reader reader) Reads an XML definition from a java.io.Reader and parses it.void
parseFromReader
(Reader reader, int startingLineNr) Reads an XML definition from a java.io.Reader and parses it.void
parseString
(String string) Parses an XML definition.int
parseString
(String string, int offset) Parses an XML definition starting at offset .int
parseString
(String string, int offset, int end) Parses an XML definition starting at offset .int
parseString
(String string, int offset, int end, int startingLineNr) Parses an XML definition starting at offset .void
removeChild
(XMLElement child) Removes a child object.void
removeChild
(String key) Removes an attribute.protected void
scanChildren
(char[] input, int contentOffset, int contentSize, int contentLineNr) !!! Searches the content for child objects.void
setContent
(String content) Changes the content string.void
setTagName
(String tagName) Changes the tag name.protected int
skipBogusTag
(char[] input, int offset, int end, int[] lineNr) Skips a tag that don't contain any useful data: <?...?>, <!...> and comments.toString()
Writes the XML element to a string.void
Writes the XML element to a writer.void
Writes the XML element to a writer.protected void
writeEncoded
(PrintWriter out, String str) Writes a string encoded to a writer.
-
Field Details
-
NANOXML_MAJOR_VERSION
public static final int NANOXML_MAJOR_VERSIONMajor version of NanoXML.- See Also:
-
NANOXML_MINOR_VERSION
public static final int NANOXML_MINOR_VERSIONMinor version of NanoXML.- See Also:
-
-
Constructor Details
-
XMLElement
public XMLElement()Creates a new XML element. The following settings are used:- Conversion table
- Minimal XML conversions:
& < > ' "
- Skip whitespace in contents
-
false
- Ignore Case
-
true
- See Also:
-
XMLElement
Creates a new XML element. The following settings are used:- Conversion table
- conversionTable combined with the minimal XML conversions:
& < > ' "
- Skip whitespace in contents
-
false
- Ignore Case
-
true
- Parameters:
conversionTable
- Description of Parameter- See Also:
-
XMLElement
public XMLElement(boolean skipLeadingWhitespace) Creates a new XML element. The following settings are used:- Conversion table
- Minimal XML conversions:
& < > ' "
- Skip whitespace in contents
- skipLeadingWhitespace
- Ignore Case
-
true
- Parameters:
skipLeadingWhitespace
- Description of Parameter- See Also:
-
XMLElement
Creates a new XML element. The following settings are used:- Conversion table
- conversionTable combined with the minimal XML conversions:
& < > ' "
- Skip whitespace in contents
- skipLeadingWhitespace
- Ignore Case
-
true
- Parameters:
conversionTable
- Description of ParameterskipLeadingWhitespace
- Description of Parameter- See Also:
-
XMLElement
Creates a new XML element. The following settings are used:- Conversion table
- conversionTable , eventually combined with the minimal XML
conversions:
& < > ' "
(depending on fillBasicConversionTable ) - Skip whitespace in contents
- skipLeadingWhitespace
- Ignore Case
- ignoreCase
This constructor should only be called from XMLElement itself to create child elements.
- Parameters:
conversionTable
- Description of ParameterskipLeadingWhitespace
- Description of ParameterignoreCase
- Description of Parameter- See Also:
-
XMLElement
protected XMLElement(Properties conversionTable, boolean skipLeadingWhitespace, boolean fillBasicConversionTable, boolean ignoreCase) Creates a new XML element. The following settings are used:- Conversion table
- conversionTable , eventually combined with the minimal XML
conversions:
& < > ' "
(depending on fillBasicConversionTable ) - Skip whitespace in contents
- skipLeadingWhitespace
- Ignore Case
- ignoreCase
This constructor should only be called from XMLElement itself to create child elements.
- Parameters:
conversionTable
- Description of ParameterskipLeadingWhitespace
- Description of ParameterfillBasicConversionTable
- Description of ParameterignoreCase
- Description of Parameter- See Also:
-
-
Method Details
-
setContent
Changes the content string.- Parameters:
content
- The new content string.
-
setTagName
Changes the tag name.- Parameters:
tagName
- The new tag name.
-
getChildren
Returns the subobjects of the object.- Returns:
- The Children value
-
getContents
Returns the #PCDATA content of the object. If there is no such content,null
is returned.- Returns:
- The Contents value
-
getLineNr
public int getLineNr()Returns the line nr on which the element is found.- Returns:
- The LineNr value
-
getIntProperty
Returns a property by looking up a key in a hashtable. If the property doesn't exist, the value corresponding to defaultValue is returned.- Parameters:
key
- Description of ParametervalueSet
- Description of ParameterdefaultValue
- Description of Parameter- Returns:
- The IntProperty value
-
getProperty
Returns a property of the object. If there is no such property, this method returnsnull
.- Parameters:
key
- Description of Parameter- Returns:
- The Property value
-
getProperty
Returns a property of the object. If the property doesn't exist, defaultValue is returned.- Parameters:
key
- Description of ParameterdefaultValue
- Description of Parameter- Returns:
- The Property value
-
getProperty
Returns an integer property of the object. If the property doesn't exist, defaultValue is returned.- Parameters:
key
- Description of ParameterdefaultValue
- Description of Parameter- Returns:
- The Property value
-
getProperty
Returns a floating point property of the object. If the property doesn't exist, defaultValue is returned.- Parameters:
key
- Description of ParameterdefaultValue
- Description of Parameter- Returns:
- The Property value
-
getProperty
Returns a boolean property of the object. If the property is missing, defaultValue is returned.- Parameters:
key
- Description of ParametertrueValue
- Description of ParameterfalseValue
- Description of ParameterdefaultValue
- Description of Parameter- Returns:
- The Property value
-
getProperty
Returns a property by looking up a key in the hashtable valueSet If the property doesn't exist, the value corresponding to defaultValue is returned.- Parameters:
key
- Description of ParametervalueSet
- Description of ParameterdefaultValue
- Description of Parameter- Returns:
- The Property value
-
getStringProperty
Returns a property by looking up a key in the hashtable valueSet . If the property doesn't exist, the value corresponding to defaultValue is returned.- Parameters:
key
- Description of ParametervalueSet
- Description of ParameterdefaultValue
- Description of Parameter- Returns:
- The StringProperty value
-
getSpecialIntProperty
Returns a property by looking up a key in the hashtable valueSet . If the value is not defined in the hashtable, the value is considered to be an integer. If the property doesn't exist, the value corresponding to defaultValue is returned.- Parameters:
key
- Description of ParametervalueSet
- Description of ParameterdefaultValue
- Description of Parameter- Returns:
- The SpecialIntProperty value
-
getSpecialDoubleProperty
Returns a property by looking up a key in the hashtable valueSet . If the value is not defined in the hashtable, the value is considered to be a floating point number. If the property doesn't exist, the value corresponding to defaultValue is returned.- Parameters:
key
- Description of ParametervalueSet
- Description of ParameterdefaultValue
- Description of Parameter- Returns:
- The SpecialDoubleProperty value
-
getTagName
Returns the class (i.e. the name indicated in the tag) of the object.- Returns:
- The TagName value
-
addChild
Adds a subobject.- Parameters:
child
- The feature to be added to the Child attribute
-
addProperty
Adds a property. If the element is case insensitive, the property name is capitalized.- Parameters:
key
- The feature to be added to the Property attributevalue
- The feature to be added to the Property attribute
-
addProperty
Adds a property. If the element is case insensitive, the property name is capitalized.- Parameters:
key
- The feature to be added to the Property attributevalue
- The feature to be added to the Property attribute
-
addProperty
Adds a property. If the element is case insensitive, the property name is capitalized.- Parameters:
key
- The feature to be added to the Property attributevalue
- The feature to be added to the Property attribute
-
countChildren
public int countChildren()Returns the number of subobjects of the object.- Returns:
- Description of the Returned Value
-
enumeratePropertyNames
Enumerates the attribute names.- Returns:
- Description of the Returned Value
-
enumerateChildren
Enumerates the subobjects of the object.- Returns:
- Description of the Returned Value
-
parseFromReader
Reads an XML definition from a java.io.Reader and parses it.- Parameters:
reader
- Description of Parameter- Throws:
IOException
- Description of ExceptionXMLParseException
- Description of Exception
-
parseFromReader
public void parseFromReader(Reader reader, int startingLineNr) throws IOException, XMLParseException Reads an XML definition from a java.io.Reader and parses it.- Parameters:
reader
- Description of ParameterstartingLineNr
- Description of Parameter- Throws:
IOException
- Description of ExceptionXMLParseException
- Description of Exception
-
parseString
Parses an XML definition.- Parameters:
string
- Description of Parameter- Throws:
XMLParseException
- Description of Exception
-
parseString
Parses an XML definition starting at offset .- Parameters:
string
- Description of Parameteroffset
- Description of Parameter- Returns:
- the offset of the string following the XML data
- Throws:
XMLParseException
- Description of Exception
-
parseString
Parses an XML definition starting at offset .- Parameters:
string
- Description of Parameteroffset
- Description of Parameterend
- Description of Parameter- Returns:
- the offset of the string following the XML data (invalid input: '<'= end)
- Throws:
XMLParseException
- Description of Exception
-
parseString
public int parseString(String string, int offset, int end, int startingLineNr) throws XMLParseException Parses an XML definition starting at offset .- Parameters:
string
- Description of Parameteroffset
- Description of Parameterend
- Description of ParameterstartingLineNr
- Description of Parameter- Returns:
- the offset of the string following the XML data (invalid input: '<'= end)
- Throws:
XMLParseException
- Description of Exception
-
parseCharArray
Parses an XML definition starting at offset .- Parameters:
input
- Description of Parameteroffset
- Description of Parameterend
- Description of Parameter- Returns:
- the offset of the array following the XML data (invalid input: '<'= end)
- Throws:
XMLParseException
- Description of Exception
-
parseCharArray
public int parseCharArray(char[] input, int offset, int end, int startingLineNr) throws XMLParseException Parses an XML definition starting at offset .- Parameters:
input
- Description of Parameteroffset
- Description of Parameterend
- Description of ParameterstartingLineNr
- Description of Parameter- Returns:
- the offset of the array following the XML data (invalid input: '<'= end)
- Throws:
XMLParseException
- Description of Exception
-
removeChild
Removes a child object. If the object is not a child, nothing happens.- Parameters:
child
- Description of Parameter
-
removeChild
Removes an attribute.- Parameters:
key
- Description of Parameter
-
toString
Writes the XML element to a string. -
write
Writes the XML element to a writer.- Parameters:
writer
- Description of Parameter
-
write
Writes the XML element to a writer.- Parameters:
writer
- Description of Parameterindent
- Description of Parameter
-
scanChildren
protected void scanChildren(char[] input, int contentOffset, int contentSize, int contentLineNr) throws XMLParseException !!! Searches the content for child objects. If such objects exist, the content is reduced tonull
.- Parameters:
input
- Description of ParametercontentOffset
- Description of ParametercontentSize
- Description of ParametercontentLineNr
- Description of Parameter- Throws:
XMLParseException
- Description of Exception- See Also:
-
createAnotherElement
Creates a new XML element.- Returns:
- Description of the Returned Value
-
skipBogusTag
protected int skipBogusTag(char[] input, int offset, int end, int[] lineNr) Skips a tag that don't contain any useful data: <?...?>, <!...> and comments.- Parameters:
input
- Description of Parameteroffset
- Description of Parameterend
- Description of ParameterlineNr
- Description of Parameter- Returns:
- the position after the tag
-
decodeString
Converts &...; sequences to "normal" chars.- Parameters:
s
- Description of ParameterlineNr
- Description of Parameter- Returns:
- Description of the Returned Value
-
writeEncoded
Writes a string encoded to a writer.- Parameters:
out
- Description of Parameterstr
- Description of Parameter
-