Package org.jvnet.lafplugin
Class XMLElement
java.lang.Object
org.jvnet.lafplugin.XMLElement
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.
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final int
Major version of NanoXML.static final int
Minor version of NanoXML. -
Constructor Summary
ConstructorsConstructorDescriptionCreates 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. -
Method Summary
Modifier and TypeMethodDescriptionvoid
addChild
(XMLElement child) Adds a child element.void
addProperty
(String name, double value) Deprecated.void
addProperty
(String key, int value) Deprecated.UsesetIntAttribute
instead.void
addProperty
(String name, Object value) Deprecated.UsesetAttribute
instead.int
Returns the number of child elements of the element.Enumerates the attribute names.Enumerates the child elements.Deprecated.UseenumerateAttributeNames
instead.getAttribute
(String name) Returns an attribute of the element.getAttribute
(String name, Object defaultValue) Returns an attribute of the element.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.Returns the child elements as a Vector.Returns the PCDATA content of the object.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
Returns the line nr in the source data on which the element is found.getName()
Returns the name of the element.getProperty
(String name) Deprecated.UsegetStringAttribute
instead.double
getProperty
(String name, double defaultValue) Deprecated.UsegetDoubleAttribute
instead.int
getProperty
(String name, int defaultValue) Deprecated.UsegetIntAttribute
instead.getProperty
(String name, String defaultValue) Deprecated.UsegetStringAttribute
instead.boolean
getProperty
(String key, String trueValue, String falseValue, boolean defaultValue) Deprecated.UsegetBooleanAttribute
instead.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.getStringAttribute
(String name) Returns an attribute of the element.getStringAttribute
(String name, String defaultValue) Returns an attribute of the element.getStringAttribute
(String name, Hashtable valueSet, String defaultKey, boolean allowLiterals) Returns an attribute by looking up a key in a hashtable.getStringProperty
(String name, Hashtable valueSet, String defaultKey) Deprecated.UsegetStringAttribute
instead.Deprecated.UsegetName
instead.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.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.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
Changes the name of the element.void
setTagName
(String name) Deprecated.UsesetName
instead.toString()
Writes the XML element to a string.void
Writes the XML element to a writer.
-
Field Details
-
NANOXML_MAJOR_VERSION
public static final int NANOXML_MAJOR_VERSIONMajor 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
public static final int NANOXML_MINOR_VERSIONMinor 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:
-
-
Constructor Details
-
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
- See Also:
-
XMLElement
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
- See Also:
-
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
- See Also:
-
XMLElement
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
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
- See Also:
-
-
Method Details
-
addChild
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
- See Also:
-
setAttribute
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:
-
addProperty
Deprecated.UsesetAttribute
instead.Adds or modifies an attribute.- Parameters:
name
- The name of the attribute.value
- The value of the attribute.
-
setIntAttribute
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
- See Also:
-
addProperty
Deprecated.UsesetIntAttribute
instead.Adds or modifies an attribute.- Parameters:
value
- The value of the attribute.name
- The name of the attribute.
-
setDoubleAttribute
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
- See Also:
-
addProperty
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
- See Also:
-
enumerateAttributeNames
Enumerates the attribute names.- Postconditions:
-
result != null
- See Also:
-
enumeratePropertyNames
Deprecated.UseenumerateAttributeNames
instead.Enumerates the attribute names. -
enumerateChildren
Enumerates the child elements.- Postconditions:
-
result != null
- See Also:
-
getChildren
Returns the child elements as a Vector. It is safe to modify this Vector.- Postconditions:
-
result != null
- See Also:
-
getContents
Deprecated.UsegetContent
instead.Returns the PCDATA content of the object. If there is no such content,null
is returned. -
getContent
Returns the PCDATA content of the object. If there is no such content,null
is returned.- See Also:
-
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
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
- See Also:
-
getAttribute
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
- See Also:
-
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
- See Also:
-
getStringAttribute
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
- See Also:
-
getStringAttribute
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
- See Also:
-
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
- See Also:
-
getIntAttribute
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
- See Also:
-
getIntAttribute
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
- See Also:
-
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.
- See Also:
-
getDoubleAttribute
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
- See Also:
-
getDoubleAttribute
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
- See Also:
-
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.
- See Also:
-
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.
- See Also:
-
getIntProperty
Deprecated.UsegetIntAttribute
instead.Returns an attribute by looking up a key in a hashtable. -
getProperty
Deprecated.UsegetStringAttribute
instead.Returns an attribute. -
getProperty
Deprecated.UsegetStringAttribute
instead.Returns an attribute. -
getProperty
Deprecated.UsegetIntAttribute
instead.Returns an attribute. -
getProperty
Deprecated.UsegetDoubleAttribute
instead.Returns an attribute. -
getProperty
Deprecated.UsegetBooleanAttribute
instead.Returns an attribute. -
getProperty
Deprecated.UsegetAttribute
instead.Returns an attribute by looking up a key in a hashtable. -
getStringProperty
Deprecated.UsegetStringAttribute
instead.Returns an attribute by looking up a key in a hashtable. -
getSpecialIntProperty
Deprecated.UsegetIntAttribute
instead.Returns an attribute by looking up a key in a hashtable. -
getSpecialDoubleProperty
Deprecated.UsegetDoubleAttribute
instead.Returns an attribute by looking up a key in a hashtable. -
getName
Returns the name of the element.- See Also:
-
getTagName
Deprecated.UsegetName
instead.Returns the name of the element. -
parseFromReader
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
-
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
-
parseString
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
-
parseString
Reads one XML element from a String and parses it.- Parameters:
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
reader
- The reader from which to retrieve the XML data.
-
parseString
Reads one XML element from a String and parses it.- Parameters:
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
reader
- The reader from which to retrieve the XML data.
-
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:
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
reader
- The reader from which to retrieve the XML data.
-
parseCharArray
Reads one XML element from a char array and parses it.- Parameters:
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
reader
- The reader from which to retrieve the XML data.
-
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:
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
reader
- The reader from which to retrieve the XML data.
-
removeChild
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
- See Also:
-
removeAttribute
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:
-
removeProperty
Deprecated.UseremoveAttribute
instead.Removes an attribute.- Parameters:
name
- The name of the attribute.
-
removeChild
Deprecated.UseremoveAttribute
instead.Removes an attribute.- Parameters:
name
- The name of the attribute.
-
setContent
Changes the content string.- Parameters:
content
- The new content string.
-
setTagName
Deprecated.UsesetName
instead.Changes the name of the element.- Parameters:
name
- The new name.
-
setName
Changes the name of the element.- Parameters:
name
- The new name.
- Preconditions:
-
name != null
name
is a valid XML identifier
- See Also:
-
toString
Writes the XML element to a string. -
write
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:
-
setDoubleAttribute
instead.