org.mule.sdk.api.runtime.parameter

Enum HttpParameterPlacement

java.lang.Object

java.lang.Enum<HttpParameterPlacement>

org.mule.sdk.api.runtime.parameter.HttpParameterPlacement

All Implemented Interfaces:

Serializable, Comparable<HttpParameterPlacement>

public enum HttpParameterPlacement
extends Enum<HttpParameterPlacement>

Describes the possible placements a parameter can have inside a HTTP request

Since:

1.0

Enum Constant Summary

Enum Constants

Enum Constant and Description
HEADERS The parameter will be sent as a header
QUERY_PARAMS The parameter will be sent as a query parameter

Method Summary

Modifier and Type	Method and Description
static HttpParameterPlacement	valueOf(String name) Returns the enum constant of this type with the specified name.
static HttpParameterPlacement[]	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

QUERY_PARAMS

public static final HttpParameterPlacement QUERY_PARAMS

The parameter will be sent as a query parameter

HEADERS

public static final HttpParameterPlacement HEADERS

The parameter will be sent as a header

Method Detail

values

public static HttpParameterPlacement[] 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 (HttpParameterPlacement c : HttpParameterPlacement.values())
    System.out.println(c);

Returns:

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

valueOf

public static HttpParameterPlacement 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