Sun GlassFish Message Queue 4.4 Developer's Guide for Java Clients

Inherited Methods

The elements of a SOAP message form a tree. Each node in that tree implements the Node interface and, starting at the envelope level, each node implements the SOAPElement interface as well. The resulting shared methods are described in Table 5–1.

Table 5–1 Inherited Methods

Inherited From 

Method Name 

Purpose 


SOAPElemen

addAttribute(Name, String)

                           

Add an attribute with the specified Name object and string value

 

addChildElement(Name)
addChildElement(String, String)
addChildElement
    (String, String, String)

Create a new SOAPElement object, initialized with the given Name object, and add the new element

(Use the Envelope.createName method to create a Name object)

 

addNameSpaceDeclaration 
   (String, String)   

Add a namespace declaration with the specified prefix and URI 

 

addTextnode(String)

Create a new Text object initialized with the given String and add it to this SOAPElement object

 

getAllAttributes()

Return an iterator over all the attribute names in this object 

 

getAttributeValue(Name)

Return the value of the specified attribute 

 

getChildElements()

Return an iterator over all the immediate content of this element 

 

getChildElements(Name)

Return an iterator over all the child elements with the specified name 

 

getElementName()
 

Return the name of this object 

 

getEncodingStyle() 

Return the encoding style for this object 

 

getNameSpacePrefixes()

Return an iterator of namespace prefixes 

 

getNamespaceURI(String)

Return the URI of the namespace with the given prefix 

 

removeAttribute(Name)

Remove the specified attribute 

 

removeNamespaceDeclaration
(String)

Remove the namespace declaration that corresponds to the specified prefix 

 

setEncodingStyle(String)

Set the encoding style for this object to that specified by String


Node
                           

detachNode()    

Remove this Node object from the tree

 

getParentElement()

Return the parent element of this Node object

 

getValue 

Return the value of the immediate child of this Node object if a child exists and its value is text

 

recycleNode() 

Notify the implementation that his Node object is no longer being used and is free for reuse

 

setParentElement(SOAPElement)

Set the parent of this object to that specified by the SOAPElement parameter