GNU Classpath (0.97.2) | |
Prev Class | Next Class | Frames | No Frames |
Summary: Nested | Field | Method | Constr | Detail: Nested | Field | Method | Constr |
java.lang.Object
javax.imageio.metadata.IIOMetadataNode
Constructor Summary | |
| |
|
Method Summary | |
Node |
|
Node |
|
short |
|
String |
|
String |
|
Attr |
|
Attr |
|
NamedNodeMap |
|
String |
|
NodeList |
|
NodeList |
|
NodeList |
|
Object |
|
Node |
|
Node |
|
int |
|
String |
|
String |
|
Node |
|
String |
|
short |
|
String |
|
Document |
|
Node |
|
String |
|
Node |
|
TypeInfo |
|
String |
|
String |
|
Object |
|
Object | |
boolean |
|
boolean |
|
boolean |
|
boolean |
|
Node |
|
boolean |
|
boolean |
|
boolean |
|
boolean |
|
Node |
|
String |
|
String |
|
void |
|
void |
|
void |
|
Attr |
|
Node |
|
Node |
|
void |
|
void |
|
Attr |
|
Attr |
|
void |
|
void |
|
void |
|
void |
|
void | |
void |
|
Object |
|
void |
Methods inherited from class java.lang.Object | |
clone , equals , extends Object> getClass , finalize , hashCode , notify , notifyAll , toString , wait , wait , wait |
public IIOMetadataNode()
The basic constructor. Object is special, because it has no superclass, so there is no call to super().
public Node appendChild(Node newChild)
Adds the nodenewChild
to the end of the list of children of this node. If thenewChild
is already in the tree, it is first removed.
- Specified by:
- appendChild in interface Node
- Parameters:
newChild
- The node to add.If it is aDocumentFragment
object, the entire contents of the document fragment are moved into the child list of this node
- Returns:
- The node added.
- Throws:
DOMException
- HIERARCHY_REQUEST_ERR: Raised if this node is of a type that does not allow children of the type of thenewChild
node, or if the node to append is one of this node's ancestors or this node itself, or if this node is of typeDocument
and the DOM application attempts to append a secondDocumentType
orElement
node.
WRONG_DOCUMENT_ERR: Raised ifnewChild
was created from a different document than the one that created this node.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly or if the previous parent of the node being inserted is readonly.
NOT_SUPPORTED_ERR: if thenewChild
node is a child of theDocument
node, this exception might be raised if the DOM implementation doesn't support the removal of theDocumentType
child orElement
child.
public Node cloneNode(boolean deep)
Returns a duplicate of this node, i.e., serves as a generic copy constructor for nodes. The duplicate node has no parent (parentNode
isnull
) and no user data. User data associated to the imported node is not carried over. However, if anyUserDataHandlers
has been specified along with the associated data these handlers will be called with the appropriate parameters before this method returns.
Cloning anElement
copies all attributes and their values, including those generated by the XML processor to represent defaulted attributes, but this method does not copy any children it contains unless it is a deep clone. This includes text contained in an theElement
since the text is contained in a childText
node. Cloning anAttr
directly, as opposed to be cloned as part of anElement
cloning operation, returns a specified attribute (specified
istrue
). Cloning anAttr
always clones its children, since they represent its value, no matter whether this is a deep clone or not. Cloning anEntityReference
automatically constructs its subtree if a correspondingEntity
is available, no matter whether this is a deep clone or not. Cloning any other type of node simply returns a copy of this node.
Note that cloning an immutable subtree results in a mutable copy, but the children of anEntityReference
clone are readonly . In addition, clones of unspecifiedAttr
nodes are specified. And, cloningDocument
,DocumentType
,Entity
, andNotation
nodes is implementation dependent.
- Parameters:
deep
- Iftrue
, recursively clone the subtree under the specified node; iffalse
, clone only the node itself (and its attributes, if it is anElement
).
- Returns:
- The duplicate node.
public short compareDocumentPosition(Node other) throws DOMException
Compares the reference node, i.e. the node on which this method is being called, with a node, i.e. the one passed as a parameter, with regard to their position in the document and according to the document order.
- Specified by:
- compareDocumentPosition in interface Node
- Parameters:
other
- The node to compare against the reference node.
- Returns:
- Returns how the node is positioned relatively to the reference node.
- Throws:
DOMException
- NOT_SUPPORTED_ERR: when the compared nodes are from different DOM implementations that do not coordinate to return consistent implementation-specific results.
- Since:
- DOM Level 3
public String getAttribute(String name)
Retrieves an attribute value by name.
- Specified by:
- getAttribute in interface Element
- Parameters:
name
- The name of the attribute to retrieve.
- Returns:
- The
Attr
value as a string, or the empty string if that attribute does not have a specified or default value.
public String getAttributeNS(String namespaceURI, String localName)
Retrieves an attribute value by local name and namespace URI.
Per [XML Namespaces] , applications must use the valuenull
as thenamespaceURI
parameter for methods if they wish to have no namespace.
- Specified by:
- getAttributeNS in interface Element
- Parameters:
namespaceURI
- The namespace URI of the attribute to retrieve.localName
- The local name of the attribute to retrieve.
- Returns:
- The
Attr
value as a string, or the empty string if that attribute does not have a specified or default value.
- Throws:
DOMException
- NOT_SUPPORTED_ERR: May be raised if the implementation does not support the feature"XML"
and the language exposed through the Document does not support XML Namespaces (such as [HTML 4.01]).
- Since:
- DOM Level 2
public Attr getAttributeNode(String name)
Retrieves an attribute node by name.
To retrieve an attribute node by qualified name and namespace URI, use thegetAttributeNodeNS
method.
- Specified by:
- getAttributeNode in interface Element
- Parameters:
name
- The name (nodeName
) of the attribute to retrieve.
- Returns:
- The
Attr
node with the specified name (nodeName
) ornull
if there is no such attribute.
public Attr getAttributeNodeNS(String namespaceURI, String localName)
Retrieves anAttr
node by local name and namespace URI.
Per [XML Namespaces] , applications must use the valuenull
as thenamespaceURI
parameter for methods if they wish to have no namespace.
- Specified by:
- getAttributeNodeNS in interface Element
- Parameters:
namespaceURI
- The namespace URI of the attribute to retrieve.localName
- The local name of the attribute to retrieve.
- Returns:
- The
Attr
node with the specified attribute local name and namespace URI ornull
if there is no such attribute.
- Throws:
DOMException
- NOT_SUPPORTED_ERR: May be raised if the implementation does not support the feature"XML"
and the language exposed through the Document does not support XML Namespaces (such as [HTML 4.01]).
- Since:
- DOM Level 2
public NamedNodeMap getAttributes()
ANamedNodeMap
containing the attributes of this node (if it is anElement
) ornull
otherwise.
- Specified by:
- getAttributes in interface Node
public String getBaseURI()
The absolute base URI of this node ornull
if the implementation wasn't able to obtain an absolute URI. This value is computed as described in . However, when theDocument
supports the feature "HTML" [DOM Level 2 HTML] , the base URI is computed using first the value of the href attribute of the HTML BASE element if any, and the value of thedocumentURI
attribute from theDocument
interface otherwise.
- Specified by:
- getBaseURI in interface Node
- Since:
- DOM Level 3
public NodeList getChildNodes()
ANodeList
that contains all children of this node. If there are no children, this is aNodeList
containing no nodes.
- Specified by:
- getChildNodes in interface Node
public NodeList getElementsByTagName(String name)
Returns aNodeList
of all descendantElements
with a given tag name, in document order.
- Specified by:
- getElementsByTagName in interface Element
- Parameters:
name
- The name of the tag to match on. The special value "*" matches all tags.
- Returns:
- A list of matching
Element
nodes.
public NodeList getElementsByTagNameNS(String namespaceURI, String localName)
Returns aNodeList
of all the descendantElements
with a given local name and namespace URI in document order.
- Specified by:
- getElementsByTagNameNS in interface Element
- Parameters:
namespaceURI
- The namespace URI of the elements to match on. The special value "*" matches all namespaces.localName
- The local name of the elements to match on. The special value "*" matches all local names.
- Returns:
- A new
NodeList
object containing all the matchedElements
.
- Throws:
DOMException
- NOT_SUPPORTED_ERR: May be raised if the implementation does not support the feature"XML"
and the language exposed through the Document does not support XML Namespaces (such as [HTML 4.01]).
- Since:
- DOM Level 2
public Object getFeature(String feature, String version)
This method returns a specialized object which implements the specialized APIs of the specified feature and version, as specified in . The specialized object may also be obtained by using binding-specific casting methods but is not necessarily expected to, as discussed in . This method also allow the implementation to provide specialized objects which do not support theNode
interface.
- Specified by:
- getFeature in interface Node
- Parameters:
feature
- The name of the feature requested. Note that any plus sign "+" prepended to the name of the feature will be ignored since it is not significant in the context of this method.version
- This is the version number of the feature to test.
- Returns:
- Returns an object which implements the specialized APIs of the specified feature and version, if any, or
null
if there is no object which implements interfaces associated with that feature. If theDOMObject
returned by this method implements theNode
interface, it must delegate to the primary coreNode
and not return results inconsistent with the primary coreNode
such as attributes, childNodes, etc.
- Since:
- DOM Level 3
public Node getFirstChild()
The first child of this node. If there is no such node, this returnsnull
.
- Specified by:
- getFirstChild in interface Node
public Node getLastChild()
The last child of this node. If there is no such node, this returnsnull
.
- Specified by:
- getLastChild in interface Node
public int getLength()
The number of nodes in the list. The range of valid child node indices is 0 tolength-1
inclusive.
public String getLocalName()
Returns the local part of the qualified name of this node.
For nodes of any type other thanELEMENT_NODE
andATTRIBUTE_NODE
and nodes created with a DOM Level 1 method, such asDocument.createElement()
, this is alwaysnull
.
- Specified by:
- getLocalName in interface Node
- Since:
- DOM Level 2
public String getNamespaceURI()
The namespace URI of this node, ornull
if it is unspecified (see ).
This is not a computed value that is the result of a namespace lookup based on an examination of the namespace declarations in scope. It is merely the namespace URI given at creation time.
For nodes of any type other thanELEMENT_NODE
andATTRIBUTE_NODE
and nodes created with a DOM Level 1 method, such asDocument.createElement()
, this is alwaysnull
. Note: Per the Namespaces in XML Specification [XML Namespaces] an attribute does not inherit its namespace from the element it is attached to. If an attribute is not explicitly given a namespace, it simply has no namespace.
- Specified by:
- getNamespaceURI in interface Node
- Since:
- DOM Level 2
public Node getNextSibling()
The node immediately following this node. If there is no such node, this returnsnull
.
- Specified by:
- getNextSibling in interface Node
public String getNodeName()
The name of this node, depending on its type; see the table above.
- Specified by:
- getNodeName in interface Node
public short getNodeType()
A code representing the type of the underlying object, as defined above.
- Specified by:
- getNodeType in interface Node
public String getNodeValue()
The value of this node, depending on its type; see the table above. When it is defined to benull
, setting it has no effect, including if the node is read-only.
- Specified by:
- getNodeValue in interface Node
- Throws:
DOMException
- DOMSTRING_SIZE_ERR: Raised when it would return more characters than fit in aDOMString
variable on the implementation platform.
public Document getOwnerDocument()
TheDocument
object associated with this node. This is also theDocument
object used to create new nodes. When this node is aDocument
or aDocumentType
which is not used with anyDocument
yet, this isnull
.
- Specified by:
- getOwnerDocument in interface Node
public Node getParentNode()
The parent of this node. All nodes, exceptAttr
,Document
,DocumentFragment
,Entity
, andNotation
may have a parent. However, if a node has just been created and not yet added to the tree, or if it has been removed from the tree, this isnull
.
- Specified by:
- getParentNode in interface Node
public String getPrefix()
The namespace prefix of this node, ornull
if it is unspecified. When it is defined to benull
, setting it has no effect, including if the node is read-only.
Note that setting this attribute, when permitted, changes thenodeName
attribute, which holds the qualified name, as well as thetagName
andname
attributes of theElement
andAttr
interfaces, when applicable.
Setting the prefix tonull
makes it unspecified, setting it to an empty string is implementation dependent.
Note also that changing the prefix of an attribute that is known to have a default value, does not make a new attribute with the default value and the original prefix appear, since thenamespaceURI
andlocalName
do not change.
For nodes of any type other thanELEMENT_NODE
andATTRIBUTE_NODE
and nodes created with a DOM Level 1 method, such ascreateElement
from theDocument
interface, this is alwaysnull
.
- Since:
- DOM Level 2
public Node getPreviousSibling()
The node immediately preceding this node. If there is no such node, this returnsnull
.
- Specified by:
- getPreviousSibling in interface Node
public TypeInfo getSchemaTypeInfo()
The type information associated with this element.
- Specified by:
- getSchemaTypeInfo in interface Element
- Since:
- DOM Level 3
public String getTagName()
The name of the element. IfNode.localName
is different fromnull
, this attribute is a qualified name. For example, in:<elementExample id="demo"> ... </elementExample> ,tagName
has the value"elementExample"
. Note that this is case-preserving in XML, as are all of the operations of the DOM. The HTML DOM returns thetagName
of an HTML element in the canonical uppercase form, regardless of the case in the source HTML document.
- Specified by:
- getTagName in interface Element
public String getTextContent() throws DOMException
This attribute returns the text content of this node and its descendants. When it is defined to benull
, setting it has no effect. On setting, any possible children this node may have are removed and, if it the new string is not empty ornull
, replaced by a singleText
node containing the string this attribute is set to.
On getting, no serialization is performed, the returned string does not contain any markup. No whitespace normalization is performed and the returned string does not contain the white spaces in element content (see the attributeText.isElementContentWhitespace
). Similarly, on setting, no parsing is performed either, the input string is taken as pure textual content.
The string returned is made of the text content of this node depending on its type, as defined below:
Node type Content ELEMENT_NODE, ATTRIBUTE_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, DOCUMENT_FRAGMENT_NODE concatenation of the textContent
attribute value of every child node, excluding COMMENT_NODE and PROCESSING_INSTRUCTION_NODE nodes. This is the empty string if the node has no children.TEXT_NODE, CDATA_SECTION_NODE, COMMENT_NODE, PROCESSING_INSTRUCTION_NODE nodeValue
DOCUMENT_NODE, DOCUMENT_TYPE_NODE, NOTATION_NODE null
- Specified by:
- getTextContent in interface Node
- Throws:
DOMException
- DOMSTRING_SIZE_ERR: Raised when it would return more characters than fit in aDOMString
variable on the implementation platform.
- Since:
- DOM Level 3
public Object getUserData(String key)
Retrieves the object associated to a key on a this node. The object must first have been set to this node by callingsetUserData
with the same key.
- Specified by:
- getUserData in interface Node
- Parameters:
key
- The key the object is associated to.
- Returns:
- Returns the
DOMUserData
associated to the given key on this node, ornull
if there was none.
- Since:
- DOM Level 3
public boolean hasAttribute(String name)
Returnstrue
when an attribute with a given name is specified on this element or has a default value,false
otherwise.
- Specified by:
- hasAttribute in interface Element
- Parameters:
name
- The name of the attribute to look for.
- Returns:
true
if an attribute with the given name is specified on this element or has a default value,false
otherwise.
- Since:
- DOM Level 2
public boolean hasAttributeNS(String namespaceURI, String localName)
Returnstrue
when an attribute with a given local name and namespace URI is specified on this element or has a default value,false
otherwise.
Per [XML Namespaces] , applications must use the valuenull
as thenamespaceURI
parameter for methods if they wish to have no namespace.
- Specified by:
- hasAttributeNS in interface Element
- Parameters:
namespaceURI
- The namespace URI of the attribute to look for.localName
- The local name of the attribute to look for.
- Returns:
true
if an attribute with the given local name and namespace URI is specified or has a default value on this element,false
otherwise.
- Throws:
DOMException
- NOT_SUPPORTED_ERR: May be raised if the implementation does not support the feature"XML"
and the language exposed through the Document does not support XML Namespaces (such as [HTML 4.01]).
- Since:
- DOM Level 2
public boolean hasAttributes()
Returns whether this node (if it is an element) has any attributes.
- Specified by:
- hasAttributes in interface Node
- Returns:
- Returns
true
if this node has any attributes,false
otherwise.
- Since:
- DOM Level 2
public boolean hasChildNodes()
Returns whether this node has any children.
- Specified by:
- hasChildNodes in interface Node
- Returns:
- Returns
true
if this node has any children,false
otherwise.
public Node insertBefore(Node newChild, Node refChild)
Inserts the nodenewChild
before the existing child noderefChild
. IfrefChild
isnull
, insertnewChild
at the end of the list of children.
IfnewChild
is aDocumentFragment
object, all of its children are inserted, in the same order, beforerefChild
. If thenewChild
is already in the tree, it is first removed. Note: Inserting a node before itself is implementation dependent.
- Specified by:
- insertBefore in interface Node
- Parameters:
newChild
- The node to insert.refChild
- The reference node, i.e., the node before which the new node must be inserted.
- Returns:
- The node being inserted.
- Throws:
DOMException
- HIERARCHY_REQUEST_ERR: Raised if this node is of a type that does not allow children of the type of thenewChild
node, or if the node to insert is one of this node's ancestors or this node itself, or if this node is of typeDocument
and the DOM application attempts to insert a secondDocumentType
orElement
node.
WRONG_DOCUMENT_ERR: Raised ifnewChild
was created from a different document than the one that created this node.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly or if the parent of the node being inserted is readonly.
NOT_FOUND_ERR: Raised ifrefChild
is not a child of this node.
NOT_SUPPORTED_ERR: if this node is of typeDocument
, this exception might be raised if the DOM implementation doesn't support the insertion of aDocumentType
orElement
node.
public boolean isDefaultNamespace(String namespaceURI)
This method checks if the specifiednamespaceURI
is the default namespace or not.
- Specified by:
- isDefaultNamespace in interface Node
- Parameters:
namespaceURI
- The namespace URI to look for.
- Returns:
- Returns
true
if the specifiednamespaceURI
is the default namespace,false
otherwise.
- Since:
- DOM Level 3
public boolean isEqualNode(Node arg)
Tests whether two nodes are equal.
This method tests for equality of nodes, not sameness (i.e., whether the two nodes are references to the same object) which can be tested withNode.isSameNode()
. All nodes that are the same will also be equal, though the reverse may not be true.
Two nodes are equal if and only if the following conditions are satisfied:
- The two nodes are of the same type.
- The following string attributes are equal:
nodeName
,localName
,namespaceURI
,prefix
,nodeValue
. This is: they are bothnull
, or they have the same length and are character for character identical.- The
attributes
NamedNodeMaps
are equal. This is: they are bothnull
, or they have the same length and for each node that exists in one map there is a node that exists in the other map and is equal, although not necessarily at the same index.- The
childNodes
NodeLists
are equal. This is: they are bothnull
, or they have the same length and contain equal nodes at the same index. Note that normalization can affect equality; to avoid this, nodes should be normalized before being compared.
For twoDocumentType
nodes to be equal, the following conditions must also be satisfied:
- The following string attributes are equal:
publicId
,systemId
,internalSubset
.- The
entities
NamedNodeMaps
are equal.- The
notations
NamedNodeMaps
are equal.
On the other hand, the following do not affect equality: theownerDocument
,baseURI
, andparentNode
attributes, thespecified
attribute forAttr
nodes, theschemaTypeInfo
attribute forAttr
andElement
nodes, theText.isElementContentWhitespace
attribute forText
nodes, as well as any user data or event listeners registered on the nodes. Note: As a general rule, anything not mentioned in the description above is not significant in consideration of equality checking. Note that future versions of this specification may take into account more attributes and implementations conform to this specification are expected to be updated accordingly.
- Specified by:
- isEqualNode in interface Node
- Parameters:
arg
- The node to compare equality with.
- Returns:
- Returns
true
if the nodes are equal,false
otherwise.
- Since:
- DOM Level 3
public boolean isSameNode(Node other)
Returns whether this node is the same node as the given one.
This method provides a way to determine whether twoNode
references returned by the implementation reference the same object. When twoNode
references are references to the same object, even if through a proxy, the references may be used completely interchangeably, such that all attributes have the same values and calling the same DOM method on either reference always has exactly the same effect.
- Specified by:
- isSameNode in interface Node
- Parameters:
other
- The node to test against.
- Returns:
- Returns
true
if the nodes are the same,false
otherwise.
- Since:
- DOM Level 3
public boolean isSupported(String feature, String version)
Tests whether the DOM implementation implements a specific feature and that feature is supported by this node, as specified in .
- Specified by:
- isSupported in interface Node
- Parameters:
feature
- The name of the feature to test.version
- This is the version number of the feature to test.
- Returns:
- Returns
true
if the specified feature is supported on this node,false
otherwise.
- Since:
- DOM Level 2
public Node item(int index)
Returns theindex
th item in the collection. Ifindex
is greater than or equal to the number of nodes in the list, this returnsnull
.
- Parameters:
index
- Index into the collection.
- Returns:
- The node at the
index
th position in theNodeList
, ornull
if that is not a valid index.
public String lookupNamespaceURI(String prefix)
Look up the namespace URI associated to the given prefix, starting from this node.
See for details on the algorithm used by this method.
- Specified by:
- lookupNamespaceURI in interface Node
- Parameters:
prefix
- The prefix to look for. If this parameter isnull
, the method will return the default namespace URI if any.
- Returns:
- Returns the associated namespace URI or
null
if none is found.
- Since:
- DOM Level 3
public String lookupPrefix(String namespaceURI)
Look up the prefix associated to the given namespace URI, starting from this node. The default namespace declarations are ignored by this method.
See for details on the algorithm used by this method.
- Specified by:
- lookupPrefix in interface Node
- Parameters:
namespaceURI
- The namespace URI to look for.
- Returns:
- Returns an associated namespace prefix if found or
null
if none is found. If more than one prefix are associated to the namespace prefix, the returned namespace prefix is implementation dependent.
- Since:
- DOM Level 3
public void normalize()
Puts allText
nodes in the full depth of the sub-tree underneath thisNode
, including attribute nodes, into a "normal" form where only structure (e.g., elements, comments, processing instructions, CDATA sections, and entity references) separatesText
nodes, i.e., there are neither adjacentText
nodes nor emptyText
nodes. This can be used to ensure that the DOM view of a document is the same as if it were saved and re-loaded, and is useful when operations (such as XPointer [XPointer] lookups) that depend on a particular document tree structure are to be used. If the parameter "normalize-characters" of theDOMConfiguration
object attached to theNode.ownerDocument
istrue
, this method will also fully normalize the characters of theText
nodes. Note: In cases where the document containsCDATASections
, the normalize operation alone may not be sufficient, since XPointers do not differentiate betweenText
nodes andCDATASection
nodes.
public void removeAttribute(String name)
Removes an attribute by name. If a default value for the removed attribute is defined in the DTD, a new attribute immediately appears with the default value as well as the corresponding namespace URI, local name, and prefix when applicable. The implementation may handle default values from other schemas similarly but applications should useDocument.normalizeDocument()
to guarantee this information is up-to-date.
If no attribute with this name is found, this method has no effect.
To remove an attribute by local name and namespace URI, use theremoveAttributeNS
method.
- Specified by:
- removeAttribute in interface Element
- Parameters:
name
- The name of the attribute to remove.
- Throws:
DOMException
- NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
public void removeAttributeNS(String namespaceURI, String localName)
Removes an attribute by local name and namespace URI. If a default value for the removed attribute is defined in the DTD, a new attribute immediately appears with the default value as well as the corresponding namespace URI, local name, and prefix when applicable. The implementation may handle default values from other schemas similarly but applications should useDocument.normalizeDocument()
to guarantee this information is up-to-date.
If no attribute with this local name and namespace URI is found, this method has no effect.
Per [XML Namespaces] , applications must use the valuenull
as thenamespaceURI
parameter for methods if they wish to have no namespace.
- Specified by:
- removeAttributeNS in interface Element
- Parameters:
namespaceURI
- The namespace URI of the attribute to remove.localName
- The local name of the attribute to remove.
- Throws:
DOMException
- NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
NOT_SUPPORTED_ERR: May be raised if the implementation does not support the feature"XML"
and the language exposed through the Document does not support XML Namespaces (such as [HTML 4.01]).
- Since:
- DOM Level 2
public Attr removeAttributeNode(Attr oldAttr)
Removes the specified attribute node. If a default value for the removedAttr
node is defined in the DTD, a new node immediately appears with the default value as well as the corresponding namespace URI, local name, and prefix when applicable. The implementation may handle default values from other schemas similarly but applications should useDocument.normalizeDocument()
to guarantee this information is up-to-date.
- Specified by:
- removeAttributeNode in interface Element
- Parameters:
oldAttr
- TheAttr
node to remove from the attribute list.
- Returns:
- The
Attr
node that was removed.
- Throws:
DOMException
- NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
NOT_FOUND_ERR: Raised ifoldAttr
is not an attribute of the element.
public Node removeChild(Node oldChild)
Removes the child node indicated byoldChild
from the list of children, and returns it.
- Specified by:
- removeChild in interface Node
- Parameters:
oldChild
- The node being removed.
- Returns:
- The node removed.
- Throws:
DOMException
- NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
NOT_FOUND_ERR: Raised ifoldChild
is not a child of this node.
NOT_SUPPORTED_ERR: if this node is of typeDocument
, this exception might be raised if the DOM implementation doesn't support the removal of theDocumentType
child or theElement
child.
public Node replaceChild(Node newChild, Node oldChild)
Replaces the child nodeoldChild
withnewChild
in the list of children, and returns theoldChild
node.
IfnewChild
is aDocumentFragment
object,oldChild
is replaced by all of theDocumentFragment
children, which are inserted in the same order. If thenewChild
is already in the tree, it is first removed. Note: Replacing a node with itself is implementation dependent.
- Specified by:
- replaceChild in interface Node
- Parameters:
newChild
- The new node to put in the child list.oldChild
- The node being replaced in the list.
- Returns:
- The node replaced.
- Throws:
DOMException
- HIERARCHY_REQUEST_ERR: Raised if this node is of a type that does not allow children of the type of thenewChild
node, or if the node to put in is one of this node's ancestors or this node itself, or if this node is of typeDocument
and the result of the replacement operation would add a secondDocumentType
orElement
on theDocument
node.
WRONG_DOCUMENT_ERR: Raised ifnewChild
was created from a different document than the one that created this node.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node or the parent of the new node is readonly.
NOT_FOUND_ERR: Raised ifoldChild
is not a child of this node.
NOT_SUPPORTED_ERR: if this node is of typeDocument
, this exception might be raised if the DOM implementation doesn't support the replacement of theDocumentType
child orElement
child.
public void setAttribute(String name, String value)
Adds a new attribute. If an attribute with that name is already present in the element, its value is changed to be that of the value parameter. This value is a simple string; it is not parsed as it is being set. So any markup (such as syntax to be recognized as an entity reference) is treated as literal text, and needs to be appropriately escaped by the implementation when it is written out. In order to assign an attribute value that contains entity references, the user must create anAttr
node plus anyText
andEntityReference
nodes, build the appropriate subtree, and usesetAttributeNode
to assign it as the value of an attribute.
To set an attribute with a qualified name and namespace URI, use thesetAttributeNS
method.
- Specified by:
- setAttribute in interface Element
- Parameters:
name
- The name of the attribute to create or alter.value
- Value to set in string form.
- Throws:
DOMException
- INVALID_CHARACTER_ERR: Raised if the specified name is not an XML name according to the XML version in use specified in theDocument.xmlVersion
attribute.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
public void setAttributeNS(String namespaceURI, String qualifiedName, String value)
Adds a new attribute. If an attribute with the same local name and namespace URI is already present on the element, its prefix is changed to be the prefix part of thequalifiedName
, and its value is changed to be thevalue
parameter. This value is a simple string; it is not parsed as it is being set. So any markup (such as syntax to be recognized as an entity reference) is treated as literal text, and needs to be appropriately escaped by the implementation when it is written out. In order to assign an attribute value that contains entity references, the user must create anAttr
node plus anyText
andEntityReference
nodes, build the appropriate subtree, and usesetAttributeNodeNS
orsetAttributeNode
to assign it as the value of an attribute.
Per [XML Namespaces] , applications must use the valuenull
as thenamespaceURI
parameter for methods if they wish to have no namespace.
- Specified by:
- setAttributeNS in interface Element
- Parameters:
namespaceURI
- The namespace URI of the attribute to create or alter.qualifiedName
- The qualified name of the attribute to create or alter.value
- The value to set in string form.
- Throws:
DOMException
- INVALID_CHARACTER_ERR: Raised if the specified qualified name is not an XML name according to the XML version in use specified in theDocument.xmlVersion
attribute.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
NAMESPACE_ERR: Raised if thequalifiedName
is malformed per the Namespaces in XML specification, if thequalifiedName
has a prefix and thenamespaceURI
isnull
, if thequalifiedName
has a prefix that is "xml" and thenamespaceURI
is different from " http://www.w3.org/XML/1998/namespace", if thequalifiedName
or its prefix is "xmlns" and thenamespaceURI
is different from "http://www.w3.org/2000/xmlns/", or if thenamespaceURI
is "http://www.w3.org/2000/xmlns/" and neither thequalifiedName
nor its prefix is "xmlns".
NOT_SUPPORTED_ERR: May be raised if the implementation does not support the feature"XML"
and the language exposed through the Document does not support XML Namespaces (such as [HTML 4.01]).
- Since:
- DOM Level 2
public Attr setAttributeNode(Attr newAttr)
Adds a new attribute node. If an attribute with that name (nodeName
) is already present in the element, it is replaced by the new one. Replacing an attribute node by itself has no effect.
To add a new attribute node with a qualified name and namespace URI, use thesetAttributeNodeNS
method.
- Specified by:
- setAttributeNode in interface Element
- Parameters:
newAttr
- TheAttr
node to add to the attribute list.
- Returns:
- If the
newAttr
attribute replaces an existing attribute, the replacedAttr
node is returned, otherwisenull
is returned.
- Throws:
DOMException
- WRONG_DOCUMENT_ERR: Raised ifnewAttr
was created from a different document than the one that created the element.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
INUSE_ATTRIBUTE_ERR: Raised ifnewAttr
is already an attribute of anotherElement
object. The DOM user must explicitly cloneAttr
nodes to re-use them in other elements.
public Attr setAttributeNodeNS(Attr newAttr)
Adds a new attribute. If an attribute with that local name and that namespace URI is already present in the element, it is replaced by the new one. Replacing an attribute node by itself has no effect.
Per [XML Namespaces] , applications must use the valuenull
as thenamespaceURI
parameter for methods if they wish to have no namespace.
- Specified by:
- setAttributeNodeNS in interface Element
- Parameters:
newAttr
- TheAttr
node to add to the attribute list.
- Returns:
- If the
newAttr
attribute replaces an existing attribute with the same local name and namespace URI, the replacedAttr
node is returned, otherwisenull
is returned.
- Throws:
DOMException
- WRONG_DOCUMENT_ERR: Raised ifnewAttr
was created from a different document than the one that created the element.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
INUSE_ATTRIBUTE_ERR: Raised ifnewAttr
is already an attribute of anotherElement
object. The DOM user must explicitly cloneAttr
nodes to re-use them in other elements.
NOT_SUPPORTED_ERR: May be raised if the implementation does not support the feature"XML"
and the language exposed through the Document does not support XML Namespaces (such as [HTML 4.01]).
- Since:
- DOM Level 2
public void setIdAttribute(String name, boolean isId) throws DOMException
If the parameterisId
istrue
, this method declares the specified attribute to be a user-determined ID attribute . This affects the value ofAttr.isId
and the behavior ofDocument.getElementById
, but does not change any schema that may be in use, in particular this does not affect theAttr.schemaTypeInfo
of the specifiedAttr
node. Use the valuefalse
for the parameterisId
to undeclare an attribute for being a user-determined ID attribute.
To specify an attribute by local name and namespace URI, use thesetIdAttributeNS
method.
- Specified by:
- setIdAttribute in interface Element
- Parameters:
name
- The name of the attribute.isId
- Whether the attribute is a of type ID.
- Throws:
DOMException
- NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
NOT_FOUND_ERR: Raised if the specified node is not an attribute of this element.
- Since:
- DOM Level 3
public void setIdAttributeNS(String namespaceURI, String localName, boolean isId) throws DOMException
If the parameterisId
istrue
, this method declares the specified attribute to be a user-determined ID attribute . This affects the value ofAttr.isId
and the behavior ofDocument.getElementById
, but does not change any schema that may be in use, in particular this does not affect theAttr.schemaTypeInfo
of the specifiedAttr
node. Use the valuefalse
for the parameterisId
to undeclare an attribute for being a user-determined ID attribute.
- Specified by:
- setIdAttributeNS in interface Element
- Parameters:
namespaceURI
- The namespace URI of the attribute.localName
- The local name of the attribute.isId
- Whether the attribute is a of type ID.
- Throws:
DOMException
- NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
NOT_FOUND_ERR: Raised if the specified node is not an attribute of this element.
- Since:
- DOM Level 3
public void setIdAttributeNode(Attr idAttr, boolean isId) throws DOMException
If the parameterisId
istrue
, this method declares the specified attribute to be a user-determined ID attribute . This affects the value ofAttr.isId
and the behavior ofDocument.getElementById
, but does not change any schema that may be in use, in particular this does not affect theAttr.schemaTypeInfo
of the specifiedAttr
node. Use the valuefalse
for the parameterisId
to undeclare an attribute for being a user-determined ID attribute.
- Specified by:
- setIdAttributeNode in interface Element
- Parameters:
idAttr
- The attribute node.isId
- Whether the attribute is a of type ID.
- Throws:
DOMException
- NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
NOT_FOUND_ERR: Raised if the specified node is not an attribute of this element.
- Since:
- DOM Level 3
public void setNodeValue(String nodeValue) throws DOMException
The value of this node, depending on its type; see the table above. When it is defined to benull
, setting it has no effect, including if the node is read-only.
- Specified by:
- setNodeValue in interface Node
- Throws:
DOMException
- NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly and if it is not defined to benull
.
public void setPrefix(String prefix)
The namespace prefix of this node, ornull
if it is unspecified. When it is defined to benull
, setting it has no effect, including if the node is read-only.
Note that setting this attribute, when permitted, changes thenodeName
attribute, which holds the qualified name, as well as thetagName
andname
attributes of theElement
andAttr
interfaces, when applicable.
Setting the prefix tonull
makes it unspecified, setting it to an empty string is implementation dependent.
Note also that changing the prefix of an attribute that is known to have a default value, does not make a new attribute with the default value and the original prefix appear, since thenamespaceURI
andlocalName
do not change.
For nodes of any type other thanELEMENT_NODE
andATTRIBUTE_NODE
and nodes created with a DOM Level 1 method, such ascreateElement
from theDocument
interface, this is alwaysnull
.
- Throws:
DOMException
- INVALID_CHARACTER_ERR: Raised if the specified prefix contains an illegal character according to the XML version in use specified in theDocument.xmlVersion
attribute.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
NAMESPACE_ERR: Raised if the specifiedprefix
is malformed per the Namespaces in XML specification, if thenamespaceURI
of this node isnull
, if the specified prefix is "xml" and thenamespaceURI
of this node is different from " http://www.w3.org/XML/1998/namespace", if this node is an attribute and the specified prefix is "xmlns" and thenamespaceURI
of this node is different from "http://www.w3.org/2000/xmlns/", or if this node is an attribute and thequalifiedName
of this node is "xmlns" [XML Namespaces] .
- Since:
- DOM Level 2
public void setTextContent(String textContent) throws DOMException
This attribute returns the text content of this node and its descendants. When it is defined to benull
, setting it has no effect. On setting, any possible children this node may have are removed and, if it the new string is not empty ornull
, replaced by a singleText
node containing the string this attribute is set to.
On getting, no serialization is performed, the returned string does not contain any markup. No whitespace normalization is performed and the returned string does not contain the white spaces in element content (see the attributeText.isElementContentWhitespace
). Similarly, on setting, no parsing is performed either, the input string is taken as pure textual content.
The string returned is made of the text content of this node depending on its type, as defined below:
Node type Content ELEMENT_NODE, ATTRIBUTE_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, DOCUMENT_FRAGMENT_NODE concatenation of the textContent
attribute value of every child node, excluding COMMENT_NODE and PROCESSING_INSTRUCTION_NODE nodes. This is the empty string if the node has no children.TEXT_NODE, CDATA_SECTION_NODE, COMMENT_NODE, PROCESSING_INSTRUCTION_NODE nodeValue
DOCUMENT_NODE, DOCUMENT_TYPE_NODE, NOTATION_NODE null
- Specified by:
- setTextContent in interface Node
- Throws:
DOMException
- NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.
- Since:
- DOM Level 3
public Object setUserData(String key, Object data, UserDataHandler handler)
Associate an object to a key on this node. The object can later be retrieved from this node by callinggetUserData
with the same key.
- Specified by:
- setUserData in interface Node
- Parameters:
key
- The key to associate the object to.data
- The object to associate to the given key, ornull
to remove any existing association to that key.handler
- The handler to associate to that key, ornull
.
- Returns:
- Returns the
DOMUserData
previously associated to the given key on this node, ornull
if there was none.
- Since:
- DOM Level 3
GNU Classpath (0.97.2) |