Java Doc for SOAPElement.java in » Web-Services-AXIS2 » saaj » javax » xml » soap » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation

1.	6.0 JDK Core
2.	6.0 JDK Modules
3.	6.0 JDK Modules com.sun
4.	6.0 JDK Modules com.sun.java
5.	6.0 JDK Modules sun
6.	6.0 JDK Platform
7.	Ajax
8.	Apache Harmony Java SE
9.	Aspect oriented
10.	Authentication Authorization
11.	Blogger System
12.	Build
13.	Byte Code
14.	Cache
15.	Chart
16.	Chat
17.	Code Analyzer
18.	Collaboration
19.	Content Management System
20.	Database Client
21.	Database DBMS
22.	Database JDBC Connection Pool
23.	Database ORM
24.	Development
25.	EJB Server geronimo
26.	EJB Server GlassFish
27.	EJB Server JBoss 4.2.1
28.	EJB Server resin 3.1.5
29.	ERP CRM Financial
30.	ESB
31.	Forum
32.	GIS
33.	Graphic Library
34.	Groupware
35.	HTML Parser
36.	IDE
37.	IDE Eclipse
38.	IDE Netbeans
39.	Installer
40.	Internationalization Localization
41.	Inversion of Control
42.	Issue Tracking
43.	J2EE
44.	JBoss
45.	JMS
46.	JMX
47.	Library
48.	Mail Clients
49.	Net
50.	Parser
51.	PDF
52.	Portal
53.	Profiler
54.	Project Management
55.	Report
56.	RSS RDF
57.	Rule Engine
58.	Science
59.	Scripting
60.	Search Engine
61.	Security
62.	Sevlet Container
63.	Source Control
64.	Swing Library
65.	Template Engine
66.	Test Coverage
67.	Testing
68.	UML
69.	Web Crawler
70.	Web Framework
71.	Web Mail
72.	Web Server
73.	Web Services
74.	Web Services apache cxf 2.0.1
75.	Web Services AXIS2
76.	Wiki Engine
77.	Workflow Engines
78.	XML
79.	XML UI

Java

Java Tutorial

Illustrator Tutorials

GIMP Tutorials

C# / C Sharp

C# / CSharp Tutorial

C# / CSharp Open Source

SQL Server / T-SQL Tutorial

Oracle PL / SQL

Oracle PL/SQL Tutorial

Flash / Flex / ActionScript

VBA / Excel / Access / Word

XML

XML Tutorial

Microsoft Office PowerPoint 2007 Tutorial

Microsoft Office Excel 2007 Tutorial

Microsoft Office Word 2007 Tutorial

Java Source Code / Java Documentation » Web Services AXIS2 » saaj » javax.xml.soap

Source Cross Reference Class Diagram Java Document (Java Doc)

javax.xml.soap .SOAPElement

All known Subclasses:   org.apache.axis2.saaj .SOAPElementImpl,
SOAPElement
public interface SOAPElement extends javax.xml.soap.Node,org.w3c.dom.Element(Code)
An object representing the contents in a SOAPBody object, the contents in a SOAPHeader object, the content that can follow the SOAPBody object in a SOAPEnvelope object, or what can follow the detail element in a SOAPFault object. It is the base class for all of the classes that represent the SOAP objects as defined in the SOAP specification.

Method Summary
abstract public SOAPElement addAttribute(Name name, String value)
     Adds an attribute with the specified name and value to this SOAPElement object.
abstract public SOAPElement addAttribute(javax.xml.namespace.QName qname, java.lang.String value)

abstract 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.
abstract public SOAPElement addChildElement(String localName)
     Creates a new SOAPElement object initialized with the given String object and adds the new element to this SOAPElement object.
abstract 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.
abstract 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.
abstract public SOAPElement addChildElement(SOAPElement element)
     Add a SOAPElement as a child of this SOAPElement instance.
abstract public SOAPElement addChildElement(javax.xml.namespace.QName qname)

abstract public SOAPElement addNamespaceDeclaration(String prefix, String uri)
     Adds a namespace declaration with the specified prefix and URI to this SOAPElement object.
abstract public SOAPElement addTextNode(String text)
     Creates a new Text object initialized with the given String and adds it to this SOAPElement object.
abstract public javax.xml.namespace.QName createQName(String localName, String prefix)

abstract public Iterator getAllAttributes()
     Returns an iterator over all of the attribute names in this SOAPElement object.
abstract public java.util.Iterator getAllAttributesAsQNames()

abstract public String getAttributeValue(Name name)
     Returns the value of the attribute with the specified name.
abstract public java.lang.String getAttributeValue(javax.xml.namespace.QName qname)

abstract public Iterator getChildElements()
     Returns an iterator over all the immediate content of this element.
abstract public Iterator getChildElements(Name name)
     Returns an iterator over all the child elements with the specified name.
abstract public java.util.Iterator getChildElements(QName name)

abstract public Name getElementName()
     Returns the name of this SOAPElement object.
abstract public javax.xml.namespace.QName getElementQName()

abstract public String getEncodingStyle()
     Returns the encoding style for this SOAPElement object.
abstract public Iterator getNamespacePrefixes()
     Returns an iterator of namespace prefixes.
abstract public String getNamespaceURI(String prefix)
     Returns the URI of the namespace that has the given prefix.
abstract public Iterator getVisibleNamespacePrefixes()
     Returns an Iterator over the namespace prefix Strings visible to this element.
abstract public boolean removeAttribute(Name name)
     Removes the attribute with the specified name.
boolean removeAttribute(javax.xml.namespace.QName 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 reparation for sending a fault when an error condition is detected.
abstract public boolean removeNamespaceDeclaration(String prefix)
     Removes the namespace declaration corresponding to the given prefix.
abstract public SOAPElement setElementQName(javax.xml.namespace.QName newName)

abstract public void setEncodingStyle(String encodingStyle)
     Sets the encoding style for this SOAPElement object to one specified.

Method Detail
addAttribute
abstract 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 was inserted
throws:
  SOAPException - if there is an error in creating the Attribute

addAttribute
abstract public SOAPElement addAttribute(javax.xml.namespace.QName qname, java.lang.String value) throws SOAPException(Code)

addChildElement
abstract 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.
Parameters:
  name - a Name object with the XML name for the new element the new SOAPElement object that was created
throws:
  SOAPException - if there is an error in creating the SOAPElement object

addChildElement
abstract public SOAPElement addChildElement(String localName) throws SOAPException(Code)
Creates a new SOAPElement object initialized with the given String object and adds the new element to this SOAPElement object.
Parameters:
  localName - a String giving the local name for the element the new SOAPElement object that was created
throws:
  SOAPException - if there is an error in creating the SOAPElement object

addChildElement
abstract 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 for the new element
Parameters:
  prefix - a String giving the namespace prefix for the new element the new SOAPElement object that was created
throws:
  SOAPException - if there is an error in creating the SOAPElement object

addChildElement
abstract 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 for the new element
Parameters:
  prefix - a String giving the namespace prefix for the new element
Parameters:
  uri - a String giving the URI of the namespace to which the newelement belongs the new SOAPElement object that was created
throws:
  SOAPException - if there is an error in creating the SOAPElement object

addChildElement
abstract 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 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.
Parameters:
  element - the SOAPElement to be added as a new child an instance representing the new SOAP element that was actually added to the tree.
throws:
  SOAPException - if there was an error in adding this element as a child

addChildElement
abstract public SOAPElement addChildElement(javax.xml.namespace.QName qname) throws SOAPException(Code)

addNamespaceDeclaration
abstract 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 prefix of the namespace the SOAPElement object into which this namespace declaration wasinserted.
throws:
  SOAPException - if there is an error in creating the namespace

addTextNode
abstract 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 which the new Text object wasinserted
throws:
  SOAPException - if there is an error in creating the new Text object

createQName
abstract public javax.xml.namespace.QName createQName(String localName, String prefix) throws SOAPException(Code)

getAllAttributes
abstract public Iterator getAllAttributes()(Code)
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

getAllAttributesAsQNames
abstract public java.util.Iterator getAllAttributesAsQNames()(Code)

getAttributeValue
abstract public String getAttributeValue(Name name)(Code)
Returns the value of the attribute with the specified name.
Parameters:
  name - a Name object with the name of the attribute a String giving the value of the specified attribute

getAttributeValue
abstract public java.lang.String getAttributeValue(javax.xml.namespace.QName qname)(Code)

getChildElements
abstract public Iterator getChildElements()(Code)
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
abstract public Iterator getChildElements(Name name)(Code)
Returns an iterator over all the child elements with the specified name.
Parameters:
  name - a Name object with the name of the child elements to be returned an Iterator object over all the elements in thisSOAPElement object with the specified name

getChildElements
abstract public java.util.Iterator getChildElements(QName name)(Code)

getElementName
abstract public Name getElementName()(Code)
Returns the name of this SOAPElement object. a Name object with the name of this SOAPElement object

getElementQName
abstract public javax.xml.namespace.QName getElementQName()(Code)

getEncodingStyle
abstract public String getEncodingStyle()(Code)
Returns the encoding style for this SOAPElement object. a String giving the encoding style
See Also:   SOAPElement.setEncodingStyle(String)
See Also:    setEncodingStyle(java.lang.String)

getNamespacePrefixes
abstract public Iterator getNamespacePrefixes()(Code)
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
abstract 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 namespace for which to search a String with the uri of the namespace that has the given prefix

getVisibleNamespacePrefixes
abstract 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

removeAttribute
abstract public boolean removeAttribute(Name name)(Code)
Removes the attribute with the specified name.
Parameters:
  name - the Name object with the name of the attribute to be removed true if the attribute was removed successfully; false if itwas not

removeAttribute
boolean removeAttribute(javax.xml.namespace.QName qname)(Code)

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 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
abstract public boolean removeNamespaceDeclaration(String prefix)(Code)
Removes the namespace declaration corresponding to the given prefix.
Parameters:
  prefix - a String giving the prefix for which to search true if the namespace declaration was removed successfully;false if it was not

setElementQName
abstract public SOAPElement setElementQName(javax.xml.namespace.QName newName) throws SOAPException(Code)

setEncodingStyle
abstract public void setEncodingStyle(String encodingStyle) throws SOAPException(Code)
Sets the encoding style for this SOAPElement object to one specified.
Parameters:
  encodingStyle - a String giving the encoding style
throws:
  IllegalArgumentException - if there was a problem in the encoding style being set.
See Also:   SOAPElement.getEncodingStyle()
See Also:    getEncodingStyle()

www.java2java.com | Contact Us

All other trademarks are property of their respective owners.