Class XMLElement
- java.lang.Object
-
- nanoxml.XMLElement
-
public class XMLElement extends Object
XMLElement is a representation of an XML object. The object is able to parse XML code.- Parsing XML Data
-
You can parse XML data using the following code:
XMLElement xml = new XMLElement();
FileReader reader = new FileReader("filename.xml");
xml.parseFromReader(reader);
- Retrieving Attributes
-
You can enumerate the attributes of an element using the method
enumerateAttributeNames
. The attribute values can be retrieved using the methodgetStringAttribute
. The following example shows how to list the attributes of an element:XMLElement element = ...;
Enumeration enum = element.getAttributeNames();
while (enum.hasMoreElements()) {
String key = (String) enum.nextElement();
String value = element.getStringAttribute(key);
System.out.println(key + " = " + value);
}
- Retrieving Child Elements
-
You can enumerate the children of an element using
enumerateChildren
. The number of child elements can be retrieved usingcountChildren
.
- Elements Containing Character Data
-
If an elements contains character data, like in the following example:
<title>The Title</title>
getContent
.
- Subclassing XMLElement
-
When subclassing XMLElement, you need to override the method
createAnotherElement
which has to return a new copy of the receiver.
- Version:
- $Name: RELEASE_2_2_1 $, $Revision: 1.4 $
- Author:
- Marc De Scheemaecker <cyberelf@mac.com>
- See Also:
XMLParseException
-
-
Field Summary
Fields Modifier and Type Field Description static int
NANOXML_MAJOR_VERSION
Major version of NanoXML.static int
NANOXML_MINOR_VERSION
Minor version of NanoXML.
-
Constructor Summary
Constructors Modifier Constructor Description XMLElement()
Creates and initializes a new XML element.XMLElement(boolean skipLeadingWhitespace)
Creates and initializes a new XML element.XMLElement(Hashtable entities)
Creates and initializes a new XML element.XMLElement(Hashtable entities, boolean skipLeadingWhitespace)
Creates and initializes a new XML element.XMLElement(Hashtable entities, boolean skipLeadingWhitespace, boolean ignoreCase)
Creates and initializes a new XML element.protected
XMLElement(Hashtable entities, boolean skipLeadingWhitespace, boolean fillBasicConversionTable, boolean ignoreCase)
Creates and initializes a new XML element.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description void
addChild(XMLElement child)
Adds a child element.void
addProperty(String name, double value)
Deprecated.UsesetDoubleAttribute
instead.void
addProperty(String key, int value)
Deprecated.UsesetIntAttribute
instead.void
addProperty(String name, Object value)
Deprecated.UsesetAttribute
instead.protected boolean
checkCDATA(StringBuffer buf)
Scans a special tag and if the tag is a CDATA section, append its content tobuf
.protected boolean
checkLiteral(String literal)
Scans the data for literal text.int
countChildren()
Returns the number of child elements of the element.protected XMLElement
createAnotherElement()
Creates a new similar XML element.Enumeration
enumerateAttributeNames()
Enumerates the attribute names.Enumeration
enumerateChildren()
Enumerates the child elements.Enumeration
enumeratePropertyNames()
Deprecated.UseenumerateAttributeNames
instead.protected XMLParseException
expectedInput(String charSet)
Creates a parse exception for when the next character read is not the character that was expected.Object
getAttribute(String name)
Returns an attribute of the element.Object
getAttribute(String name, Object defaultValue)
Returns an attribute of the element.Object
getAttribute(String name, Hashtable valueSet, String defaultKey, boolean allowLiterals)
Returns an attribute by looking up a key in a hashtable.boolean
getBooleanAttribute(String name, String trueValue, String falseValue, boolean defaultValue)
Returns an attribute of the element.Vector
getChildren()
Returns the child elements as a Vector.String
getContent()
Returns the PCDATA content of the object.String
getContents()
Deprecated.UsegetContent
instead.double
getDoubleAttribute(String name)
Returns an attribute of the element.double
getDoubleAttribute(String name, double defaultValue)
Returns an attribute of the element.double
getDoubleAttribute(String name, Hashtable valueSet, String defaultKey, boolean allowLiteralNumbers)
Returns an attribute by looking up a key in a hashtable.int
getIntAttribute(String name)
Returns an attribute of the element.int
getIntAttribute(String name, int defaultValue)
Returns an attribute of the element.int
getIntAttribute(String name, Hashtable valueSet, String defaultKey, boolean allowLiteralNumbers)
Returns an attribute by looking up a key in a hashtable.int
getIntProperty(String name, Hashtable valueSet, String defaultKey)
Deprecated.UsegetIntAttribute
instead.int
getLineNr()
Returns the line nr in the source data on which the element is found.String
getName()
Returns the name of the element.String
getProperty(String name)
Deprecated.UsegetStringAttribute
instead.double
getProperty(String name, double defaultValue)
Deprecated.UsegetDoubleAttribute
instead.int
getProperty(String name, int defaultValue)
Deprecated.UsegetIntAttribute
instead.String
getProperty(String name, String defaultValue)
Deprecated.UsegetStringAttribute
instead.boolean
getProperty(String key, String trueValue, String falseValue, boolean defaultValue)
Deprecated.UsegetBooleanAttribute
instead.Object
getProperty(String name, Hashtable valueSet, String defaultKey)
Deprecated.UsegetAttribute
instead.double
getSpecialDoubleProperty(String name, Hashtable valueSet, String defaultKey)
Deprecated.UsegetDoubleAttribute
instead.int
getSpecialIntProperty(String name, Hashtable valueSet, String defaultKey)
Deprecated.UsegetIntAttribute
instead.String
getStringAttribute(String name)
Returns an attribute of the element.String
getStringAttribute(String name, String defaultValue)
Returns an attribute of the element.String
getStringAttribute(String name, Hashtable valueSet, String defaultKey, boolean allowLiterals)
Returns an attribute by looking up a key in a hashtable.String
getStringProperty(String name, Hashtable valueSet, String defaultKey)
Deprecated.UsegetStringAttribute
instead.String
getTagName()
Deprecated.UsegetName
instead.protected XMLParseException
invalidValue(String name, String value)
Creates a parse exception for when an invalid value is given to a method.protected XMLParseException
invalidValueSet(String name)
Creates a parse exception for when an invalid valueset is given to a method.void
parseCharArray(char[] input, int offset, int end)
Reads one XML element from a char array and parses it.void
parseCharArray(char[] input, int offset, int end, int startingLineNr)
Reads one XML element from a char array and parses it.void
parseFromReader(Reader reader)
Reads one XML element from a java.io.Reader and parses it.void
parseFromReader(Reader reader, int startingLineNr)
Reads one XML element from a java.io.Reader and parses it.void
parseString(String string)
Reads one XML element from a String and parses it.void
parseString(String string, int offset)
Reads one XML element from a String and parses it.void
parseString(String string, int offset, int end)
Reads one XML element from a String and parses it.void
parseString(String string, int offset, int end, int startingLineNr)
Reads one XML element from a String and parses it.protected char
readChar()
Reads a character from a reader.void
removeAttribute(String name)
Removes an attribute.void
removeChild(String name)
Deprecated.UseremoveAttribute
instead.void
removeChild(XMLElement child)
Removes a child element.void
removeProperty(String name)
Deprecated.UseremoveAttribute
instead.protected void
resolveEntity(StringBuffer buf)
Resolves an entity.protected void
scanElement(XMLElement elt)
Scans an XML element.protected void
scanIdentifier(StringBuffer result)
Scans an identifier from the current reader.protected void
scanPCData(StringBuffer data)
Scans a #PCDATA element.protected void
scanString(StringBuffer string)
This method scans a delimited string from the current reader.protected char
scanWhitespace()
This method scans an identifier from the current reader.protected char
scanWhitespace(StringBuffer result)
This method scans an identifier from the current reader.void
setAttribute(String name, Object value)
Adds or modifies an attribute.void
setContent(String content)
Changes the content string.void
setDoubleAttribute(String name, double value)
Adds or modifies an attribute.void
setIntAttribute(String name, int value)
Adds or modifies an attribute.void
setName(String name)
Changes the name of the element.void
setTagName(String name)
Deprecated.UsesetName
instead.protected void
skipComment()
Skips a comment.protected void
skipSpecialTag(int bracketLevel)
Skips a special tag or comment.protected XMLParseException
syntaxError(String context)
Creates a parse exception for when a syntax error occured.String
toString()
Writes the XML element to a string.protected XMLParseException
unexpectedEndOfData()
Creates a parse exception for when the end of the data input has been reached.protected XMLParseException
unknownEntity(String name)
Creates a parse exception for when an entity could not be resolved.protected void
unreadChar(char ch)
Pushes a character back to the read-back buffer.void
write(Writer writer)
Writes the XML element to a writer.protected void
writeEncoded(Writer writer, String str)
Writes a string encoded to a writer.
-
-
-
Field Detail
-
NANOXML_MAJOR_VERSION
public static final int NANOXML_MAJOR_VERSION
Major version of NanoXML. Classes with the same major and minor version are binary compatible. Classes with the same major version are source compatible. If the major version is different, you may need to modify the client source code.- See Also:
NANOXML_MINOR_VERSION
, Constant Field Values
-
NANOXML_MINOR_VERSION
public static final int NANOXML_MINOR_VERSION
Minor version of NanoXML. Classes with the same major and minor version are binary compatible. Classes with the same major version are source compatible. If the major version is different, you may need to modify the client source code.- See Also:
NANOXML_MAJOR_VERSION
, Constant Field Values
-
-
Constructor Detail
-
XMLElement
public XMLElement()
Creates and initializes a new XML element. Calling the construction is equivalent to:new XMLElement(new Hashtable(), false, true)
- Postconditions:
-
- countChildren() => 0
- enumerateChildren() => empty enumeration
- enumeratePropertyNames() => empty enumeration
- getChildren() => empty vector
- getContent() => ""
- getLineNr() => 0
- getName() => null
-
XMLElement
public XMLElement(Hashtable entities)
Creates and initializes a new XML element. Calling the construction is equivalent to:new XMLElement(entities, false, true)
- Parameters:
entities
- The entity conversion table.
- Preconditions:
-
entities != null
- Postconditions:
-
- countChildren() => 0
- enumerateChildren() => empty enumeration
- enumeratePropertyNames() => empty enumeration
- getChildren() => empty vector
- getContent() => ""
- getLineNr() => 0
- getName() => null
-
XMLElement
public XMLElement(boolean skipLeadingWhitespace)
Creates and initializes a new XML element. Calling the construction is equivalent to:new XMLElement(new Hashtable(), skipLeadingWhitespace, true)
- Parameters:
skipLeadingWhitespace
-true
if leading and trailing whitespace in PCDATA content has to be removed.
- Postconditions:
-
- countChildren() => 0
- enumerateChildren() => empty enumeration
- enumeratePropertyNames() => empty enumeration
- getChildren() => empty vector
- getContent() => ""
- getLineNr() => 0
- getName() => null
-
XMLElement
public XMLElement(Hashtable entities, boolean skipLeadingWhitespace)
Creates and initializes a new XML element. Calling the construction is equivalent to:new XMLElement(entities, skipLeadingWhitespace, true)
- Parameters:
entities
- The entity conversion table.skipLeadingWhitespace
-true
if leading and trailing whitespace in PCDATA content has to be removed.
- Preconditions:
-
entities != null
- Postconditions:
-
- countChildren() => 0
- enumerateChildren() => empty enumeration
- enumeratePropertyNames() => empty enumeration
- getChildren() => empty vector
- getContent() => ""
- getLineNr() => 0
- getName() => null
- See Also:
XMLElement()
,XMLElement(boolean)
,XMLElement(Hashtable)
-
XMLElement
public XMLElement(Hashtable entities, boolean skipLeadingWhitespace, boolean ignoreCase)
Creates and initializes a new XML element.- Parameters:
entities
- The entity conversion table.skipLeadingWhitespace
-true
if leading and trailing whitespace in PCDATA content has to be removed.ignoreCase
-true
if the case of element and attribute names have to be ignored.
- Preconditions:
-
entities != null
- Postconditions:
-
- countChildren() => 0
- enumerateChildren() => empty enumeration
- enumeratePropertyNames() => empty enumeration
- getChildren() => empty vector
- getContent() => ""
- getLineNr() => 0
- getName() => null
-
XMLElement
protected XMLElement(Hashtable entities, boolean skipLeadingWhitespace, boolean fillBasicConversionTable, boolean ignoreCase)
Creates and initializes a new XML element.This constructor should only be called from
createAnotherElement
to create child elements.- Parameters:
entities
- The entity conversion table.skipLeadingWhitespace
-true
if leading and trailing whitespace in PCDATA content has to be removed.fillBasicConversionTable
-true
if the basic entities need to be added to the entity list.ignoreCase
-true
if the case of element and attribute names have to be ignored.
- Preconditions:
-
entities != null
- if
fillBasicConversionTable == false
thenentities
contains at least the following entries:amp
,lt
,gt
,apos
andquot
- Postconditions:
-
- countChildren() => 0
- enumerateChildren() => empty enumeration
- enumeratePropertyNames() => empty enumeration
- getChildren() => empty vector
- getContent() => ""
- getLineNr() => 0
- getName() => null
- See Also:
createAnotherElement()
-
-
Method Detail
-
addChild
public void addChild(XMLElement child)
Adds a child element.- Parameters:
child
- The child element to add.
- Preconditions:
-
child != null
child.getName() != null
child
does not have a parent element
- Postconditions:
-
- countChildren() => old.countChildren() + 1
- enumerateChildren() => old.enumerateChildren() + child
- getChildren() => old.enumerateChildren() + child
-
setAttribute
public void setAttribute(String name, Object value)
Adds or modifies an attribute.- Parameters:
name
- The name of the attribute.value
- The value of the attribute.
- Preconditions:
-
name != null
name
is a valid XML identifiervalue != null
- Postconditions:
-
- enumerateAttributeNames() => old.enumerateAttributeNames() + name
- getAttribute(name) => value
- See Also:
setDoubleAttribute(String, double)
,setIntAttribute(String, int)
,enumerateAttributeNames()
,getAttribute(String)
,getAttribute(String, Object)
,getAttribute(String, Hashtable, String, boolean)
,getStringAttribute(String)
,getStringAttribute(String, String)
,getStringAttribute(String, Hashtable, String, boolean)
-
addProperty
public void addProperty(String name, Object value)
Deprecated.UsesetAttribute
instead.Adds or modifies an attribute.- Parameters:
name
- The name of the attribute.value
- The value of the attribute.
-
setIntAttribute
public void setIntAttribute(String name, int value)
Adds or modifies an attribute.- Parameters:
name
- The name of the attribute.value
- The value of the attribute.
- Preconditions:
-
name != null
name
is a valid XML identifier
- Postconditions:
-
- enumerateAttributeNames() => old.enumerateAttributeNames() + name
- getIntAttribute(name) => value
-
addProperty
public void addProperty(String key, int value)
Deprecated.UsesetIntAttribute
instead.Adds or modifies an attribute.- Parameters:
name
- The name of the attribute.value
- The value of the attribute.
-
setDoubleAttribute
public void setDoubleAttribute(String name, double value)
Adds or modifies an attribute.- Parameters:
name
- The name of the attribute.value
- The value of the attribute.
- Preconditions:
-
name != null
name
is a valid XML identifier
- Postconditions:
-
- enumerateAttributeNames() => old.enumerateAttributeNames() + name
- getDoubleAttribute(name) => value
-
addProperty
public void addProperty(String name, double value)
Deprecated.UsesetDoubleAttribute
instead.Adds or modifies an attribute.- Parameters:
name
- The name of the attribute.value
- The value of the attribute.
-
countChildren
public int countChildren()
Returns the number of child elements of the element.- Postconditions:
-
result >= 0
-
enumerateAttributeNames
public Enumeration enumerateAttributeNames()
Enumerates the attribute names.- Postconditions:
-
result != null
- See Also:
setDoubleAttribute(String, double)
,setIntAttribute(String, int)
,setAttribute(String, Object)
,removeAttribute(String)
,getAttribute(String)
,getAttribute(String, String)
,getAttribute(String, Hashtable, String, boolean)
,getStringAttribute(String)
,getStringAttribute(String, String)
,getStringAttribute(String, Hashtable, String, boolean)
,getIntAttribute(String)
,getIntAttribute(String, int)
,getIntAttribute(String, Hashtable, String, boolean)
,getDoubleAttribute(String)
,getDoubleAttribute(String, double)
,getDoubleAttribute(String, Hashtable, String, boolean)
,getBooleanAttribute(String, String, String, boolean)
-
enumeratePropertyNames
public Enumeration enumeratePropertyNames()
Deprecated.UseenumerateAttributeNames
instead.Enumerates the attribute names.
-
enumerateChildren
public Enumeration enumerateChildren()
Enumerates the child elements.- Postconditions:
-
result != null
-
getChildren
public Vector getChildren()
Returns the child elements as a Vector. It is safe to modify this Vector.- Postconditions:
-
result != null
-
getContents
public String getContents()
Deprecated.UsegetContent
instead.Returns the PCDATA content of the object. If there is no such content,null
is returned.
-
getContent
public String getContent()
Returns the PCDATA content of the object. If there is no such content,null
is returned.- See Also:
setContent(String)
-
getLineNr
public int getLineNr()
Returns the line nr in the source data on which the element is found. This method returns0
there is no associated source data.- Postconditions:
-
result >= 0
-
getAttribute
public Object getAttribute(String name)
Returns an attribute of the element. If the attribute doesn't exist,null
is returned.- Parameters:
name
- The name of the attribute.
- Preconditions:
-
name != null
name
is a valid XML identifier
-
getAttribute
public Object getAttribute(String name, Object defaultValue)
Returns an attribute of the element. If the attribute doesn't exist,defaultValue
is returned.- Parameters:
name
- The name of the attribute.defaultValue
- Key to use if the attribute is missing.
- Preconditions:
-
name != null
name
is a valid XML identifier
-
getAttribute
public Object getAttribute(String name, Hashtable valueSet, String defaultKey, boolean allowLiterals)
Returns an attribute by looking up a key in a hashtable. If the attribute doesn't exist, the value corresponding to defaultKey is returned.As an example, if valueSet contains the mapping
"one" => "1"
and the element contains the attributeattr="one"
, thengetAttribute("attr", mapping, defaultKey, false)
returns"1"
.- Parameters:
name
- The name of the attribute.valueSet
- Hashtable mapping keys to values.defaultKey
- Key to use if the attribute is missing.allowLiterals
-true
if literals are valid.
- Preconditions:
-
name != null
name
is a valid XML identifiervalueSet
!= null- the keys of
valueSet
are strings
-
getStringAttribute
public String getStringAttribute(String name)
Returns an attribute of the element. If the attribute doesn't exist,null
is returned.- Parameters:
name
- The name of the attribute.
- Preconditions:
-
name != null
name
is a valid XML identifier
-
getStringAttribute
public String getStringAttribute(String name, String defaultValue)
Returns an attribute of the element. If the attribute doesn't exist,defaultValue
is returned.- Parameters:
name
- The name of the attribute.defaultValue
- Key to use if the attribute is missing.
- Preconditions:
-
name != null
name
is a valid XML identifier
-
getStringAttribute
public String getStringAttribute(String name, Hashtable valueSet, String defaultKey, boolean allowLiterals)
Returns an attribute by looking up a key in a hashtable. If the attribute doesn't exist, the value corresponding to defaultKey is returned.As an example, if valueSet contains the mapping
"one" => "1"
and the element contains the attributeattr="one"
, thengetAttribute("attr", mapping, defaultKey, false)
returns"1"
.- Parameters:
name
- The name of the attribute.valueSet
- Hashtable mapping keys to values.defaultKey
- Key to use if the attribute is missing.allowLiterals
-true
if literals are valid.
- Preconditions:
-
name != null
name
is a valid XML identifiervalueSet
!= null- the keys of
valueSet
are strings - the values of
valueSet
are strings
-
getIntAttribute
public int getIntAttribute(String name)
Returns an attribute of the element. If the attribute doesn't exist,0
is returned.- Parameters:
name
- The name of the attribute.
- Preconditions:
-
name != null
name
is a valid XML identifier
-
getIntAttribute
public int getIntAttribute(String name, int defaultValue)
Returns an attribute of the element. If the attribute doesn't exist,defaultValue
is returned.- Parameters:
name
- The name of the attribute.defaultValue
- Key to use if the attribute is missing.
- Preconditions:
-
name != null
name
is a valid XML identifier
-
getIntAttribute
public int getIntAttribute(String name, Hashtable valueSet, String defaultKey, boolean allowLiteralNumbers)
Returns an attribute by looking up a key in a hashtable. If the attribute doesn't exist, the value corresponding to defaultKey is returned.As an example, if valueSet contains the mapping
"one" => 1
and the element contains the attributeattr="one"
, thengetIntAttribute("attr", mapping, defaultKey, false)
returns1
.- Parameters:
name
- The name of the attribute.valueSet
- Hashtable mapping keys to values.defaultKey
- Key to use if the attribute is missing.allowLiteralNumbers
-true
if literal numbers are valid.
- Preconditions:
-
name != null
name
is a valid XML identifiervalueSet
!= null- the keys of
valueSet
are strings - the values of
valueSet
are Integer objects defaultKey
is eithernull
, a key invalueSet
or an integer.
-
getDoubleAttribute
public double getDoubleAttribute(String name)
Returns an attribute of the element. If the attribute doesn't exist,0.0
is returned.- Parameters:
name
- The name of the attribute.
- Preconditions:
-
name != null
name
is a valid XML identifier
-
getDoubleAttribute
public double getDoubleAttribute(String name, double defaultValue)
Returns an attribute of the element. If the attribute doesn't exist,defaultValue
is returned.- Parameters:
name
- The name of the attribute.defaultValue
- Key to use if the attribute is missing.
- Preconditions:
-
name != null
name
is a valid XML identifier
-
getDoubleAttribute
public double getDoubleAttribute(String name, Hashtable valueSet, String defaultKey, boolean allowLiteralNumbers)
Returns an attribute by looking up a key in a hashtable. If the attribute doesn't exist, the value corresponding to defaultKey is returned.As an example, if valueSet contains the mapping
"one" => 1.0
and the element contains the attributeattr="one"
, thengetDoubleAttribute("attr", mapping, defaultKey, false)
returns1.0
.- Parameters:
name
- The name of the attribute.valueSet
- Hashtable mapping keys to values.defaultKey
- Key to use if the attribute is missing.allowLiteralNumbers
-true
if literal numbers are valid.
- Preconditions:
-
name != null
name
is a valid XML identifiervalueSet != null
- the keys of
valueSet
are strings - the values of
valueSet
are Double objects defaultKey
is eithernull
, a key invalueSet
or a double.
-
getBooleanAttribute
public boolean getBooleanAttribute(String name, String trueValue, String falseValue, boolean defaultValue)
Returns an attribute of the element. If the attribute doesn't exist,defaultValue
is returned. If the value of the attribute is equal totrueValue
,true
is returned. If the value of the attribute is equal tofalseValue
,false
is returned. If the value doesn't matchtrueValue
orfalseValue
, an exception is thrown.- Parameters:
name
- The name of the attribute.trueValue
- The value associated withtrue
.falseValue
- The value associated withtrue
.defaultValue
- Value to use if the attribute is missing.
- Preconditions:
-
name != null
name
is a valid XML identifiertrueValue
andfalseValue
are different strings.
-
getIntProperty
public int getIntProperty(String name, Hashtable valueSet, String defaultKey)
Deprecated.UsegetIntAttribute
instead.Returns an attribute by looking up a key in a hashtable.
-
getProperty
public String getProperty(String name)
Deprecated.UsegetStringAttribute
instead.Returns an attribute.
-
getProperty
public String getProperty(String name, String defaultValue)
Deprecated.UsegetStringAttribute
instead.Returns an attribute.
-
getProperty
public int getProperty(String name, int defaultValue)
Deprecated.UsegetIntAttribute
instead.Returns an attribute.
-
getProperty
public double getProperty(String name, double defaultValue)
Deprecated.UsegetDoubleAttribute
instead.Returns an attribute.
-
getProperty
public boolean getProperty(String key, String trueValue, String falseValue, boolean defaultValue)
Deprecated.UsegetBooleanAttribute
instead.Returns an attribute.
-
getProperty
public Object getProperty(String name, Hashtable valueSet, String defaultKey)
Deprecated.UsegetAttribute
instead.Returns an attribute by looking up a key in a hashtable.
-
getStringProperty
public String getStringProperty(String name, Hashtable valueSet, String defaultKey)
Deprecated.UsegetStringAttribute
instead.Returns an attribute by looking up a key in a hashtable.
-
getSpecialIntProperty
public int getSpecialIntProperty(String name, Hashtable valueSet, String defaultKey)
Deprecated.UsegetIntAttribute
instead.Returns an attribute by looking up a key in a hashtable.
-
getSpecialDoubleProperty
public double getSpecialDoubleProperty(String name, Hashtable valueSet, String defaultKey)
Deprecated.UsegetDoubleAttribute
instead.Returns an attribute by looking up a key in a hashtable.
-
getName
public String getName()
Returns the name of the element.- See Also:
setName(String)
-
getTagName
public String getTagName()
Deprecated.UsegetName
instead.Returns the name of the element.
-
parseFromReader
public void parseFromReader(Reader reader) throws IOException, XMLParseException
Reads one XML element from a java.io.Reader and parses it.- Parameters:
reader
- The reader from which to retrieve the XML data.
- Preconditions:
-
reader != null
reader
is not closed
- Postconditions:
-
- the state of the receiver is updated to reflect the XML element parsed from the reader
- the reader points to the first character following the last '>' character of the XML element
- Throws:
IOException
- If an error occured while reading the input.XMLParseException
- If an error occured while parsing the read data.
-
parseFromReader
public void parseFromReader(Reader reader, int startingLineNr) throws IOException, XMLParseException
Reads one XML element from a java.io.Reader and parses it.- Parameters:
reader
- The reader from which to retrieve the XML data.startingLineNr
- The line number of the first line in the data.
- Preconditions:
-
reader != null
reader
is not closed
- Postconditions:
-
- the state of the receiver is updated to reflect the XML element parsed from the reader
- the reader points to the first character following the last '>' character of the XML element
- Throws:
IOException
- If an error occured while reading the input.XMLParseException
- If an error occured while parsing the read data.
-
parseString
public void parseString(String string) throws XMLParseException
Reads one XML element from a String and parses it.- Parameters:
reader
- The reader from which to retrieve the XML data.
- Preconditions:
-
string != null
string.length() > 0
- Postconditions:
-
- the state of the receiver is updated to reflect the XML element parsed from the reader
- Throws:
XMLParseException
- If an error occured while parsing the string.
-
parseString
public void parseString(String string, int offset) throws XMLParseException
Reads one XML element from a String and parses it.- Parameters:
reader
- The reader from which to retrieve the XML data.offset
- The first character instring
to scan.
- Preconditions:
-
string != null
offset < string.length()
offset >= 0
- Postconditions:
-
- the state of the receiver is updated to reflect the XML element parsed from the reader
- Throws:
XMLParseException
- If an error occured while parsing the string.
-
parseString
public void parseString(String string, int offset, int end) throws XMLParseException
Reads one XML element from a String and parses it.- Parameters:
reader
- The reader from which to retrieve the XML data.offset
- The first character instring
to scan.end
- The character where to stop scanning. This character is not scanned.
- Preconditions:
-
string != null
end <= string.length()
offset < end
offset >= 0
- Postconditions:
-
- the state of the receiver is updated to reflect the XML element parsed from the reader
- Throws:
XMLParseException
- If an error occured while parsing the string.
-
parseString
public void parseString(String string, int offset, int end, int startingLineNr) throws XMLParseException
Reads one XML element from a String and parses it.- Parameters:
reader
- The reader from which to retrieve the XML data.offset
- The first character instring
to scan.end
- The character where to stop scanning. This character is not scanned.startingLineNr
- The line number of the first line in the data.
- Preconditions:
-
string != null
end <= string.length()
offset < end
offset >= 0
- Postconditions:
-
- the state of the receiver is updated to reflect the XML element parsed from the reader
- Throws:
XMLParseException
- If an error occured while parsing the string.
-
parseCharArray
public void parseCharArray(char[] input, int offset, int end) throws XMLParseException
Reads one XML element from a char array and parses it.- Parameters:
reader
- The reader from which to retrieve the XML data.offset
- The first character instring
to scan.end
- The character where to stop scanning. This character is not scanned.
- Preconditions:
-
input != null
end <= input.length
offset < end
offset >= 0
- Postconditions:
-
- the state of the receiver is updated to reflect the XML element parsed from the reader
- Throws:
XMLParseException
- If an error occured while parsing the string.
-
parseCharArray
public void parseCharArray(char[] input, int offset, int end, int startingLineNr) throws XMLParseException
Reads one XML element from a char array and parses it.- Parameters:
reader
- The reader from which to retrieve the XML data.offset
- The first character instring
to scan.end
- The character where to stop scanning. This character is not scanned.startingLineNr
- The line number of the first line in the data.
- Preconditions:
-
input != null
end <= input.length
offset < end
offset >= 0
- Postconditions:
-
- the state of the receiver is updated to reflect the XML element parsed from the reader
- Throws:
XMLParseException
- If an error occured while parsing the string.
-
removeChild
public void removeChild(XMLElement child)
Removes a child element.- Parameters:
child
- The child element to remove.
- Preconditions:
-
child != null
child
is a child element of the receiver
- Postconditions:
-
- countChildren() => old.countChildren() - 1
- enumerateChildren() => old.enumerateChildren() - child
- getChildren() => old.enumerateChildren() - child
-
removeAttribute
public void removeAttribute(String name)
Removes an attribute.- Parameters:
name
- The name of the attribute.
- Preconditions:
-
name != null
name
is a valid XML identifier
- Postconditions:
-
- enumerateAttributeNames() => old.enumerateAttributeNames() - name
- getAttribute(name) =>
null
- See Also:
enumerateAttributeNames()
,setDoubleAttribute(String, double)
,setIntAttribute(String, int)
,setAttribute(String, Object)
,getAttribute(String)
,getAttribute(String, Object)
,getAttribute(String, Hashtable, String, boolean)
,getStringAttribute(String)
,getStringAttribute(String, String)
,getStringAttribute(String, Hashtable, String, boolean)
,getIntAttribute(String)
,getIntAttribute(String, int)
,getIntAttribute(String, Hashtable, String, boolean)
,getDoubleAttribute(String)
,getDoubleAttribute(String, double)
,getDoubleAttribute(String, Hashtable, String, boolean)
,getBooleanAttribute(String, String, String, boolean)
-
removeProperty
public void removeProperty(String name)
Deprecated.UseremoveAttribute
instead.Removes an attribute.- Parameters:
name
- The name of the attribute.
-
removeChild
public void removeChild(String name)
Deprecated.UseremoveAttribute
instead.Removes an attribute.- Parameters:
name
- The name of the attribute.
-
createAnotherElement
protected XMLElement createAnotherElement()
Creates a new similar XML element.You should override this method when subclassing XMLElement.
-
setContent
public void setContent(String content)
Changes the content string.- Parameters:
content
- The new content string.
-
setTagName
public void setTagName(String name)
Deprecated.UsesetName
instead.Changes the name of the element.- Parameters:
name
- The new name.
-
setName
public void setName(String name)
Changes the name of the element.- Parameters:
name
- The new name.
- Preconditions:
-
name != null
name
is a valid XML identifier
- See Also:
getName()
-
toString
public String toString()
Writes the XML element to a string.- Overrides:
toString
in classObject
- See Also:
write(Writer)
-
write
public void write(Writer writer) throws IOException
Writes the XML element to a writer.- Parameters:
writer
- The writer to write the XML data to.
- Preconditions:
-
writer != null
writer
is not closed
- Throws:
IOException
- If the data could not be written to the writer.- See Also:
toString()
-
writeEncoded
protected void writeEncoded(Writer writer, String str) throws IOException
Writes a string encoded to a writer.- Parameters:
writer
- The writer to write the XML data to.str
- The string to write encoded.
- Preconditions:
-
writer != null
writer
is not closedstr != null
- Throws:
IOException
-
scanIdentifier
protected void scanIdentifier(StringBuffer result) throws IOException
Scans an identifier from the current reader. The scanned identifier is appended toresult
.- Parameters:
result
- The buffer in which the scanned identifier will be put.
- Preconditions:
-
result != null
- The next character read from the reader is a valid first character of an XML identifier.
- Postconditions:
-
- The next character read from the reader won't be an identifier character.
- Throws:
IOException
-
scanWhitespace
protected char scanWhitespace() throws IOException
This method scans an identifier from the current reader.- Returns:
- the next character following the whitespace.
- Throws:
IOException
-
scanWhitespace
protected char scanWhitespace(StringBuffer result) throws IOException
This method scans an identifier from the current reader. The scanned whitespace is appended toresult
.- Returns:
- the next character following the whitespace.
- Preconditions:
-
result != null
- Throws:
IOException
-
scanString
protected void scanString(StringBuffer string) throws IOException
This method scans a delimited string from the current reader. The scanned string without delimiters is appended tostring
.- Preconditions:
-
string != null
- the next char read is the string delimiter
- Throws:
IOException
-
scanPCData
protected void scanPCData(StringBuffer data) throws IOException
Scans a #PCDATA element. CDATA sections and entities are resolved. The next < char is skipped. The scanned data is appended todata
.- Preconditions:
-
data != null
- Throws:
IOException
-
checkCDATA
protected boolean checkCDATA(StringBuffer buf) throws IOException
Scans a special tag and if the tag is a CDATA section, append its content tobuf
.- Preconditions:
-
buf != null
- The first < has already been read.
- Throws:
IOException
-
skipComment
protected void skipComment() throws IOException
Skips a comment.- Preconditions:
-
- The first <!-- has already been read.
- Throws:
IOException
-
skipSpecialTag
protected void skipSpecialTag(int bracketLevel) throws IOException
Skips a special tag or comment.- Parameters:
bracketLevel
- The number of open square brackets ([) that have already been read.
- Preconditions:
-
- The first <! has already been read.
bracketLevel >= 0
- Throws:
IOException
-
checkLiteral
protected boolean checkLiteral(String literal) throws IOException
Scans the data for literal text. Scanning stops when a character does not match or after the complete text has been checked, whichever comes first.- Parameters:
literal
- the literal to check.
- Preconditions:
-
literal != null
- Throws:
IOException
-
readChar
protected char readChar() throws IOException
Reads a character from a reader.- Throws:
IOException
-
scanElement
protected void scanElement(XMLElement elt) throws IOException
Scans an XML element.- Parameters:
elt
- The element that will contain the result.
- Preconditions:
-
- The first < has already been read.
elt != null
- Throws:
IOException
-
resolveEntity
protected void resolveEntity(StringBuffer buf) throws IOException
Resolves an entity. The name of the entity is read from the reader. The value of the entity is appended tobuf
.- Parameters:
buf
- Where to put the entity value.
- Preconditions:
-
- The first & has already been read.
buf != null
- Throws:
IOException
-
unreadChar
protected void unreadChar(char ch)
Pushes a character back to the read-back buffer.- Parameters:
ch
- The character to push back.
- Preconditions:
-
- The read-back buffer is empty.
ch != '\0'
-
invalidValueSet
protected XMLParseException invalidValueSet(String name)
Creates a parse exception for when an invalid valueset is given to a method.- Parameters:
name
- The name of the entity.
- Preconditions:
-
name != null
-
invalidValue
protected XMLParseException invalidValue(String name, String value)
Creates a parse exception for when an invalid value is given to a method.- Parameters:
name
- The name of the entity.value
- The value of the entity.
- Preconditions:
-
name != null
value != null
-
unexpectedEndOfData
protected XMLParseException unexpectedEndOfData()
Creates a parse exception for when the end of the data input has been reached.
-
syntaxError
protected XMLParseException syntaxError(String context)
Creates a parse exception for when a syntax error occured.- Parameters:
context
- The context in which the error occured.
- Preconditions:
-
context != null
context.length() > 0
-
expectedInput
protected XMLParseException expectedInput(String charSet)
Creates a parse exception for when the next character read is not the character that was expected.- Parameters:
charSet
- The set of characters (in human readable form) that was expected.
- Preconditions:
-
charSet != null
charSet.length() > 0
-
unknownEntity
protected XMLParseException unknownEntity(String name)
Creates a parse exception for when an entity could not be resolved.- Parameters:
name
- The name of the entity.
- Preconditions:
-
name != null
name.length() > 0
-
-