|
| |
|
| javax.xml.soap.SOAPElement
All known Subclasses: com.sun.xml.messaging.saaj.soap.impl.ElementImpl,
| SOAPElement | | public interface SOAPElement extends Node,org.w3c.dom.Element(Code) | | 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
SOAPElement.getChildElements() and
javax.xml.soap for details.
|
| Method Summary | |
| public SOAPElement | addAttribute(Name name, String value)
Adds an attribute with the specified name and value to this
SOAPElement object. | | public SOAPElement | addAttribute(QName qname, String value)
Adds an attribute with the specified name and value to this
SOAPElement object. | | public SOAPElement | addChildElement(Name name)
Creates a new SOAPElement object initialized with the
given Name object and adds the new element to this
SOAPElement object. | | public SOAPElement | addChildElement(QName qname)
Creates a new SOAPElement object initialized with the given
QName object and adds the new element to this SOAPElement
object. | | public SOAPElement | addChildElement(String localName)
Creates a new SOAPElement object initialized with the
specified local name and adds the new element to this
SOAPElement object. | | public 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. | | public 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. | | public SOAPElement | addChildElement(SOAPElement element)
Add a SOAPElement as a child of this
SOAPElement instance. | | public SOAPElement | addNamespaceDeclaration(String prefix, String uri)
Adds a namespace declaration with the specified prefix and URI to this
SOAPElement object. | | public SOAPElement | addTextNode(String text)
Creates a new Text object initialized with the given
String and adds it to this SOAPElement object. | | public 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. | | public Iterator | getAllAttributes()
Returns an Iterator over all of the attribute
Name objects in this
SOAPElement object. | | public Iterator | getAllAttributesAsQNames()
Returns an Iterator over all of the attributes
in this SOAPElement as QName objects. | | public String | getAttributeValue(Name name)
Returns the value of the attribute with the specified name. | | public String | getAttributeValue(QName qname)
Returns the value of the attribute with the specified qname. | | public Iterator | getChildElements()
Returns an Iterator over all the immediate child
Node s of this element. | | public Iterator | getChildElements(Name name)
Returns an Iterator over all the immediate child
Node s of this element with the specified name. | | public Iterator | getChildElements(QName qname)
Returns an Iterator over all the immediate child
Node s of this element with the specified qname. | | public Name | getElementName()
Returns the name of this SOAPElement object. | | public QName | getElementQName()
Returns the qname of this SOAPElement object. | | public String | getEncodingStyle()
Returns the encoding style for this SOAPElement object. | | public Iterator | getNamespacePrefixes()
Returns an Iterator over the namespace prefix
Strings declared by this element. | | public String | getNamespaceURI(String prefix)
Returns the URI of the namespace that has the given prefix. | | public Iterator | getVisibleNamespacePrefixes()
Returns an Iterator over the namespace prefix
Strings visible to this element. | | public boolean | removeAttribute(Name name)
Removes the attribute with the specified name. | | public boolean | removeAttribute(QName qname)
Removes the attribute with the specified qname. | | abstract public void | removeContents()
Detaches all children of this 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. | | public boolean | removeNamespaceDeclaration(String prefix)
Removes the namespace declaration corresponding to the given prefix. | | public SOAPElement | setElementQName(QName newName)
Changes the name of this Element to newName if
possible. | | public void | setEncodingStyle(String encodingStyle)
Sets the encoding style for this SOAPElement object
to one specified. |
| addAttribute | | public SOAPElement addAttribute(Name name, String value) throws SOAPException(Code) | | Adds an attribute with the specified name and value to this
SOAPElement object.
Parameters:
name - a Name object with the name of the attribute
Parameters:
value - a String giving the value of the attribute the SOAPElement object into which the attribute wasinserted
exception:
SOAPException - if there is an error in creating theAttribute, or it is invalid to set an attribute with Name name on this SOAPElement.
See Also: SOAPElement.addAttribute(javax.xml.namespace.QNameString) |
| addAttribute | | public SOAPElement addAttribute(QName qname, String value) throws SOAPException(Code) | | Adds an attribute with the specified name and value to this
SOAPElement object.
Parameters:
qname - a QName object with the name of the attribute
Parameters:
value - a String giving the value of the attribute the SOAPElement object into which the attribute wasinserted
exception:
SOAPException - if there is an error in creating theAttribute, or it is invalid to setan attribute with QName qname on this SOAPElement.
See Also: SOAPElement.addAttribute(NameString)
since:
SAAJ 1.3 |
| addChildElement | | public SOAPElement addChildElement(Name name) throws SOAPException(Code) | | Creates a new 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)
Parameters:
name - a Name object with the XML name for thenew element the new SOAPElement object that was created
exception:
SOAPException - if there is an error in creating theSOAPElement object
See Also: SOAPElement.addChildElement(javax.xml.namespace.QName) |
| addChildElement | | public SOAPElement addChildElement(QName qname) throws SOAPException(Code) | | Creates a new 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.
Parameters:
qname - a QName object with the XML name for thenew element the new SOAPElement object that was created
exception:
SOAPException - if there is an error in creating theSOAPElement object
See Also: SOAPElement.addChildElement(Name)
since:
SAAJ 1.3 |
| addChildElement | | public SOAPElement addChildElement(String localName) throws SOAPException(Code) | | Creates a new 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.
Parameters:
localName - a String giving the local name forthe element the new SOAPElement object that was created
exception:
SOAPException - if there is an error in creating theSOAPElement object |
| addChildElement | | public SOAPElement addChildElement(String localName, String prefix) throws SOAPException(Code) | | Creates a new SOAPElement object initialized with the
specified local name and prefix and adds the new element to this
SOAPElement object.
Parameters:
localName - a String giving the local name forthe new element
Parameters:
prefix - a String giving the namespace prefix forthe new element the new SOAPElement object that was created
exception:
SOAPException - if the prefix is not valid in thecontext of this SOAPElement or if there is an error in creating theSOAPElement object |
| addChildElement | | public SOAPElement addChildElement(String localName, String prefix, String uri) throws SOAPException(Code) | | Creates a new SOAPElement object initialized with the
specified local name, prefix, and URI and adds the new element to this
SOAPElement object.
Parameters:
localName - a String giving the local name forthe new element
Parameters:
prefix - a String giving the namespace prefix forthe new element
Parameters:
uri - a String giving the URI of the namespaceto which the new element belongs the new SOAPElement object that was created
exception:
SOAPException - if there is an error in creating theSOAPElement object |
| addChildElement | | public SOAPElement addChildElement(SOAPElement element) throws SOAPException(Code) | | Add a 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.
Parameters:
element - the SOAPElement to be added as anew child
exception:
SOAPException - if there was an error in adding thiselement as a child an instance representing the new SOAP element that wasactually added to the tree. |
| addNamespaceDeclaration | | public SOAPElement addNamespaceDeclaration(String prefix, String uri) throws SOAPException(Code) | | Adds a namespace declaration with the specified prefix and URI to this
SOAPElement object.
Parameters:
prefix - a String giving the prefix of the namespace
Parameters:
uri - a String giving the uri of the namespace the SOAPElement object into which thisnamespace declaration was inserted.
exception:
SOAPException - if there is an error in creating thenamespace |
| addTextNode | | public SOAPElement addTextNode(String text) throws SOAPException(Code) | | Creates a new Text object initialized with the given
String and adds it to this SOAPElement object.
Parameters:
text - a String object with the textual content to be added the SOAPElement object into whichthe new Text object was inserted
exception:
SOAPException - if there is an error in creating thenew Text object or if it is not legal toattach it as a child to this SOAPElement |
| createQName | | public QName createQName(String localName, String prefix) throws SOAPException(Code) | | Creates a 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.
Parameters:
localName - a String containing the local part of the name.
Parameters:
prefix - a String containing the prefix for the name. a QName with the specified localNameand prefix, and with a namespace that is associatedwith the prefix in the context of this SOAPElement. This namespace will be the same asthe one that would be returned by SOAPElement.getNamespaceURI(String) if it were given prefix as it's parameter.
exception:
SOAPException - if the QName cannot be created.
since:
SAAJ 1.3 |
| getAllAttributes | | public Iterator getAllAttributes()(Code) | | Returns an 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.
See Also: SOAPElement.getAllAttributesAsQNames an iterator over the names of the attributes |
| getAllAttributesAsQNames | | public Iterator getAllAttributesAsQNames()(Code) | | Returns an 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.
an iterator over the QNames of the attributes
See Also: SOAPElement.getAllAttributes
since:
SAAJ 1.3 |
| getAttributeValue | | public String getAttributeValue(QName qname)(Code) | | Returns the value of the attribute with the specified qname.
Parameters:
qname - a QName object with the qname of the attribute a String giving the value of the specifiedattribute, Null if there is no such attribute
See Also: SOAPElement.getAttributeValue(Name)
since:
SAAJ 1.3 |
| getChildElements | | public Iterator getChildElements()(Code) | | Returns an Iterator over all the immediate child
Node s 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.
an iterator with the content of this SOAPElementobject |
| getElementName | | public Name getElementName()(Code) | | Returns the name of this SOAPElement object.
a Name object with the name of thisSOAPElement object |
| getElementQName | | public QName getElementQName()(Code) | | Returns the qname of this SOAPElement object.
a QName object with the qname of thisSOAPElement object
See Also: SOAPElement.getElementName
since:
SAAJ 1.3 |
| getNamespacePrefixes | | public Iterator getNamespacePrefixes()(Code) | | Returns an 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.
an iterator over the namespace prefixes in thisSOAPElement object |
| getNamespaceURI | | public String getNamespaceURI(String prefix)(Code) | | Returns the URI of the namespace that has the given prefix.
Parameters:
prefix - a String giving the prefix of the namespacefor which to search a String with the uri of the namespace that hasthe given prefix |
| getVisibleNamespacePrefixes | | public Iterator getVisibleNamespacePrefixes()(Code) | | Returns an 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.
an iterator over the namespace prefixes are within scope of thisSOAPElement object
since:
SAAJ 1.2 |
| removeAttribute | | public boolean removeAttribute(QName qname)(Code) | | Removes the attribute with the specified qname.
Parameters:
qname - the QName object with the qname of theattribute to be removed true if the attribute wasremoved successfully; false if it was not
See Also: SOAPElement.removeAttribute(Name)
since:
SAAJ 1.3 |
| removeContents | | abstract public void removeContents()(Code) | | Detaches all children of this 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.
since:
SAAJ 1.2 |
| removeNamespaceDeclaration | | public boolean removeNamespaceDeclaration(String prefix)(Code) | | Removes the namespace declaration corresponding to the given prefix.
Parameters:
prefix - a String giving the prefix for whichto search true if the namespace declaration wasremoved successfully; false if it was not |
| setElementQName | | public SOAPElement setElementQName(QName newName) throws SOAPException(Code) | | Changes the name of this 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.
Parameters:
newName - the new name for the Element.
exception:
SOAPException - if changing the name of this Elementis not allowed. The renamed Node
since:
SAAJ 1.3 |
|
|
|