com.ibm.cloud.objectstorage.protocol

Enum MarshallLocation

java.lang.Object

java.lang.Enum<MarshallLocation>

com.ibm.cloud.objectstorage.protocol.MarshallLocation

All Implemented Interfaces:

Serializable, Comparable<MarshallLocation>

public enum MarshallLocation
extends Enum<MarshallLocation>

Enum representing the various locations data can be marshalled to.

Enum Constant Summary

Enum Constants

Enum Constant and Description
GREEDY_PATH Replace the placeholder in the request URI (greedy).
HEADER HTTP header.
PATH Replace the placeholder in the request URI (non-greedy).
PAYLOAD Payload of the request (format depends on the protocol/content-type)
QUERY_PARAM Add as a query parameter.

Method Summary

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

PAYLOAD

public static final MarshallLocation PAYLOAD

Payload of the request (format depends on the protocol/content-type)

QUERY_PARAM

public static final MarshallLocation QUERY_PARAM

Add as a query parameter.

HEADER

public static final MarshallLocation HEADER

HTTP header.

PATH

public static final MarshallLocation PATH

Replace the placeholder in the request URI (non-greedy).

GREEDY_PATH

public static final MarshallLocation GREEDY_PATH

Replace the placeholder in the request URI (greedy). This location is really the same as MarshallLocation.PATH, the only difference is whether it's URL encoded or not. Members bound to the MarshallLocation.PATH will be URL encoded before replacing, members bound to MarshallLocation.GREEDY_PATH will not be URL encoded.

Method Detail

values

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

Returns:

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

valueOf

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