org.apache.synapse.util.jaxp

Enum ResultBuilderFactory.Output

java.lang.Object

java.lang.Enum<ResultBuilderFactory.Output>

org.apache.synapse.util.jaxp.ResultBuilderFactory.Output

All Implemented Interfaces:

Serializable, Comparable<ResultBuilderFactory.Output>

Enclosing interface:

ResultBuilderFactory

public static enum ResultBuilderFactory.Output
extends Enum<ResultBuilderFactory.Output>

Enumeration defining the output type to be expected by ResultBuilder. This influences the exact behavior of ResultBuilder.getNode(java.nio.charset.Charset).

Enum Constant Summary

Enum Constants

Enum Constant and Description
ELEMENT The expected output is a simple OMElement.
SOAP_ENVELOPE The expected output is a SOAP envelope.
TEXT The expected output is text.

Method Summary

Modifier and Type	Method and Description
static ResultBuilderFactory.Output	valueOf(String name) Returns the enum constant of this type with the specified name.
static ResultBuilderFactory.Output[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ELEMENT

public static final ResultBuilderFactory.Output ELEMENT

The expected output is a simple OMElement. In this case, the return value of ResultBuilder.getNode(java.nio.charset.Charset) will be the root element of the AXIOM tree representing the XML infoset written to the Result object.

SOAP_ENVELOPE

public static final ResultBuilderFactory.Output SOAP_ENVELOPE

The expected output is a SOAP envelope. If this output type is used, an invocation of ResultBuilder#getNode() must return a SOAPEnvelope object.

TEXT

public static final ResultBuilderFactory.Output TEXT

The expected output is text. If this output type is used, ResultBuilder.getNode(java.nio.charset.Charset) must return a text wrapper with the output written to the Result object.

Method Detail

values

public static ResultBuilderFactory.Output[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ResultBuilderFactory.Output c : ResultBuilderFactory.Output.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ResultBuilderFactory.Output valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null