org.apache.axiom.soap.impl.llom
Class SOAPBodyImpl

java.lang.Object
  extended by org.apache.axiom.om.impl.llom.OMNodeImpl
      extended by org.apache.axiom.om.impl.llom.OMElementImpl
          extended by org.apache.axiom.soap.impl.llom.SOAPElement
              extended by org.apache.axiom.soap.impl.llom.SOAPBodyImpl
All Implemented Interfaces:
OMContainerEx, OMNodeEx, OMConstants, OMContainer, OMElement, OMNode, SOAPBody
Direct Known Subclasses:
SOAP11BodyImpl, SOAP12BodyImpl

public abstract class SOAPBodyImpl
extends SOAPElement
implements SOAPBody, OMConstants

Class SOAPBodyImpl


Field Summary
 
Fields inherited from class org.apache.axiom.om.impl.llom.OMElementImpl
attributes, DEFAULT_DEFAULT_NS_OBJECT, firstChild, lastChild, localName, namespaces, noPrefixNamespaceCounter, ns, qName
 
Fields inherited from class org.apache.axiom.om.impl.llom.OMNodeImpl
builder, done, factory, nextSibling, nodeType, parent, previousSibling
 
Fields inherited from interface org.apache.axiom.om.OMNode
CDATA_SECTION_NODE, COMMENT_NODE, DTD_NODE, ELEMENT_NODE, ENTITY_REFERENCE_NODE, PI_NODE, SPACE_NODE, TEXT_NODE
 
Fields inherited from interface org.apache.axiom.om.OMConstants
ARRAY_ITEM_LOCALNAME, ARRAY_ITEM_NS_PREFIX, ARRAY_ITEM_NSURI, ARRAY_ITEM_QNAME, DATA_HANDLER, DEFAULT_CHAR_SET_ENCODING, DEFAULT_DEFAULT_NAMESPACE, DEFAULT_XML_VERSION, IS_BINARY, IS_DATA_HANDLERS_AWARE, PULL_TYPE_BUILDER, PUSH_TYPE_BUILDER, XMLATTRTYPE_CDATA, XMLATTRTYPE_ENTITIES, XMLATTRTYPE_ENTITY, XMLATTRTYPE_ID, XMLATTRTYPE_IDREF, XMLATTRTYPE_IDREFS, XMLATTRTYPE_NMTOKEN, XMLATTRTYPE_NMTOKENS, XMLATTRTYPE_NOTATION, XMLNS_NS_PREFIX, XMLNS_NS_URI, XMLNS_PREFIX, XMLNS_URI
 
Constructor Summary
  SOAPBodyImpl(SOAPEnvelope envelope, OMXMLParserWrapper builder, SOAPFactory factory)
          Constructor SOAPBodyImpl
  SOAPBodyImpl(SOAPEnvelope envelope, SOAPFactory factory)
           
protected SOAPBodyImpl(java.lang.String localName, OMNamespace ns, SOAPFactory factory)
           
 
Method Summary
 void addChild(OMNode child)
          Adds child to the element.
abstract  SOAPFault addFault(java.lang.Exception e)
          Creates a new SOAPFault object and adds it to this SOAPBody object.
 void addFault(SOAPFault soapFault)
           
 void buildNext()
          Forces the parser to proceed, if parser has not yet finished with the XML input.
protected  void checkParent(OMElement parent)
          This has to be implemented by all the derived classes to check for the correct parent.
 OMNode detach()
          Removes this information item and its children, from the model completely.
 SOAPFault getFault()
          Returns the SOAPFault object in this SOAPBody object.
 java.lang.String getFirstElementLocalName()
          Retrieves the local name of the first element in the body.
 OMNamespace getFirstElementNS()
          Retrieves the OMNamespace of the first element in the body.
 boolean hasFault()
          Indicates whether a SOAPFault object exists in this SOAPBody object.
 
Methods inherited from class org.apache.axiom.soap.impl.llom.SOAPElement
registerContentHandler, setParent
 
Methods inherited from class org.apache.axiom.om.impl.llom.OMElementImpl
addAttribute, addAttribute, build, buildWithAttachments, cloneOMElement, declareDefaultNamespace, declareNamespace, declareNamespace, discard, findNamespace, findNamespaceURI, getAllAttributes, getAllDeclaredNamespaces, getAttribute, getAttributeValue, getBuilder, getChildElements, getChildren, getChildrenWithLocalName, getChildrenWithName, getChildrenWithNamespaceURI, getDefaultNamespace, getFirstChildWithName, getFirstElement, getFirstOMChild, getLineNumber, getLocalName, getNamespace, getNextOMSibling, getQName, getText, getTextAsQName, getTrimmedText, getType, getXMLStreamReader, getXMLStreamReaderWithoutCaching, internalSerialize, internalSerialize, internalSerializeAndConsume, isComplete, notifyChildComplete, removeAttribute, resolveQName, setBuilder, setFirstChild, setLastChild, setLineNumber, setLocalName, setNamespace, setNamespaceWithNoFindInCurrentScope, setText, setText, toString, toStringWithConsume
 
Methods inherited from class org.apache.axiom.om.impl.llom.OMNodeImpl
close, getOMFactory, getParent, getPreviousOMSibling, importNode, insertSiblingAfter, insertSiblingBefore, serialize, serialize, serialize, serialize, serialize, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume, setComplete, setNextOMSibling, setPreviousOMSibling, setType
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.apache.axiom.om.OMElement
addAttribute, addAttribute, cloneOMElement, declareDefaultNamespace, declareNamespace, declareNamespace, findNamespace, findNamespaceURI, getAllAttributes, getAllDeclaredNamespaces, getAttribute, getAttributeValue, getBuilder, getChildElements, getDefaultNamespace, getFirstElement, getLineNumber, getLocalName, getNamespace, getQName, getText, getTextAsQName, getXMLStreamReader, getXMLStreamReaderWithoutCaching, removeAttribute, resolveQName, setBuilder, setFirstChild, setLineNumber, setLocalName, setNamespace, setNamespaceWithNoFindInCurrentScope, setText, setText, toString, toStringWithConsume
 
Methods inherited from interface org.apache.axiom.om.OMNode
build, buildWithAttachments, close, discard, getNextOMSibling, getOMFactory, getParent, getPreviousOMSibling, getType, insertSiblingAfter, insertSiblingBefore, isComplete, serialize, serialize, serialize, serialize, serialize, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume
 
Methods inherited from interface org.apache.axiom.om.OMContainer
getChildren, getChildrenWithLocalName, getChildrenWithName, getChildrenWithNamespaceURI, getFirstChildWithName, getFirstOMChild, isComplete
 
Methods inherited from interface org.apache.axiom.om.impl.OMContainerEx
setComplete
 

Constructor Detail

SOAPBodyImpl

protected SOAPBodyImpl(java.lang.String localName,
                       OMNamespace ns,
                       SOAPFactory factory)

SOAPBodyImpl

public SOAPBodyImpl(SOAPEnvelope envelope,
                    SOAPFactory factory)
             throws SOAPProcessingException
Parameters:
envelope -
Throws:
SOAPProcessingException

SOAPBodyImpl

public SOAPBodyImpl(SOAPEnvelope envelope,
                    OMXMLParserWrapper builder,
                    SOAPFactory factory)
Constructor SOAPBodyImpl

Parameters:
envelope -
builder -
Method Detail

addFault

public abstract SOAPFault addFault(java.lang.Exception e)
                            throws OMException
Creates a new SOAPFault object and adds it to this SOAPBody object.

Specified by:
addFault in interface SOAPBody
Parameters:
e -
Returns:
the new SOAPFault object
Throws:
OMException - if there is a SOAP error
OMException

hasFault

public boolean hasFault()
Indicates whether a SOAPFault object exists in this SOAPBody object.

Specified by:
hasFault in interface SOAPBody
Returns:
true if a SOAPFault object exists in this SOAPBody object; false otherwise

getFault

public SOAPFault getFault()
Returns the SOAPFault object in this SOAPBody object.

Specified by:
getFault in interface SOAPBody
Returns:
the SOAPFault object in this SOAPBody object

addFault

public void addFault(SOAPFault soapFault)
              throws OMException
Specified by:
addFault in interface SOAPBody
Parameters:
soapFault -
Throws:
OMException
OMException

checkParent

protected void checkParent(OMElement parent)
                    throws SOAPProcessingException
Description copied from class: SOAPElement
This has to be implemented by all the derived classes to check for the correct parent.

Specified by:
checkParent in class SOAPElement
Throws:
SOAPProcessingException

detach

public OMNode detach()
              throws OMException
Description copied from class: OMElementImpl
Removes this information item and its children, from the model completely.

Specified by:
detach in interface OMNode
Overrides:
detach in class OMElementImpl
Throws:
OMException - If a node is not complete, the detach can trigger further parsing, which may cause an exception.

buildNext

public void buildNext()
Description copied from class: OMElementImpl
Forces the parser to proceed, if parser has not yet finished with the XML input.

Specified by:
buildNext in interface OMContainer
Overrides:
buildNext in class OMElementImpl

getFirstElementNS

public OMNamespace getFirstElementNS()
Description copied from interface: SOAPBody
Retrieves the OMNamespace of the first element in the body. The implementation might build the OMElement or it may obtain this information from the builder/parser without building the OMElement. Use this method in the situations where you need to know the OMNamespace, but don't necessarily need the OMElement.

Specified by:
getFirstElementNS in interface SOAPBody
Returns:
OMNamespace of first element in the body or null

getFirstElementLocalName

public java.lang.String getFirstElementLocalName()
Description copied from interface: SOAPBody
Retrieves the local name of the first element in the body. The implementation might build the OMElement or it may obtain this information from the builder/parser without building the OMElement. Use this method in the situations where you need to know the name, but don't necessarily need the OMElement.

Specified by:
getFirstElementLocalName in interface SOAPBody
Returns:
local name of first element in the body or null

addChild

public void addChild(OMNode child)
Description copied from class: OMElementImpl
Adds child to the element. One can decide whether to append the child or to add to the front of the children list.

Specified by:
addChild in interface OMContainer
Overrides:
addChild in class OMElementImpl


Copyright © 2004-2009 The Apache Software Foundation. All Rights Reserved.