|
Oracle Security Developer Tools XML Security Java API Reference 10g (10.1.4.0.1) B28178-01 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
oracle.security.xmlsec.util.XMLNode
Abstract superclass for XML node objects.
XMLNode
serves as a wrapper class for an instance of org.w3c.dom.Node
. Every public method of that interface is implemented here, and is forwarded to the enclosed Node
object. This allows instances of XMLNode
to be manipulated in the same manner as instances of Node
. The one exception is that a XMLNode
cannot be directly appended to a Node
using the Node.appendChild()
method; instead use the getNode()
method to obtain the XMLNode
's enclosed Node
, and pass the result to the Node.appendChild()
method.
In addition to the methods defined by the org.w3c.dom
interface, XMLNode
provides several methods for obtaining the string representation of a DOM subtree or its bytes.
getNode()
, toStringXML()
, toBytesXML()
Field Summary | |
protected org.w3c.dom.Node |
node The org.w3c.dom.Node enclosed by this XMLNode . |
protected java.lang.String |
systemId The system ID for this XMLNode 's document. |
Constructor Summary | |
protected |
XMLNode(org.w3c.dom.Node node) Creates a new XMLNode instance for the given org.w3c.dom.Node , and checks that the Node 's local name is valid for an object of this XMLNode 's type. |
protected |
XMLNode(org.w3c.dom.Node node, java.lang.String systemId) Creates a new XMLNode instance for the given org.w3c.dom.Node , and checks that the Node 's local name is valid for an object of this XMLNode 's type. |
Method Summary | |
org.w3c.dom.Node |
appendChild(org.w3c.dom.Node newChild) Adds the node newChild to the end of the list of children of this node. |
org.w3c.dom.Node |
appendChild(XMLNode newChild) Emulates org.w3c.dom.Node.appendChild for oracle.security.xmlsec.XMLNode argument. |
void |
appendTo(org.w3c.dom.Node node) Appends the document sub-tree rooted in this XMLNode to the given org.w3c.dom.Node . |
org.w3c.dom.Node |
cloneNode(boolean deep) Returns a duplicate of this node, i.e., serves as a generic copy constructor for nodes. |
org.w3c.dom.NamedNodeMap |
getAttributes() A NamedNodeMap containing the attributes of this node (if it is an Element ) or null otherwise. |
org.w3c.dom.NodeList |
getChildNodes() A NodeList that contains all children of this node. |
org.w3c.dom.Node |
getFirstChild() The first child of this node. |
org.w3c.dom.Node |
getLastChild() The last child of this node. |
java.lang.String |
getLocalName() Returns the local part of the qualified name of this node. |
java.lang.String |
getNamespaceURI() The namespace URI of this node, or null if it is unspecified. |
org.w3c.dom.Node |
getNextSibling() The node immediately following this node. |
org.w3c.dom.Node |
getNode() Returns the org.w3c.dom.Node contained in this XMLNode . |
java.lang.String |
getNodeName() The name of this node, depending on its type. |
short |
getNodeType() A code representing the type of the underlying object. |
java.lang.String |
getNodeValue() Returns the value of this node, depending on its type. |
org.w3c.dom.Document |
getOwnerDocument() The Document object associated with this node. |
org.w3c.dom.Node |
getParentNode() The parent of this node. |
java.lang.String |
getPrefix() Returns the namespace prefix of this node, or null if it is unspecified. |
org.w3c.dom.Node |
getPreviousSibling() The node immediately preceding this node. |
java.lang.String |
getSystemId() Returns the system ID for this XMLNode . |
boolean |
hasAttributes() Returns whether this node (if it is an element) has any attributes. |
boolean |
hasChildNodes() Returns whether this node has any children. |
org.w3c.dom.Node |
insertBefore(org.w3c.dom.Node newChild, org.w3c.dom.Node refChild) Inserts the node newChild before the existing child node refChild . |
org.w3c.dom.Node |
insertBefore(XMLNode newChild, org.w3c.dom.Node refChild) Emulates org.w3c.dom.Node.insertBefore for oracle.security.xmlsec.XMLNode arguments. |
boolean |
isSupported(java.lang.String feature, java.lang.String version) Tests whether the DOM implementation implements a specific feature and that feature is supported by this node. |
void |
normalize() Puts all Text nodes in the full depth of the sub-tree underneath this Node , including attribute nodes, into a "normal" form where only structure (e.g., elements, comments, processing instructions, CDATA sections, and entity references) separates Text nodes (i.e., there are neither adjacent Text nodes nor empty Text nodes). |
org.w3c.dom.Node |
removeChild(org.w3c.dom.Node oldChild) Removes the child node indicated by oldChild from the list of children, and returns it. |
org.w3c.dom.Node |
removeChild(XMLNode oldChild) Emulates org.w3c.dom.Node.removeChild for oracle.security.xmlsec.XMLNode argument. |
org.w3c.dom.Node |
replaceChild(org.w3c.dom.Node newChild, org.w3c.dom.Node oldChild) Replaces the child node oldChild with newChild in the list of children, and returns the oldChild node. |
org.w3c.dom.Node |
replaceChild(XMLNode newChild, org.w3c.dom.Node oldChild) Emulates org.w3c.dom.Node.replaceChild for oracle.security.xmlsec.XMLNode arguments. |
void |
setNodeValue(java.lang.String nodeValue) Sets the value of this node, depending on its type. |
void |
setPrefix(java.lang.String prefix) Sets the namespace prefix of this node. |
void |
setSystemId(java.lang.String systemId) Sets the system ID for this XMLNode , which should be the URI of the parent document. |
byte[] |
toBytesXML() Returns a byte array containing the XML for this XMLNode . |
java.lang.String |
toStringXML() Returns a string containing the XML for this XMLNode . |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
protected org.w3c.dom.Node node
org.w3c.dom.Node
enclosed by this XMLNode
. This field must be set in the constructor by all subclasses.protected java.lang.String systemId
XMLNode
's document. If specified, this system ID will be used as the base for resolving relative URIs.
Constructor Detail |
protected XMLNode(org.w3c.dom.Node node) throws org.w3c.dom.DOMException
XMLNode
instance for the given org.w3c.dom.Node
, and checks that the Node
's local name is valid for an object of this XMLNode
's type.
This constructor should be invoked by the constructors of all subclasses to set the node
field.
node
- The org.w3c.dom.Node
to be contained by this XMLNode
instance.org.w3c.dom.DOMException
- If the local name of node
is invalid for an instance of this XMLNode
's type.protected XMLNode(org.w3c.dom.Node node, java.lang.String systemId) throws org.w3c.dom.DOMException
XMLNode
instance for the given org.w3c.dom.Node
, and checks that the Node
's local name is valid for an object of this XMLNode
's type.
This constructor should be invoked by the constructors of all subclasses to set the node
field.
node
- The org.w3c.dom.Node
to be contained by this XMLNode
instance.systemId
- The URI string system ID for the XMLNode
.org.w3c.dom.DOMException
- If the local name of node
is invalid for an instance of this XMLNode
's type.setSystemId(java.lang.String)
Method Detail |
public org.w3c.dom.Node getNode()
org.w3c.dom.Node
contained in this XMLNode
.public void setSystemId(java.lang.String systemId)
XMLNode
, which should be the URI of the parent document.systemId
- The URI string system ID for this XMLNode
.public java.lang.String getSystemId()
XMLNode
.XMLNode
, or null
if none is set.setSystemId(java.lang.String)
public void appendTo(org.w3c.dom.Node node) throws org.w3c.dom.DOMException
XMLNode
to the given org.w3c.dom.Node
.org.w3c.dom.DOMException
public java.lang.String toStringXML() throws javax.xml.transform.TransformerException
XMLNode
.TransformException
- If the DOM subtree rooted in this XMLNode
cannot be serialized to a character stream.javax.xml.transform.TransformerException
XMLUtils.toStringXML(XMLNode, boolean, boolean)
public byte[] toBytesXML() throws javax.xml.transform.TransformerException
XMLNode
.TransformException
- If the DOM subtree rooted in this XMLNode
cannot be serialized to a byte stream.javax.xml.transform.TransformerException
XMLUtils.toBytesXML(XMLNode, boolean, boolean)
public org.w3c.dom.Node insertBefore(XMLNode newChild, org.w3c.dom.Node refChild) throws org.w3c.dom.DOMException
org.w3c.dom.Node.insertBefore
for oracle.security.xmlsec.XMLNode
arguments.org.w3c.dom.DOMException
insertBefore(Node, Node)
public org.w3c.dom.Node replaceChild(XMLNode newChild, org.w3c.dom.Node oldChild) throws org.w3c.dom.DOMException
org.w3c.dom.Node.replaceChild
for oracle.security.xmlsec.XMLNode
arguments.org.w3c.dom.DOMException
replaceChild(Node, Node)
public org.w3c.dom.Node removeChild(XMLNode oldChild) throws org.w3c.dom.DOMException
org.w3c.dom.Node.removeChild
for oracle.security.xmlsec.XMLNode
argument.org.w3c.dom.DOMException
removeChild(Node)
public org.w3c.dom.Node appendChild(XMLNode newChild) throws org.w3c.dom.DOMException
org.w3c.dom.Node.appendChild
for oracle.security.xmlsec.XMLNode
argument.org.w3c.dom.DOMException
appendChild(Node)
public java.lang.String getNodeName()
public java.lang.String getNodeValue() throws org.w3c.dom.DOMException
org.w3c.dom.DOMException
- DOMSTRING_SIZE_ERR: Raised when it would return more characters than fit in a DOMString
variable on the implementation platform.public void setNodeValue(java.lang.String nodeValue) throws org.w3c.dom.DOMException
null
, setting it has no effect.org.w3c.dom.DOMException
- NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.public short getNodeType()
public org.w3c.dom.Node getParentNode()
Attr
, Document
, DocumentFragment
, Entity
, and Notation
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 is null
.public org.w3c.dom.NodeList getChildNodes()
NodeList
that contains all children of this node. If there are no children, this is a NodeList
containing no nodes.public org.w3c.dom.Node getFirstChild()
null
.public org.w3c.dom.Node getLastChild()
null
.public org.w3c.dom.Node getPreviousSibling()
null
.public org.w3c.dom.Node getNextSibling()
null
.public org.w3c.dom.NamedNodeMap getAttributes()
NamedNodeMap
containing the attributes of this node (if it is an Element
) or null
otherwise.public org.w3c.dom.Document getOwnerDocument()
Document
object associated with this node. This is also the Document
object used to create new nodes. When this node is a Document
or a DocumentType
which is not used with any Document
yet, this is null
.public org.w3c.dom.Node insertBefore(org.w3c.dom.Node newChild, org.w3c.dom.Node refChild) throws org.w3c.dom.DOMException
newChild
before the existing child node refChild
. If refChild
is null
, insert newChild
at the end of the list of children.
If newChild
is a DocumentFragment
object, all of its children are inserted, in the same order, before refChild
. If the newChild
is already in the tree, it is first removed.
newChild
- The node to insert.refChild
- The reference node (i.e., the node before which the new node must be inserted).org.w3c.dom.DOMException
- HIERARCHY_REQUEST_ERR: Raised if this node is of a type that does not allow children of the type of the newChild
node, or if the node to insert is one of this node's ancestors.newChild
was created from a different document than the one that created this node.refChild
is not a child of this node.public org.w3c.dom.Node replaceChild(org.w3c.dom.Node newChild, org.w3c.dom.Node oldChild) throws org.w3c.dom.DOMException
oldChild
with newChild
in the list of children, and returns the oldChild
node.
If newChild
is a DocumentFragment
object, oldChild
is replaced by all of the DocumentFragment
children, which are inserted in the same order. If the newChild
is already in the tree, it is first removed.
newChild
- The new node to put in the child list.oldChild
- The node being replaced in the list.org.w3c.dom.DOMException
- HIERARCHY_REQUEST_ERR: Raised if this node is of a type that does not allow children of the type of the newChild
node, or if the node to put in is one of this node's ancestors.newChild
was created from a different document than the one that created this node.oldChild
is not a child of this node.public org.w3c.dom.Node removeChild(org.w3c.dom.Node oldChild) throws org.w3c.dom.DOMException
oldChild
from the list of children, and returns it.oldChild
- The node being removed.org.w3c.dom.DOMException
- NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.oldChild
is not a child of this node.public org.w3c.dom.Node appendChild(org.w3c.dom.Node newChild) throws org.w3c.dom.DOMException
newChild
to the end of the list of children of this node. If the newChild
is already in the tree, it is first removed.newChild
- The node to add.If it is a DocumentFragment
object, the entire contents of the document fragment are moved into the child list of this nodeorg.w3c.dom.DOMException
- HIERARCHY_REQUEST_ERR: Raised if this node is of a type that does not allow children of the type of the newChild
node, or if the node to append is one of this node's ancestors.newChild
was created from a different document than the one that created this node.public boolean hasChildNodes()
true
if this node has any children, false
otherwise.public org.w3c.dom.Node cloneNode(boolean deep)
parentNode
is null
).
Cloning an Element
copies all attributes and their values, including those generated by the XML processor to represent defaulted attributes, but this method does not copy any text it contains unless it is a deep clone, since the text is contained in a child Text
node. Cloning an Attribute
directly, as opposed to its being cloned as part of an Element
cloning operation, returns a specified attribute (i.e., specified
is true
). 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 an EntityReference
clone are readonly. In addition, clones of unspecified Attr
nodes are specified. And, cloning Document
, DocumentType
, Entity
, and Notation
nodes is implementation dependent.
deep
- If true
, recursively clone the subtree under the specified node; if false
, clone only the node itself (and its attributes, if it is an Element
).public void normalize()
Text
nodes in the full depth of the sub-tree underneath this Node
, including attribute nodes, into a "normal" form where only structure (e.g., elements, comments, processing instructions, CDATA sections, and entity references) separates Text
nodes (i.e., there are neither adjacent Text
nodes nor empty Text
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 lookups) that depend on a particular document tree structure are to be used. In cases where the document contains CDATASection
s, the normalize operation alone may not be sufficient, since XPointers do not differentiate between Text
nodes and CDATASection
nodes.public boolean isSupported(java.lang.String feature, java.lang.String version)
feature
- The name of the feature to test. This is the same name which can be passed to the method hasFeature
on DOMImplementation
.version
- This is the version number of the feature to test. In Level 2, version 1, this is the string "2.0". If the version is not specified, supporting any version of the feature will cause the method to return true
.true
if the specified feature is supported on this node, false
otherwise.public java.lang.String getNamespaceURI()
null
if it is unspecified.
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 than ELEMENT_NODE
and ATTRIBUTE_NODE
and nodes created with a DOM Level 1 method, such as createElement
from the Document
interface, this is always null
.Per the Namespaces in XML specification, 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.
public java.lang.String getPrefix()
null
if it is unspecified.public void setPrefix(java.lang.String prefix) throws org.w3c.dom.DOMException
Note that setting this attribute, when permitted, changes the nodeName
attribute, which holds the qualified name, as well as the tagName
and name
attributes of the Element
and Attr
interfaces, when applicable.
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 the namespaceURI
and localName
do not change.
For nodes of any type other than ELEMENT_NODE
and ATTRIBUTE_NODE
and nodes created with a DOM Level 1 method, such as createElement
from the Document
interface, this is always null
.
org.w3c.dom.DOMException
- INVALID_CHARACTER_ERR: Raised if the specified prefix contains an illegal character.prefix
is malformed, if the namespaceURI
of this node is null
, if the specified prefix is "xml" and the namespaceURI
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 the namespaceURI
of this node is different from "http://www.w3.org/2000/xmlns/", or if this node is an attribute and the qualifiedName
of this node is "xmlns" .public java.lang.String getLocalName()
For nodes of any type other than ELEMENT_NODE
and ATTRIBUTE_NODE
and nodes created with a DOM Level 1 method, such as createElement
from the Document
interface, this is always null
.
public boolean hasAttributes()
true
if this node has any attributes, false
otherwise.
|
Oracle Security Developer Tools XML Security Java API Reference 10g (10.1.4.0.1) B28178-01 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |