freemind.main

Class XMLElement

Known Direct Subclasses:
XMLElementAdapter

public class XMLElement
extends java.lang.Object

XMLElement is a representation of an XML object. The object is able to parse XML code.

Parsing XML Data
    XMLElement xml = new XMLElement();
    FileReader reader = new FileReader("filename.xml");
    xml.parseFromReader(reader);
Retrieving Attributes
enumerateAttributeNamesgetStringAttribute
    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
enumerateChildrencountChildren
Elements Containing Character Data
    <title>The Title</title>
getContent
Subclassing XMLElement
createAnotherElement

Version:
$Name: $, $Revision: 1.7 $
Author:
Marc De Scheemaecker <cyberelf@mac.com>
See Also:
nanoxml.XMLParseException

Field Summary

static int
NANOXML_MAJOR_VERSION
Major version of NanoXML.
static int
NANOXML_MINOR_VERSION
Minor version of NanoXML.
protected boolean
ignoreCase
true if the case of the element and attribute names are case insensitive.

Constructor Summary

XMLElement()
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.
XMLElement(Hashtable entities, boolean skipLeadingWhitespace, boolean fillBasicConversionTable, boolean ignoreCase)
Creates and initializes a new XML element.
XMLElement(boolean skipLeadingWhitespace)
Creates and initializes a new XML element.

Method Summary

void
addChild(XMLElement child)
Adds a child element.
void
addProperty(String name, Object value)
Deprecated. Use setAttribute instead.
void
addProperty(String name, double value)
Deprecated. Use setDoubleAttribute instead.
void
addProperty(String key, int value)
Deprecated. Use setIntAttribute instead.
protected boolean
checkCDATA(StringBuffer buf)
Scans a special tag and if the tag is a CDATA section, append its content to buf.
protected boolean
checkLiteral(String literal)
Scans the data for literal text.
protected void
completeElement()
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. Use enumerateAttributeNames 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, Hashtable valueSet, String defaultKey, boolean allowLiterals)
Returns an attribute by looking up a key in a hashtable.
Object
getAttribute(String name, Object defaultValue)
Returns an attribute of the element.
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. Use getContent instead.
double
getDoubleAttribute(String name)
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.
double
getDoubleAttribute(String name, double defaultValue)
Returns an attribute of the element.
int
getIntAttribute(String name)
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
getIntAttribute(String name, int defaultValue)
Returns an attribute of the element.
int
getIntProperty(String name, Hashtable valueSet, String defaultKey)
Deprecated. Use getIntAttribute 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. Use getStringAttribute instead.
Object
getProperty(String name, Hashtable valueSet, String defaultKey)
Deprecated. Use getAttribute instead.
String
getProperty(String name, String defaultValue)
Deprecated. Use getStringAttribute instead.
boolean
getProperty(String key, String trueValue, String falseValue, boolean defaultValue)
Deprecated. Use getBooleanAttribute instead.
double
getProperty(String name, double defaultValue)
Deprecated. Use getDoubleAttribute instead.
int
getProperty(String name, int defaultValue)
Deprecated. Use getIntAttribute instead.
double
getSpecialDoubleProperty(String name, Hashtable valueSet, String defaultKey)
Deprecated. Use getDoubleAttribute instead.
int
getSpecialIntProperty(String name, Hashtable valueSet, String defaultKey)
Deprecated. Use getIntAttribute instead.
String
getStringAttribute(String name)
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
getStringAttribute(String name, String defaultValue)
Returns an attribute of the element.
String
getStringProperty(String name, Hashtable valueSet, String defaultKey)
Deprecated. Use getStringAttribute instead.
String
getTagName()
Deprecated. Use getName instead.
Object
getUserObject()
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. Use removeAttribute instead.
void
removeChild(XMLElement child)
Removes a child element.
void
removeProperty(String name)
Deprecated. Use removeAttribute 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. Use setName 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.
void
write(Writer writer, boolean withClosingTag)
void
writeClosingTag(Writer writer)
protected void
writeEncoded(Writer writer, String str)
Writes a string encoded to a writer.
void
writeWithoutClosingTag(Writer writer)

Field Details

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.
Field Value:
2
See Also:
nanoxml.XMLElement.NANOXML_MINOR_VERSION

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.XMLElement.NANOXML_MAJOR_VERSION

ignoreCase

protected boolean ignoreCase
true if the case of the element and attribute names are case insensitive.

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(Hashtable), nanoxml.XMLElement.XMLElement(boolean), XMLElement(Hashtable, boolean)

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
See Also:
nanoxml.XMLElement.XMLElement(), nanoxml.XMLElement.XMLElement(boolean), XMLElement(Hashtable, boolean)

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:
nanoxml.XMLElement.XMLElement(), nanoxml.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
See Also:
nanoxml.XMLElement.XMLElement(), nanoxml.XMLElement.XMLElement(boolean), XMLElement(Hashtable), XMLElement(Hashtable, boolean)

XMLElement

protected XMLElement(Hashtable entities,
                     boolean skipLeadingWhitespace,
                     boolean fillBasicConversionTable,
                     boolean ignoreCase)
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 then entities contains at least the following entries: amp, lt, gt, apos and quot
Postconditions:
  • countChildren() => 0
  • enumerateChildren() => empty enumeration
  • enumeratePropertyNames() => empty enumeration
  • getChildren() => empty vector
  • getContent() => ""
  • getLineNr() => 0
  • getName() => null
See Also:
nanoxml.XMLElement.createAnotherElement()

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:
nanoxml.XMLElement.XMLElement(), XMLElement(Hashtable), XMLElement(Hashtable, boolean)

Method Details

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
See Also:
nanoxml.XMLElement.countChildren(), nanoxml.XMLElement.enumerateChildren(), nanoxml.XMLElement.getChildren(), removeChild(XMLElement)

addProperty

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.

addProperty

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.

addProperty

public void addProperty(String key,
                        int value)

Deprecated. Use setIntAttribute instead.

Adds or modifies an attribute.
Parameters:
value - The value of the attribute.

checkCDATA

protected boolean checkCDATA(StringBuffer buf)
            throws IOException
Scans a special tag and if the tag is a CDATA section, append its content to buf.
Preconditions:
  • buf != null
  • The first < has already been read.

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

completeElement

protected void completeElement()

countChildren

public int countChildren()
Returns the number of child elements of the element.
Postconditions:
  • result >= 0
See Also:
addChild(XMLElement), nanoxml.XMLElement.enumerateChildren(), nanoxml.XMLElement.getChildren(), removeChild(XMLElement)

createAnotherElement

protected XMLElement createAnotherElement()
Creates a new similar XML element.

You should override this method when subclassing XMLElement.


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)

enumerateChildren

public Enumeration enumerateChildren()
Enumerates the child elements.
Postconditions:
  • result != null
See Also:
addChild(XMLElement), nanoxml.XMLElement.countChildren(), nanoxml.XMLElement.getChildren(), removeChild(XMLElement)

enumeratePropertyNames

public Enumeration enumeratePropertyNames()

Deprecated. Use enumerateAttributeNames instead.

Enumerates the attribute names.

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

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
See Also:
setAttribute(String, Object), removeAttribute(String), nanoxml.XMLElement.enumerateAttributeNames(), getAttribute(String, Object), getAttribute(String, Hashtable, String, boolean)

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 attribute attr="one", then getAttribute("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 identifier
  • valueSet != null
  • the keys of valueSet are strings
See Also:
setAttribute(String, Object), removeAttribute(String), nanoxml.XMLElement.enumerateAttributeNames(), getAttribute(String), getAttribute(String, Object)

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
See Also:
setAttribute(String, Object), removeAttribute(String), nanoxml.XMLElement.enumerateAttributeNames(), getAttribute(String), getAttribute(String, Hashtable, String, boolean)

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 to trueValue, true is returned. If the value of the attribute is equal to falseValue, false is returned. If the value doesn't match trueValue or falseValue, an exception is thrown.
Parameters:
name - The name of the attribute.
trueValue - The value associated with true.
falseValue - The value associated with true.
defaultValue - Value to use if the attribute is missing.
Preconditions:
  • name != null
  • name is a valid XML identifier
  • trueValue and falseValue are different strings.
See Also:
setAttribute(String, Object), removeAttribute(String), nanoxml.XMLElement.enumerateAttributeNames()

getChildren

public Vector getChildren()
Returns the child elements as a Vector. It is safe to modify this Vector.
Postconditions:
  • result != null
See Also:
addChild(XMLElement), nanoxml.XMLElement.countChildren(), nanoxml.XMLElement.enumerateChildren(), removeChild(XMLElement)

getContent

public String getContent()
Returns the PCDATA content of the object. If there is no such content, null is returned.
See Also:
setContent(String)

getContents

public String getContents()

Deprecated. Use getContent instead.

Returns the PCDATA content of the object. If there is no such content, null is returned.

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
See Also:
setDoubleAttribute(String, double), nanoxml.XMLElement.enumerateAttributeNames(), getDoubleAttribute(String, double), getDoubleAttribute(String, Hashtable, String, boolean)

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 attribute attr="one", then getDoubleAttribute("attr", mapping, defaultKey, false) returns 1.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 identifier
  • valueSet != null
  • the keys of valueSet are strings
  • the values of valueSet are Double objects
  • defaultKey is either null, a key in valueSet or a double.
See Also:
setDoubleAttribute(String, double), nanoxml.XMLElement.enumerateAttributeNames(), getDoubleAttribute(String), getDoubleAttribute(String, double)

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
See Also:
setDoubleAttribute(String, double), nanoxml.XMLElement.enumerateAttributeNames(), getDoubleAttribute(String), getDoubleAttribute(String, Hashtable, String, boolean)

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
See Also:
setIntAttribute(String, int), nanoxml.XMLElement.enumerateAttributeNames(), getIntAttribute(String, int), getIntAttribute(String, Hashtable, String, boolean)

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 attribute attr="one", then getIntAttribute("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.
allowLiteralNumbers - true if literal numbers are valid.
Preconditions:
  • name != null
  • name is a valid XML identifier
  • valueSet != null
  • the keys of valueSet are strings
  • the values of valueSet are Integer objects
  • defaultKey is either null, a key in valueSet or an integer.
See Also:
setIntAttribute(String, int), nanoxml.XMLElement.enumerateAttributeNames(), getIntAttribute(String), getIntAttribute(String, int)

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
See Also:
setIntAttribute(String, int), nanoxml.XMLElement.enumerateAttributeNames(), getIntAttribute(String), getIntAttribute(String, Hashtable, String, boolean)

getIntProperty

public int getIntProperty(String name,
                          Hashtable valueSet,
                          String defaultKey)

Deprecated. Use getIntAttribute instead.

Returns an attribute by looking up a key in a hashtable.

getLineNr

public int getLineNr()
Returns the line nr in the source data on which the element is found. This method returns 0 there is no associated source data.
Postconditions:
  • result >= 0

getName

public String getName()
Returns the name of the element.
See Also:
setName(String)

getProperty

public String getProperty(String name)

Deprecated. Use getStringAttribute instead.

Returns an attribute.

getProperty

public Object getProperty(String name,
                          Hashtable valueSet,
                          String defaultKey)

Deprecated. Use getAttribute instead.

Returns an attribute by looking up a key in a hashtable.

getProperty

public String getProperty(String name,
                          String defaultValue)

Deprecated. Use getStringAttribute instead.

Returns an attribute.

getProperty

public boolean getProperty(String key,
                           String trueValue,
                           String falseValue,
                           boolean defaultValue)

Deprecated. Use getBooleanAttribute instead.

Returns an attribute.

getProperty

public double getProperty(String name,
                          double defaultValue)

Deprecated. Use getDoubleAttribute instead.

Returns an attribute.

getProperty

public int getProperty(String name,
                       int defaultValue)

Deprecated. Use getIntAttribute instead.

Returns an attribute.

getSpecialDoubleProperty

public double getSpecialDoubleProperty(String name,
                                       Hashtable valueSet,
                                       String defaultKey)

Deprecated. Use getDoubleAttribute instead.

Returns an attribute by looking up a key in a hashtable.

getSpecialIntProperty

public int getSpecialIntProperty(String name,
                                 Hashtable valueSet,
                                 String defaultKey)

Deprecated. Use getIntAttribute instead.

Returns an attribute by looking up a key in a hashtable.

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
See Also:
setAttribute(String, Object), removeAttribute(String), nanoxml.XMLElement.enumerateAttributeNames(), getStringAttribute(String, String), getStringAttribute(String, Hashtable, String, boolean)

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 attribute attr="one", then getAttribute("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 identifier
  • valueSet != null
  • the keys of valueSet are strings
  • the values of valueSet are strings
See Also:
setAttribute(String, Object), removeAttribute(String), nanoxml.XMLElement.enumerateAttributeNames(), getStringAttribute(String), getStringAttribute(String, String)

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
See Also:
setAttribute(String, Object), removeAttribute(String), nanoxml.XMLElement.enumerateAttributeNames(), getStringAttribute(String), getStringAttribute(String, Hashtable, String, boolean)

getStringProperty

public String getStringProperty(String name,
                                Hashtable valueSet,
                                String defaultKey)

Deprecated. Use getStringAttribute instead.

Returns an attribute by looking up a key in a hashtable.

getTagName

public String getTagName()

Deprecated. Use getName instead.

Returns the name of the element.

getUserObject

public Object getUserObject()

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

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

parseCharArray

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 in string 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

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 in string 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

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

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

public void parseString(String string)
            throws XMLParseException
Reads one XML element from a String and parses it.
Parameters:

parseString

public void parseString(String string,
                        int offset)
            throws XMLParseException
Reads one XML element from a String and parses it.
Parameters:
offset - The first character in string 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

parseString

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 in string 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

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 in string 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

readChar

protected char readChar()
            throws IOException
Reads a character from a reader.

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:
nanoxml.XMLElement.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)

removeChild

public void removeChild(String name)

Deprecated. Use removeAttribute instead.

Removes an attribute.
Parameters:
name - The name of the attribute.

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
See Also:
addChild(XMLElement), nanoxml.XMLElement.countChildren(), nanoxml.XMLElement.enumerateChildren(), nanoxml.XMLElement.getChildren()

removeProperty

public void removeProperty(String name)

Deprecated. Use removeAttribute instead.

Removes an attribute.
Parameters:
name - The name of the attribute.

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 to buf.
Parameters:
buf - Where to put the entity value.
Preconditions:
  • The first & has already been read.
  • buf != null

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

scanIdentifier

protected void scanIdentifier(StringBuffer result)
            throws IOException
Scans an identifier from the current reader. The scanned identifier is appended to result.
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.

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 to data.
Preconditions:
  • data != null

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 to string.
Preconditions:
  • string != null
  • the next char read is the string delimiter

scanWhitespace

protected char scanWhitespace()
            throws IOException
This method scans an identifier from the current reader.
Returns:
the next character following the whitespace.

scanWhitespace

protected char scanWhitespace(StringBuffer result)
            throws IOException
This method scans an identifier from the current reader. The scanned whitespace is appended to result.
Returns:
the next character following the whitespace.
Preconditions:
  • result != null

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 identifier
  • value != null
Postconditions:
  • enumerateAttributeNames() => old.enumerateAttributeNames() + name
  • getAttribute(name) => value
See Also:
setDoubleAttribute(String, double), setIntAttribute(String, int), nanoxml.XMLElement.enumerateAttributeNames(), getAttribute(String), getAttribute(String, Object), getAttribute(String, Hashtable, String, boolean), getStringAttribute(String), getStringAttribute(String, String), getStringAttribute(String, Hashtable, String, boolean)

setContent

public void setContent(String content)
Changes the content string.
Parameters:
content - The new content string.

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
See Also:
setIntAttribute(String, int), setAttribute(String, Object), removeAttribute(String), nanoxml.XMLElement.enumerateAttributeNames(), getDoubleAttribute(String), getDoubleAttribute(String, double), getDoubleAttribute(String, Hashtable, String, boolean)

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
See Also:
setDoubleAttribute(String, double), setAttribute(String, Object), removeAttribute(String), nanoxml.XMLElement.enumerateAttributeNames(), getIntAttribute(String), getIntAttribute(String, int), getIntAttribute(String, Hashtable, String, boolean)

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:
nanoxml.XMLElement.getName()

setTagName

public void setTagName(String name)

Deprecated. Use setName instead.

Changes the name of the element.
Parameters:
name - The new name.

skipComment

protected void skipComment()
            throws IOException
Skips a comment.
Preconditions:
  • The first <!-- has already been read.

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

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

toString

public String toString()
Writes the XML element to a string.
See Also:
write(Writer)

unexpectedEndOfData

protected XMLParseException unexpectedEndOfData()
Creates a parse exception for when the end of the data input has been reached.

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

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'

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
See Also:
nanoxml.XMLElement.toString()

write

public void write(Writer writer,
                  boolean withClosingTag)
            throws IOException

writeClosingTag

public void writeClosingTag(Writer writer)
            throws IOException

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 closed
  • str != null

writeWithoutClosingTag

public void writeWithoutClosingTag(Writer writer)
            throws IOException