This documentation differs from the official API.
Jadeite adds
extra features to the API including:
variable font sizes,
constructions examples,
placeholders for classes and methods, and auto-generated “See Also” links.
Additionally it
is missing some items found in standard Javadoc documentation, including:
generics type information,
“Deprecated” tags and comments,
“See Also” links,
along with other minor differences.
Please send any questions or feedback to
bam@cs.cmu.edu.
javax.xml.soap
class SAAJResult
- All Implemented Interfaces:
- Result
public class SAAJResult
extends DOMResult
Acts as a holder for the results of a JAXP transformation or a JAXB
marshalling, in the form of a SAAJ tree. These results should be accessed
by using the {@link #getResult()} method. The {@link DOMResult#getNode()}
method should be avoided in almost all cases.
| Constructor Summary |
Creates a SAAJResult that will present results in the form
of a SAAJ tree that supports the default (SOAP 1.1) protocol.
|
Creates a SAAJResult that will write the results as a
child node of the SOAPElement specified.
|
Creates a SAAJResult that will write the results into the
SOAPPart of the supplied SOAPMessage.
|
Creates a SAAJResult that will present results in the form
of a SAAJ tree that supports the specified protocol.
|
| Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
SAAJResult
public SAAJResult()
throws SOAPException
-
Creates a
SAAJResult that will present results in the form
of a SAAJ tree that supports the default (SOAP 1.1) protocol.
This kind of SAAJResult is meant for use in situations where the
results will be used as a parameter to a method that takes a parameter
whose type, such as SOAPElement, is drawn from the SAAJ
API. When used in a transformation, the results are populated into the
SOAPPart of a SOAPMessage that is created internally.
The SOAPPart returned by {@link DOMResult#getNode()}
is not guaranteed to be well-formed.
- Throws:
SOAPException - if there is a problem creating a SOAPMessage
SAAJResult
public SAAJResult(SOAPElement rootNode)
-
Creates a
SAAJResult that will write the results as a
child node of the SOAPElement specified. In the normal
case these results will be written using DOM APIs and as a result may
invalidate the structure of the SAAJ tree. This kind of
SAAJResult should only be used when the validity of the
incoming data can be guaranteed by means outside of the SAAJ
specification.
- Parameters:
rootNode - - the root to which the results will be appended
SAAJResult
public SAAJResult(SOAPMessage message)
-
Creates a
SAAJResult that will write the results into the
SOAPPart of the supplied SOAPMessage.
In the normal case these results will be written using DOM APIs and,
as a result, the finished SOAPPart will not be guaranteed
to be well-formed unless the data used to create it is also well formed.
When used in a transformation the validity of the SOAPMessage
after the transformation can be guaranteed only by means outside SAAJ
specification.
- Parameters:
message - - the message whose SOAPPart will be
populated as a result of some transformation or
marshalling operation
SAAJResult
public SAAJResult(String protocol)
throws SOAPException
-
Creates a
SAAJResult that will present results in the form
of a SAAJ tree that supports the specified protocol. The
DYNAMIC_SOAP_PROTOCOL is ambiguous in this context and will
cause this constructor to throw an UnsupportedOperationException.
This kind of SAAJResult is meant for use in situations where the
results will be used as a parameter to a method that takes a parameter
whose type, such as SOAPElement, is drawn from the SAAJ
API. When used in a transformation the results are populated into the
SOAPPart of a SOAPMessage that is created
internally. The SOAPPart returned by {@link DOMResult#getNode()}
is not guaranteed to be well-formed.
- Parameters:
protocol - - the name of the SOAP protocol that the resulting SAAJ
tree should support- Throws:
SOAPException - if a SOAPMessage supporting the
specified protocol cannot be created
getResult
public Node getResult()
-
- Returns:
- the resulting Tree that was created under the specified root Node.
This documentation differs from the official API.
Jadeite adds
extra features to the API including:
variable font sizes,
constructions examples,
placeholders for classes and methods, and auto-generated “See Also” links.
Additionally it
is missing some items found in standard Javadoc documentation, including:
generics type information,
“Deprecated” tags and comments,
“See Also” links,
along with other minor differences.
Please send any questions or feedback to
bam@cs.cmu.edu.
This page displays the
Jadeite version of the documention, which is derived from the offical documentation that contains this copyright notice:
The official Sun™ documentation can be found here at
http://java.sun.com/javase/6/docs/api/.
javax.xml.transform.dom.DOMResult