|
Java EE 5 SDK | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES All Classes | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
An object representing an element of a SOAP message that is allowed but not specifically prescribed by a SOAP specification. This interface serves as the base interface for those objects that are specifically prescribed by a SOAP specification.
Methods in this interface that are required to return SAAJ specific objects
may "silently" replace nodes in the tree as required to successfully return
objects of the correct type. See
getChildElements() and
javax.xml.soap
for details.
| Field Summary |
|---|
| Method Summary | |
|---|---|
SOAPElement |
addAttribute(Name name,
String value)
Adds an attribute with the specified name and value to this SOAPElement object. |
SOAPElement |
addAttribute(QName qname,
String value)
Adds an attribute with the specified name and value to this SOAPElement object. |
SOAPElement |
addChildElement(Name name)
Creates a new SOAPElement object initialized with the
given Name object and adds the new element to this
SOAPElement object. |
SOAPElement |
addChildElement(QName qname)
Creates a new SOAPElement object initialized with the given
QName object and adds the new element to this SOAPElement
object. |
SOAPElement |
addChildElement(SOAPElement element)
Add a SOAPElement as a child of this
SOAPElement instance. |
SOAPElement |
addChildElement(String localName)
Creates a new SOAPElement object initialized with the
specified local name and adds the new element to this
SOAPElement object. |
SOAPElement |
addChildElement(String localName,
String prefix)
Creates a new SOAPElement object initialized with the
specified local name and prefix and adds the new element to this
SOAPElement object. |
SOAPElement |
addChildElement(String localName,
String prefix,
String uri)
Creates a new SOAPElement object initialized with the
specified local name, prefix, and URI and adds the new element to this
SOAPElement object. |
SOAPElement |
addNamespaceDeclaration(String prefix,
String uri)
Adds a namespace declaration with the specified prefix and URI to this SOAPElement object. |
SOAPElement |
addTextNode(String text)
Creates a new Text object initialized with the given
String and adds it to this SOAPElement object. |
QName |
createQName(String localName,
String prefix)
Creates a QName whose namespace URI is the one associated
with the parameter, prefix, in the context of this
SOAPElement. |
Iterator |
getAllAttributes()
Returns an Iterator over all of the attribute
Name objects in this
SOAPElement object. |
Iterator |
getAllAttributesAsQNames()
Returns an Iterator over all of the attributes
in this SOAPElement as QName objects. |
String |
getAttributeValue(Name name)
Returns the value of the attribute with the specified name. |
String |
getAttributeValue(QName qname)
Returns the value of the attribute with the specified qname. |
Iterator |
getChildElements()
Returns an Iterator over all the immediate child
Nodes of this element. |
Iterator |
getChildElements(Name name)
Returns an Iterator over all the immediate child
Nodes of this element with the specified name. |
Iterator |
getChildElements(QName qname)
Returns an Iterator over all the immediate child
Nodes of this element with the specified qname. |
Name |
getElementName()
Returns the name of this SOAPElement object. |
QName |
getElementQName()
Returns the qname of this SOAPElement object. |
String |
getEncodingStyle()
Returns the encoding style for this SOAPElement object. |
Iterator |
getNamespacePrefixes()
Returns an Iterator over the namespace prefix
Strings declared by this element. |
String |
getNamespaceURI(String prefix)
Returns the URI of the namespace that has the given prefix. |
Iterator |
getVisibleNamespacePrefixes()
Returns an Iterator over the namespace prefix
Strings visible to this element. |
boolean |
removeAttribute(Name name)
Removes the attribute with the specified name. |
boolean |
removeAttribute(QName qname)
Removes the attribute with the specified qname. |
void |
removeContents()
Detaches all children of this SOAPElement. |
boolean |
removeNamespaceDeclaration(String prefix)
Removes the namespace declaration corresponding to the given prefix. |
SOAPElement |
setElementQName(QName newName)
Changes the name of this Element to newName if
possible. |
void |
setEncodingStyle(String encodingStyle)
Sets the encoding style for this SOAPElement object
to one specified. |
| Methods inherited from interface javax.xml.soap.Node |
|---|
detachNode, getParentElement, getValue, recycleNode, setParentElement, setValue |
| Methods inherited from interface org.w3c.dom.Node |
|---|
appendChild, cloneNode, compareDocumentPosition, getAttributes, getBaseURI, getChildNodes, getFeature, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNodeName, getNodeType, getNodeValue, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, getTextContent, getUserData, hasAttributes, hasChildNodes, insertBefore, isDefaultNamespace, isEqualNode, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, normalize, removeChild, replaceChild, setNodeValue, setPrefix, setTextContent, setUserData |
| Methods inherited from interface org.w3c.dom.Element |
|---|
getAttribute, getAttributeNode, getAttributeNodeNS, getAttributeNS, getElementsByTagName, getElementsByTagNameNS, getSchemaTypeInfo, getTagName, hasAttribute, hasAttributeNS, removeAttribute, removeAttributeNode, removeAttributeNS, setAttribute, setAttributeNode, setAttributeNodeNS, setAttributeNS, setIdAttribute, setIdAttributeNode, setIdAttributeNS |
| Methods inherited from interface org.w3c.dom.Node |
|---|
appendChild, cloneNode, compareDocumentPosition, getAttributes, getBaseURI, getChildNodes, getFeature, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNodeName, getNodeType, getNodeValue, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, getTextContent, getUserData, hasAttributes, hasChildNodes, insertBefore, isDefaultNamespace, isEqualNode, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, normalize, removeChild, replaceChild, setNodeValue, setPrefix, setTextContent, setUserData |
| Method Detail |
|---|
SOAPElement addChildElement(Name name) throws SOAPException
SOAPElement object initialized with the
given Name object and adds the new element to this
SOAPElement object.
This method may be deprecated in a future release of SAAJ in favor of addChildElement(javax.xml.namespace.QName)
name - a Name object with the XML name for the
new element
SOAPElement object that was created
SOAPException - if there is an error in creating the
SOAPElement objectaddChildElement(javax.xml.namespace.QName)SOAPElement addChildElement(QName qname) throws SOAPException
SOAPElement object initialized with the given
QName object and adds the new element to this SOAPElement
object. The namespace, localname and prefix of the new
SOAPElement are all taken from the qname argument.
qname - a QName object with the XML name for the
new element
SOAPElement object that was created
SOAPException - if there is an error in creating the
SOAPElement objectaddChildElement(Name)SOAPElement addChildElement(String localName) throws SOAPException
SOAPElement object initialized with the
specified local name and adds the new element to this
SOAPElement object.
The new SOAPElement inherits any in-scope default namespace.
localName - a String giving the local name for
the element
SOAPElement object that was created
SOAPException - if there is an error in creating the
SOAPElement objectSOAPElement addChildElement(String localName, String prefix) throws SOAPException
SOAPElement object initialized with the
specified local name and prefix and adds the new element to this
SOAPElement object.
localName - a String giving the local name for
the new elementprefix - a String giving the namespace prefix for
the new element
SOAPElement object that was created
SOAPException - if the prefix is not valid in the
context of this SOAPElement or if there is an error in creating the
SOAPElement objectSOAPElement addChildElement(String localName, String prefix, String uri) throws SOAPException
SOAPElement object initialized with the
specified local name, prefix, and URI and adds the new element to this
SOAPElement object.
localName - a String giving the local name for
the new elementprefix - a String giving the namespace prefix for
the new elementuri - a String giving the URI of the namespace
to which the new element belongs
SOAPElement object that was created
SOAPException - if there is an error in creating the
SOAPElement objectSOAPElement addChildElement(SOAPElement element) throws SOAPException
SOAPElement as a child of this
SOAPElement instance. The SOAPElement
is expected to be created by a
SOAPFactory. Callers should not rely on the
element instance being added as is into the XML
tree. Implementations could end up copying the content
of the SOAPElement passed into an instance of
a different SOAPElement implementation. For
instance if addChildElement() is called on a
SOAPHeader, element will be copied
into an instance of a SOAPHeaderElement.
The fragment rooted in element is either added
as a whole or not at all, if there was an error.
The fragment rooted in element cannot contain
elements named "Envelope", "Header" or "Body" and in the SOAP
namespace. Any namespace prefixes present in the fragment
should be fully resolved using appropriate namespace
declarations within the fragment itself.
element - the SOAPElement to be added as a
new child
SOAPException - if there was an error in adding this
element as a childvoid removeContents()
SOAPElement.
This method is useful for rolling back the construction of partially
completed SOAPHeaders and SOAPBodys in
preparation for sending a fault when an error condition is detected. It
is also useful for recycling portions of a document within a SOAP
message.
SOAPElement addTextNode(String text) throws SOAPException
Text object initialized with the given
String and adds it to this SOAPElement object.
text - a String object with the textual content to be added
SOAPElement object into which
the new Text object was inserted
SOAPException - if there is an error in creating the
new Text object or if it is not legal to
attach it as a child to this
SOAPElementSOAPElement addAttribute(Name name, String value) throws SOAPException
SOAPElement object.
name - a Name object with the name of the attributevalue - a String giving the value of the attribute
SOAPElement object into which the attribute was
inserted
SOAPException - if there is an error in creating the
Attribute, or it is invalid to set
an attribute with Name
name on this SOAPElement.addAttribute(javax.xml.namespace.QName, String)SOAPElement addAttribute(QName qname, String value) throws SOAPException
SOAPElement object.
qname - a QName object with the name of the attributevalue - a String giving the value of the attribute
SOAPElement object into which the attribute was
inserted
SOAPException - if there is an error in creating the
Attribute, or it is invalid to set
an attribute with QName
qname on this SOAPElement.addAttribute(Name, String)SOAPElement addNamespaceDeclaration(String prefix, String uri) throws SOAPException
SOAPElement object.
prefix - a String giving the prefix of the namespaceuri - a String giving the uri of the namespace
SOAPElement object into which this
namespace declaration was inserted.
SOAPException - if there is an error in creating the
namespaceString getAttributeValue(Name name)
name - a Name object with the name of the attribute
String giving the value of the specified
attribute, Null if there is no such attributegetAttributeValue(javax.xml.namespace.QName)String getAttributeValue(QName qname)
qname - a QName object with the qname of the attribute
String giving the value of the specified
attribute, Null if there is no such attributegetAttributeValue(Name)Iterator getAllAttributes()
Iterator over all of the attribute
Name objects in this
SOAPElement object. The iterator can be used to get
the attribute names, which can then be passed to the method
getAttributeValue to retrieve the value of each
attribute.
getAllAttributesAsQNames()Iterator getAllAttributesAsQNames()
Iterator over all of the attributes
in this SOAPElement as QName objects.
The iterator can be used to get the attribute QName, which can then
be passed to the method getAttributeValue to retrieve
the value of each attribute.
getAllAttributes()String getNamespaceURI(String prefix)
prefix - a String giving the prefix of the namespace
for which to search
String with the uri of the namespace that has
the given prefixIterator getNamespacePrefixes()
Iterator over the namespace prefix
Strings declared by this element. The prefixes returned by
this iterator can be passed to the method
getNamespaceURI to retrieve the URI of each namespace.
SOAPElement objectIterator getVisibleNamespacePrefixes()
Iterator over the namespace prefix
Strings visible to this element. The prefixes returned by
this iterator can be passed to the method
getNamespaceURI to retrieve the URI of each namespace.
SOAPElement objectQName createQName(String localName, String prefix) throws SOAPException
QName whose namespace URI is the one associated
with the parameter, prefix, in the context of this
SOAPElement. The remaining elements of the new
QName are taken directly from the parameters,
localName and prefix.
localName - a String containing the local part of the name.prefix - a String containing the prefix for the name.
QName with the specified localName
and prefix, and with a namespace that is associated
with the prefix in the context of this
SOAPElement. This namespace will be the same as
the one that would be returned by
getNamespaceURI(String)prefix as it's parameter.
SOAPException - if the QName cannot be created.Name getElementName()
SOAPElement object.
Name object with the name of this
SOAPElement objectQName getElementQName()
SOAPElement object.
QName object with the qname of this
SOAPElement objectgetElementName()SOAPElement setElementQName(QName newName) throws SOAPException
Element to newName if
possible. SOAP Defined elements such as SOAPEnvelope, SOAPHeader, SOAPBody
etc. cannot have their names changed using this method. Any attempt to do
so will result in a SOAPException being thrown.
Callers should not rely on the element instance being renamed as is.
Implementations could end up copying the content of the
SOAPElement to a renamed instance.
newName - the new name for the Element.
SOAPException - if changing the name of this Element
is not allowed.boolean removeAttribute(Name name)
name - the Name object with the name of the
attribute to be removed
true if the attribute was
removed successfully; false if it was notremoveAttribute(javax.xml.namespace.QName)boolean removeAttribute(QName qname)
qname - the QName object with the qname of the
attribute to be removed
true if the attribute was
removed successfully; false if it was notremoveAttribute(Name)boolean removeNamespaceDeclaration(String prefix)
prefix - a String giving the prefix for which
to search
true if the namespace declaration was
removed successfully; false if it was notIterator getChildElements()
Iterator over all the immediate child
Nodes of this element. This includes javax.xml.soap.Text
objects as well as SOAPElement objects.
Calling this method may cause child
Element,
SOAPElement and org.w3c.dom.Text nodes to be
replaced by SOAPElement, SOAPHeaderElement,
SOAPBodyElement or javax.xml.soap.Text nodes as
appropriate for the type of this parent node. As a result the calling
application must treat any existing references to these child nodes that
have been obtained through DOM APIs as invalid and either discard them or
refresh them with the values returned by this Iterator. This
behavior can be avoided by calling the equivalent DOM APIs. See
javax.xml.soap
for more details.
SOAPElement
object
Iterator getChildElements(Name name)
Iterator over all the immediate child
Nodes of this element with the specified name. All of these
children will be SOAPElement nodes.
Calling this method may cause child
Element,
SOAPElement and org.w3c.dom.Text nodes to be
replaced by SOAPElement, SOAPHeaderElement,
SOAPBodyElement or javax.xml.soap.Text nodes as
appropriate for the type of this parent node. As a result the calling
application must treat any existing references to these child nodes that
have been obtained through DOM APIs as invalid and either discard them or
refresh them with the values returned by this Iterator. This
behavior can be avoided by calling the equivalent DOM APIs. See
javax.xml.soap
for more details.
name - a Name object with the name of the child
elements to be returned
Iterator object over all the elements
in this SOAPElement object with the
specified namegetChildElements(javax.xml.namespace.QName)
Iterator getChildElements(QName qname)
Iterator over all the immediate child
Nodes of this element with the specified qname. All of these
children will be SOAPElement nodes.
Calling this method may cause child
Element,
SOAPElement and org.w3c.dom.Text nodes to be
replaced by SOAPElement, SOAPHeaderElement,
SOAPBodyElement or javax.xml.soap.Text nodes as
appropriate for the type of this parent node. As a result the calling
application must treat any existing references to these child nodes that
have been obtained through DOM APIs as invalid and either discard them or
refresh them with the values returned by this Iterator. This
behavior can be avoided by calling the equivalent DOM APIs. See
javax.xml.soap
for more details.
qname - a QName object with the qname of the child
elements to be returned
Iterator object over all the elements
in this SOAPElement object with the
specified qnamegetChildElements(Name)
void setEncodingStyle(String encodingStyle) throws SOAPException
SOAPElement object
to one specified.
encodingStyle - a String giving the encoding style
IllegalArgumentException - if there was a problem in the
encoding style being set.
SOAPException - if setting the encodingStyle is invalid for this SOAPElement.getEncodingStyle()String getEncodingStyle()
SOAPElement object.
String giving the encoding stylesetEncodingStyle(java.lang.String)
|
Java EE 5 SDK | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES All Classes | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
Copyright 2007 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms.
Scripting on this page tracks web page traffic, but does not change the content in any way.