Prev Class | Next Class | Frames | No Frames |
Summary: Nested | Field | Method | Constr | Detail: Nested | Field | Method | Constr |
java.lang.Object
nanoxml.XMLElement
public class XMLElement
extends Object
XMLElement xml = new XMLElement();
FileReader reader = new FileReader("filename.xml");
xml.parseFromReader(reader);
enumerateAttributeNames
getStringAttribute
XMLElement element = ...;
Enumeration enum = element.getAttributeNames();
while (enum.hasMoreElements()) {
String key = (String) enum.nextElement();
String value = element.getStringAttribute(key);
System.out.println(key + " = " + value);
}
enumerateChildren
countChildren
<title>The Title</title>
getContent
createAnotherElement
XMLParseException
Field Summary | |
static int |
|
static int |
|
Constructor Summary | |
| |
| |
| |
| |
| |
|
Method Summary | |
void |
|
void |
|
void |
|
void |
|
protected boolean |
|
protected boolean |
|
int |
|
protected XMLElement |
|
Enumeration |
|
Enumeration |
|
Enumeration |
|
protected XMLParseException |
|
Object |
|
Object |
|
Object |
|
boolean |
|
Vector |
|
String |
|
String |
|
double |
|
double |
|
double |
|
int |
|
int |
|
int |
|
int |
|
int |
|
String |
|
String |
|
Object |
|
String |
|
boolean |
|
double |
|
int |
|
double |
|
int |
|
String |
|
String |
|
String |
|
String |
|
String |
|
protected XMLParseException |
|
protected XMLParseException |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
protected char |
|
void |
|
void |
|
void |
|
void |
|
protected void |
|
protected void |
|
protected void |
|
protected void |
|
protected void |
|
protected char |
|
protected char |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
protected void |
|
protected void |
|
protected XMLParseException |
|
String |
|
protected XMLParseException |
|
protected XMLParseException |
|
protected void |
|
void |
|
protected void |
|
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.
- Field Value:
- 2
- See Also:
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.
- Field Value:
- 2
- See Also:
NANOXML_MAJOR_VERSION
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(Hashtable)
,XMLElement(boolean)
,XMLElement(Hashtable, boolean)
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
- See Also:
XMLElement()
,XMLElement(boolean)
,XMLElement(Hashtable, boolean)
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)
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
- See Also:
XMLElement()
,XMLElement(boolean)
,XMLElement(Hashtable)
,XMLElement(Hashtable, boolean)
protected XMLElement(Hashtable entities, boolean skipLeadingWhitespace, boolean fillBasicConversionTable, boolean ignoreCase)
Creates and initializes a new XML element. This constructor should only be called fromcreateAnotherElement
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()
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()
,XMLElement(Hashtable)
,XMLElement(Hashtable, boolean)
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
public void addProperty(String name, Object value)
Deprecated. Use
setAttribute
instead.Adds or modifies an attribute.
- Parameters:
name
- The name of the attribute.value
- The value of the attribute.
public void addProperty(String name, double value)
Deprecated. Use
setDoubleAttribute
instead.Adds or modifies an attribute.
- Parameters:
name
- The name of the attribute.value
- The value of the attribute.
public void addProperty(String key, int value)
Deprecated. Use
setIntAttribute
instead.Adds or modifies an attribute.
- Parameters:
value
- The value of the attribute.
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.
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
public int countChildren()
Returns the number of child elements of the element.
- Postconditions:
result >= 0
protected XMLElement createAnotherElement()
Creates a new similar XML element. You should override this method when subclassing XMLElement.
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)
public Enumeration enumerateChildren()
Enumerates the child elements.
- Postconditions:
result != null
public Enumeration enumeratePropertyNames()
Deprecated. Use
enumerateAttributeNames
instead.Enumerates the attribute names.
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
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
- See Also:
setAttribute(String, Object)
,removeAttribute(String)
,enumerateAttributeNames()
,getAttribute(String, Object)
,getAttribute(String, Hashtable, String, boolean)
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:
setAttribute(String, Object)
,removeAttribute(String)
,enumerateAttributeNames()
,getAttribute(String)
,getAttribute(String, Object)
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
- See Also:
setAttribute(String, Object)
,removeAttribute(String)
,enumerateAttributeNames()
,getAttribute(String)
,getAttribute(String, Hashtable, String, boolean)
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:
setAttribute(String, Object)
,removeAttribute(String)
,enumerateAttributeNames()
public Vector getChildren()
Returns the child elements as a Vector. It is safe to modify this Vector.
- Postconditions:
result != null
public String getContent()
Returns the PCDATA content of the object. If there is no such content,null
is returned.
- See Also:
setContent(String)
public String getContents()
Deprecated. Use
getContent
instead.Returns the PCDATA content of the object. If there is no such content,null
is returned.
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
- See Also:
setDoubleAttribute(String, double)
,enumerateAttributeNames()
,getDoubleAttribute(String, double)
,getDoubleAttribute(String, Hashtable, String, boolean)
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 objectsdefaultKey
is eithernull
, a key invalueSet
or a double.
- See Also:
setDoubleAttribute(String, double)
,enumerateAttributeNames()
,getDoubleAttribute(String)
,getDoubleAttribute(String, double)
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
- See Also:
setDoubleAttribute(String, double)
,enumerateAttributeNames()
,getDoubleAttribute(String)
,getDoubleAttribute(String, Hashtable, String, boolean)
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
- See Also:
setIntAttribute(String, int)
,enumerateAttributeNames()
,getIntAttribute(String, int)
,getIntAttribute(String, Hashtable, String, boolean)
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 objectsdefaultKey
is eithernull
, a key invalueSet
or an integer.
- See Also:
setIntAttribute(String, int)
,enumerateAttributeNames()
,getIntAttribute(String)
,getIntAttribute(String, int)
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
- See Also:
setIntAttribute(String, int)
,enumerateAttributeNames()
,getIntAttribute(String)
,getIntAttribute(String, Hashtable, String, boolean)
public int getIntProperty(String name, Hashtable valueSet, String defaultKey)
Deprecated. Use
getIntAttribute
instead.Returns an attribute by looking up a key in a hashtable.
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
public String getName()
Returns the name of the element.
- See Also:
setName(String)
public String getProperty(String name)
Deprecated. Use
getStringAttribute
instead.Returns an attribute.
public Object getProperty(String name, Hashtable valueSet, String defaultKey)
Deprecated. Use
getAttribute
instead.Returns an attribute by looking up a key in a hashtable.
public String getProperty(String name, String defaultValue)
Deprecated. Use
getStringAttribute
instead.Returns an attribute.
public boolean getProperty(String key, String trueValue, String falseValue, boolean defaultValue)
Deprecated. Use
getBooleanAttribute
instead.Returns an attribute.
public double getProperty(String name, double defaultValue)
Deprecated. Use
getDoubleAttribute
instead.Returns an attribute.
public int getProperty(String name, int defaultValue)
Deprecated. Use
getIntAttribute
instead.Returns an attribute.
public double getSpecialDoubleProperty(String name, Hashtable valueSet, String defaultKey)
Deprecated. Use
getDoubleAttribute
instead.Returns an attribute by looking up a key in a hashtable.
public int getSpecialIntProperty(String name, Hashtable valueSet, String defaultKey)
Deprecated. Use
getIntAttribute
instead.Returns an attribute by looking up a key in a hashtable.
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
- See Also:
setAttribute(String, Object)
,removeAttribute(String)
,enumerateAttributeNames()
,getStringAttribute(String, String)
,getStringAttribute(String, Hashtable, String, boolean)
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:
setAttribute(String, Object)
,removeAttribute(String)
,enumerateAttributeNames()
,getStringAttribute(String)
,getStringAttribute(String, String)
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
- See Also:
setAttribute(String, Object)
,removeAttribute(String)
,enumerateAttributeNames()
,getStringAttribute(String)
,getStringAttribute(String, Hashtable, String, boolean)
public String getStringProperty(String name, Hashtable valueSet, String defaultKey)
Deprecated. Use
getStringAttribute
instead.Returns an attribute by looking up a key in a hashtable.
public String getTagName()
Deprecated. Use
getName
instead.Returns the name of the element.
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
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
public void parseCharArray(char[] input, int offset, int end) 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.
- 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.
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
- Throws:
XMLParseException
- If an error occured while parsing the string.
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:
XMLParseException
- If an error occured while parsing the read data.
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:
XMLParseException
- If an error occured while parsing the read data.
public void parseString(String string) throws XMLParseException
Reads one XML element from a String and parses it.
- Parameters:
- Throws:
XMLParseException
- If an error occured while parsing the string.
public void parseString(String string, int offset) throws XMLParseException
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
- Throws:
XMLParseException
- If an error occured while parsing the string.
public void parseString(String string, int offset, int end) 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.
- 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.
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
- Throws:
XMLParseException
- If an error occured while parsing the string.
protected char readChar() throws IOException
Reads a character from a reader.
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)
public void removeChild(String name)
Deprecated. Use
removeAttribute
instead.Removes an attribute.
- Parameters:
name
- The name of the attribute.
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
public void removeProperty(String name)
Deprecated. Use
removeAttribute
instead.Removes an attribute.
- Parameters:
name
- The name of the attribute.
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
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
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.
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
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
protected char scanWhitespace() throws IOException
This method scans an identifier from the current reader.
- Returns:
- the next character following the whitespace.
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
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)
public void setContent(String content)
Changes the content string.
- Parameters:
content
- The new content string.
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
- See Also:
setIntAttribute(String, int)
,setAttribute(String, Object)
,removeAttribute(String)
,enumerateAttributeNames()
,getDoubleAttribute(String)
,getDoubleAttribute(String, double)
,getDoubleAttribute(String, Hashtable, String, boolean)
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
- See Also:
setDoubleAttribute(String, double)
,setAttribute(String, Object)
,removeAttribute(String)
,enumerateAttributeNames()
,getIntAttribute(String)
,getIntAttribute(String, int)
,getIntAttribute(String, Hashtable, String, boolean)
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()
public void setTagName(String name)
Deprecated. Use
setName
instead.Changes the name of the element.
- Parameters:
name
- The new name.
protected void skipComment() throws IOException
Skips a comment.
- Preconditions:
- The first <!-- has already been read.
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
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
public String toString()
Writes the XML element to a string.
- See Also:
write(Writer)
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.
- Parameters:
name
- The name of the entity.
- Preconditions:
name != null
name.length() > 0
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'
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
- See Also:
toString()
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