|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object net.n3.nanoxml.XMLElement
public class XMLElement
XMLElement is an XML element. The standard NanoXML builder generates a tree of such elements.
StdXMLBuilder
, Serialized Form
Field Summary | |
---|---|
static int |
NO_LINE No line number defined. |
Constructor Summary | |
---|---|
XMLElement() Creates an empty element to be used for #PCDATA content. |
|
XMLElement(java.lang.String fullName) Creates an empty element. |
|
XMLElement(java.lang.String fullName, java.lang.String namespace) Creates an empty element. |
|
XMLElement(java.lang.String fullName, java.lang.String systemID, int lineNr) Creates an empty element. |
|
XMLElement(java.lang.String fullName, java.lang.String namespace, java.lang.String systemID, int lineNr) Creates an empty element. |
Method Summary | |
---|---|
void |
addChild(IXMLElement child) Adds a child element. |
IXMLElement |
createElement(java.lang.String fullName) Creates an empty element. |
IXMLElement |
createElement(java.lang.String fullName, java.lang.String namespace) Creates an empty element. |
IXMLElement |
createElement(java.lang.String fullName, java.lang.String systemID, int lineNr) Creates an empty element. |
IXMLElement |
createElement(java.lang.String fullName, java.lang.String namespace, java.lang.String systemID, int lineNr) Creates an empty element. |
IXMLElement |
createPCDataElement() Creates an element to be used for #PCDATA content. |
java.util.Enumeration |
enumerateAttributeNames() Returns an enumeration of all attribute names. |
java.util.Enumeration |
enumerateChildren() Returns an enumeration of all child elements. |
boolean |
equals(java.lang.Object rawElement) Returns true if the element equals another element. |
boolean |
equalsXMLElement(IXMLElement elt) Returns true if the element equals another element. |
protected void |
finalize() Cleans up the object when it's destroyed. |
java.lang.String |
getAttribute(java.lang.String name) Deprecated. As of NanoXML/Java 2.1, replaced by getAttribute(java.lang.String,java.lang.String) Returns the value of an attribute.
|
int |
getAttribute(java.lang.String name, int defaultValue) Returns the value of an attribute. |
java.lang.String |
getAttribute(java.lang.String name, java.lang.String defaultValue) Returns the value of an attribute. |
int |
getAttribute(java.lang.String name, java.lang.String namespace, int defaultValue) Returns the value of an attribute. |
java.lang.String |
getAttribute(java.lang.String name, java.lang.String namespace, java.lang.String defaultValue) Returns the value of an attribute. |
int |
getAttributeCount() Returns the number of attributes. |
java.lang.String |
getAttributeNamespace(java.lang.String name) Returns the namespace of an attribute. |
java.util.Properties |
getAttributes() Returns all attributes as a Properties object. |
java.util.Properties |
getAttributesInNamespace(java.lang.String namespace) Returns all attributes in a specific namespace as a Properties object. |
java.lang.String |
getAttributeType(java.lang.String name) Returns the type of an attribute. |
java.lang.String |
getAttributeType(java.lang.String name, java.lang.String namespace) Returns the type of an attribute. |
IXMLElement |
getChildAtIndex(int index) Returns the child at a specific index. |
java.util.Vector |
getChildren() Returns a vector containing all the child elements. |
int |
getChildrenCount() Returns the number of children. |
java.util.Vector |
getChildrenNamed(java.lang.String name) Returns a vector of all child elements named name. |
java.util.Vector |
getChildrenNamed(java.lang.String name, java.lang.String namespace) Returns a vector of all child elements named name. |
java.lang.String |
getContent() Return the #PCDATA content of the element. |
IXMLElement |
getFirstChildNamed(java.lang.String name) Searches a child element. |
IXMLElement |
getFirstChildNamed(java.lang.String name, java.lang.String namespace) Searches a child element. |
java.lang.String |
getFullName() Returns the full name (i.e. |
int |
getLineNr() Returns the line number in the data where the element started. |
java.lang.String |
getName() Returns the name of the element. |
java.lang.String |
getNamespace() Returns the namespace of the element. |
IXMLElement |
getParent() Returns the parent element. |
java.lang.String |
getSystemID() Returns the system ID of the data where the element started. |
boolean |
hasAttribute(java.lang.String name) Returns whether an attribute exists. |
boolean |
hasAttribute(java.lang.String name, java.lang.String namespace) Returns whether an attribute exists. |
boolean |
hasChildren() Returns whether the element has children. |
void |
insertChild(IXMLElement child, int index) Inserts a child element. |
boolean |
isLeaf() Returns whether the element is a leaf element. |
void |
removeAttribute(java.lang.String name) Removes an attribute. |
void |
removeAttribute(java.lang.String name, java.lang.String namespace) Removes an attribute. |
void |
removeChild(IXMLElement child) Removes a child element. |
void |
removeChildAtIndex(int index) Removes the child located at a certain index. |
void |
setAttribute(java.lang.String name, java.lang.String value) Sets an attribute. |
void |
setAttribute(java.lang.String fullName, java.lang.String namespace, java.lang.String value) Sets an attribute. |
void |
setContent(java.lang.String content) Sets the #PCDATA content. |
void |
setName(java.lang.String name) Sets the full name. |
void |
setName(java.lang.String fullName, java.lang.String namespace) Sets the name. |
Methods inherited from class java.lang.Object |
---|
clone, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final int NO_LINE
Constructor Detail |
---|
public XMLElement()
public XMLElement(java.lang.String fullName)
fullName
- the name of the element.public XMLElement(java.lang.String fullName, java.lang.String systemID, int lineNr)
fullName
- the name of the element.systemID
- the system ID of the XML data where the element starts.lineNr
- the line in the XML data where the element starts.public XMLElement(java.lang.String fullName, java.lang.String namespace)
fullName
- the full name of the elementnamespace
- the namespace URI.public XMLElement(java.lang.String fullName, java.lang.String namespace, java.lang.String systemID, int lineNr)
fullName
- the full name of the elementnamespace
- the namespace URI.systemID
- the system ID of the XML data where the element starts.lineNr
- the line in the XML data where the element starts.Method Detail |
---|
public IXMLElement createPCDataElement()
createPCDataElement
in interface IXMLElement
public IXMLElement createElement(java.lang.String fullName)
createElement
in interface IXMLElement
fullName
- the name of the element.public IXMLElement createElement(java.lang.String fullName, java.lang.String systemID, int lineNr)
createElement
in interface IXMLElement
fullName
- the name of the element.systemID
- the system ID of the XML data where the element starts.lineNr
- the line in the XML data where the element starts.public IXMLElement createElement(java.lang.String fullName, java.lang.String namespace)
createElement
in interface IXMLElement
fullName
- the full name of the elementnamespace
- the namespace URI.public IXMLElement createElement(java.lang.String fullName, java.lang.String namespace, java.lang.String systemID, int lineNr)
createElement
in interface IXMLElement
fullName
- the full name of the elementnamespace
- the namespace URI.systemID
- the system ID of the XML data where the element starts.lineNr
- the line in the XML data where the element starts.protected void finalize() throws java.lang.Throwable
finalize
in class java.lang.Object
java.lang.Throwable
public IXMLElement getParent()
getParent
in interface IXMLElement
public java.lang.String getFullName()
getFullName
in interface IXMLElement
public java.lang.String getName()
getName
in interface IXMLElement
public java.lang.String getNamespace()
getNamespace
in interface IXMLElement
public void setName(java.lang.String name)
setName
in interface IXMLElement
name
- the non-null name.public void setName(java.lang.String fullName, java.lang.String namespace)
setName
in interface IXMLElement
fullName
- the non-null full name.namespace
- the namespace URI, which may be null.public void addChild(IXMLElement child)
addChild
in interface IXMLElement
child
- the non-null child to add.public void insertChild(IXMLElement child, int index)
child
- the non-null child to add.index
- where to put the child.public void removeChild(IXMLElement child)
removeChild
in interface IXMLElement
child
- the non-null child to remove.public void removeChildAtIndex(int index)
removeChildAtIndex
in interface IXMLElement
index
- the index of the child, where the first child has index 0.public java.util.Enumeration enumerateChildren()
enumerateChildren
in interface IXMLElement
public boolean isLeaf()
isLeaf
in interface IXMLElement
public boolean hasChildren()
hasChildren
in interface IXMLElement
public int getChildrenCount()
getChildrenCount
in interface IXMLElement
public java.util.Vector getChildren()
getChildren
in interface IXMLElement
public IXMLElement getChildAtIndex(int index) throws java.lang.ArrayIndexOutOfBoundsException
getChildAtIndex
in interface IXMLElement
index
- the index of the childjava.lang.ArrayIndexOutOfBoundsException
- if the index is out of bounds.public IXMLElement getFirstChildNamed(java.lang.String name)
getFirstChildNamed
in interface IXMLElement
name
- the full name of the child to search for.public IXMLElement getFirstChildNamed(java.lang.String name, java.lang.String namespace)
getFirstChildNamed
in interface IXMLElement
name
- the name of the child to search for.namespace
- the namespace, which may be null.public java.util.Vector getChildrenNamed(java.lang.String name)
getChildrenNamed
in interface IXMLElement
name
- the full name of the children to search for.public java.util.Vector getChildrenNamed(java.lang.String name, java.lang.String namespace)
getChildrenNamed
in interface IXMLElement
name
- the name of the children to search for.namespace
- the namespace, which may be null.public int getAttributeCount()
getAttributeCount
in interface IXMLElement
public java.lang.String getAttribute(java.lang.String name)
getAttribute(java.lang.String,java.lang.String)
Returns the value of an attribute.
getAttribute
in interface IXMLElement
name
- the non-null name of the attribute.public java.lang.String getAttribute(java.lang.String name, java.lang.String defaultValue)
getAttribute
in interface IXMLElement
name
- the non-null full name of the attribute.defaultValue
- the default value of the attribute.public java.lang.String getAttribute(java.lang.String name, java.lang.String namespace, java.lang.String defaultValue)
getAttribute
in interface IXMLElement
name
- the non-null name of the attribute.namespace
- the namespace URI, which may be null.defaultValue
- the default value of the attribute.public int getAttribute(java.lang.String name, int defaultValue)
getAttribute
in interface IXMLElement
name
- the non-null full name of the attribute.defaultValue
- the default value of the attribute.public int getAttribute(java.lang.String name, java.lang.String namespace, int defaultValue)
getAttribute
in interface IXMLElement
name
- the non-null name of the attribute.namespace
- the namespace URI, which may be null.defaultValue
- the default value of the attribute.public java.lang.String getAttributeType(java.lang.String name)
getAttributeType
in interface IXMLElement
name
- the non-null full name of the attribute.public java.lang.String getAttributeNamespace(java.lang.String name)
getAttributeNamespace
in interface IXMLElement
name
- the non-null full name of the attribute.public java.lang.String getAttributeType(java.lang.String name, java.lang.String namespace)
getAttributeType
in interface IXMLElement
name
- the non-null name of the attribute.namespace
- the namespace URI, which may be null.public void setAttribute(java.lang.String name, java.lang.String value)
setAttribute
in interface IXMLElement
name
- the non-null full name of the attribute.value
- the non-null value of the attribute.public void setAttribute(java.lang.String fullName, java.lang.String namespace, java.lang.String value)
setAttribute
in interface IXMLElement
fullName
- the non-null full name of the attribute.namespace
- the namespace URI of the attribute, which may be null.value
- the non-null value of the attribute.public void removeAttribute(java.lang.String name)
removeAttribute
in interface IXMLElement
name
- the non-null name of the attribute.public void removeAttribute(java.lang.String name, java.lang.String namespace)
removeAttribute
in interface IXMLElement
name
- the non-null name of the attribute.namespace
- the namespace URI of the attribute, which may be null.public java.util.Enumeration enumerateAttributeNames()
enumerateAttributeNames
in interface IXMLElement
public boolean hasAttribute(java.lang.String name)
hasAttribute
in interface IXMLElement
name
- the non-null name of the attribute.public boolean hasAttribute(java.lang.String name, java.lang.String namespace)
hasAttribute
in interface IXMLElement
name
- the non-null name of the attribute.namespace
- the namespace URI of the attribute, which may be null.public java.util.Properties getAttributes()
getAttributes
in interface IXMLElement
public java.util.Properties getAttributesInNamespace(java.lang.String namespace)
getAttributesInNamespace
in interface IXMLElement
namespace
- the namespace URI of the attributes, which may be null.public java.lang.String getSystemID()
getSystemID
in interface IXMLElement
getLineNr()
public int getLineNr()
getLineNr
in interface IXMLElement
NO_LINE
, getSystemID()
public java.lang.String getContent()
getContent
in interface IXMLElement
public void setContent(java.lang.String content)
setContent
in interface IXMLElement
content
- the (possibly null) content.public boolean equals(java.lang.Object rawElement)
equals
in interface IXMLElement
equals
in class java.lang.Object
rawElement
- the element to compare topublic boolean equalsXMLElement(IXMLElement elt)
equalsXMLElement
in interface IXMLElement
elt
- the element to compare to
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |