org.eclipse.kura.cloud

Enum CloudPayloadEncoding

java.lang.Object

java.lang.Enum<CloudPayloadEncoding>

org.eclipse.kura.cloud.CloudPayloadEncoding

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<CloudPayloadEncoding>

public enum CloudPayloadEncoding
extends java.lang.Enum<CloudPayloadEncoding>

This enum specifies the supported payload encodings.

Since:

1.2

Enum Constant Summary

Enum Constants

Enum Constant and Description
KURA_PROTOBUF
SIMPLE_JSON

Method Summary

Modifier and Type	Method and Description
static CloudPayloadEncoding	getEncoding(java.lang.String proposedEncoding) Allows to map a provided string with the corresponding CloudPayloadEncoding
static CloudPayloadEncoding	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static CloudPayloadEncoding[]	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

KURA_PROTOBUF

public static final CloudPayloadEncoding KURA_PROTOBUF

SIMPLE_JSON

public static final CloudPayloadEncoding SIMPLE_JSON

Method Detail

values

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

Returns:

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

valueOf

public static CloudPayloadEncoding valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null

getEncoding

public static CloudPayloadEncoding getEncoding(java.lang.String proposedEncoding)

Allows to map a provided string with the corresponding CloudPayloadEncoding

Parameters:

proposedEncoding - the String that has to be mapped to the corresponding CloudPayloadEncoding

Returns:

CloudPayloadEncoding if the matching between passed string and enum values succeeds

Throws:

java.lang.IllegalArgumentException - if the argument cannot be matched to a corresponding CloudPayloadEncoding object.