addAttribute
public SOAPElement addAttribute(Name name,
String value)
throws SOAPException
Adds an attribute with the specified name and value to this
SOAPElement
object.
name
- a Name
object with the name of the attributevalue
- a String
giving the value of the attribute
- the
SOAPElement
object into which the attribute was
inserted
SOAPException
- if there is an error in creating the
Attribute
addChildElement
public SOAPElement addChildElement(String localName)
throws SOAPException
Creates a new SOAPElement
object initialized with the
given String
object and adds the new element to this
SOAPElement
object.
localName
- a String
giving the local name for
the element
- the new
SOAPElement
object that was created
SOAPException
- if there is an error in creating the
SOAPElement
object
addChildElement
public SOAPElement addChildElement(String localName,
String prefix)
throws SOAPException
Creates a new 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
- the new
SOAPElement
object that was created
SOAPException
- if there is an error in creating the
SOAPElement
object
addChildElement
public SOAPElement addChildElement(String localName,
String prefix,
String uri)
throws SOAPException
Creates a new 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
- the new
SOAPElement
object that was created
SOAPException
- if there is an error in creating the
SOAPElement
object
addChildElement
public SOAPElement addChildElement(Name name)
throws SOAPException
Creates a new SOAPElement
object initialized with the
given Name
object and adds the new element to this
SOAPElement
object.
name
- a Name
object with the XML name for the
new element
- the new
SOAPElement
object that was created
SOAPException
- if there is an error in creating the
SOAPElement
object
addChildElement
public SOAPElement addChildElement(SOAPElement element)
throws SOAPException
Add a
SOAPElement
as a child of this
SOAPElement
instance. The
SOAPElement
is expected to be created by a
SOAPElementFactory
. 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
- an instance representing the new SOAP element that was
actually added to the tree.
SOAPException
- if there was an error in adding this
element as a child
addNamespaceDeclaration
public SOAPElement addNamespaceDeclaration(String prefix,
String uri)
throws SOAPException
Adds a namespace declaration with the specified prefix and URI to this
SOAPElement
object.
prefix
- a String
giving the prefix of the namespaceuri
- a String
giving
the prefix of the namespace
- the
SOAPElement
object into which this
namespace declaration was inserted.
SOAPException
- if there is an error in creating the
namespace
addTextNode
public SOAPElement addTextNode(String text)
throws SOAPException
Creates a new 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
- the
SOAPElement
object into which
the new Text
object was inserted
SOAPException
- if there is an error in creating the
new Text
object
getAllAttributes
public Iterator getAllAttributes()
Returns an iterator over all of the attribute names 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.
- an iterator over the names of the attributes
getAttributeValue
public String getAttributeValue(Name name)
Returns the value of the attribute with the specified
name.
name
- a Name
object with
the name of the attribute
- a
String
giving the value of the
specified attribute
getChildElements
public Iterator getChildElements()
Returns an iterator over all the immediate content of
this element. This includes Text
objects as well
as SOAPElement
objects.
- an iterator with the content of this
SOAPElement
object
getChildElements
public Iterator getChildElements(Name name)
Returns an iterator over all the child elements with the
specified name.
name
- a Name
object with
the name of the child elements to be returned
- an
Iterator
object over all the elements
in this SOAPElement
object with the
specified name
getElementName
public Name getElementName()
Returns the name of this SOAPElement
object.
- a
Name
object with the name of this
SOAPElement
object
getEncodingStyle
public String getEncodingStyle()
Returns the encoding style for this
SOAPElement
object.
- a
String
giving the encoding style
setEncodingStyle(java.lang.String)
getNamespacePrefixes
public Iterator getNamespacePrefixes()
Returns an iterator of namespace prefixes. The iterator
can be used to get the namespace prefixes, which can then be
passed to the method getNamespaceURI
to retrieve
the URI of each namespace.
- an iterator over the namespace prefixes in this
SOAPElement
object
getNamespaceURI
public String getNamespaceURI(String prefix)
Returns the URI of the namespace that has the given
prefix.
prefix
- a String
giving
the prefix of the namespace for which to search
- a
String
with the uri of the namespace
that has the given prefix
getVisibleNamespacePrefixes
public Iterator getVisibleNamespacePrefixes()
Returns an Iterator
over the namespace prefix
String
s 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 this
SOAPElement
object
removeAttribute
public boolean removeAttribute(Name name)
Removes the attribute with the specified 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 not
removeContents
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
reparation for sending a fault when an error condition is detected. It is
also useful for recycling portions of a document within a SOAP message.
removeNamespaceDeclaration
public boolean removeNamespaceDeclaration(String prefix)
Removes the namespace declaration corresponding to the
given prefix.
prefix
- a String
giving
the prefix for which to search
true
if the namespace declaration was
removed successfully; false
if it was
not
setEncodingStyle
public void setEncodingStyle(String encodingStyle)
throws SOAPException
Sets the encoding style for this SOAPElement
object to one specified.
encodingStyle
- a String
giving the encoding style
getEncodingStyle()