Package com.helixframework.api.contract.envelope

Enum Class ResponseStatus

java.lang.Object

java.lang.Enum<ResponseStatus>

com.helixframework.api.contract.envelope.ResponseStatus

All Implemented Interfaces:

Serializable, Comparable<ResponseStatus>, Constable

public enum ResponseStatus
extends Enum<ResponseStatus>

Enum for representing response status as either SUCCESS or FAILED.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
FAILED
SUCCESS

Method Summary

Modifier and Type	Method	Description
static ResponseStatus	get(String value)	Gets the ResponseStatus enum value for the given string value.
String	getValue()	Gets the string value of the ResponseStatus.
static ResponseStatus	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ResponseStatus[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

SUCCESS

public static final ResponseStatus SUCCESS

FAILED

public static final ResponseStatus FAILED

Method Details

values

public static ResponseStatus[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static ResponseStatus valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

get

public static ResponseStatus get(String value)

Gets the ResponseStatus enum value for the given string value.

Parameters:

value - String value to get ResponseStatus for

Returns:

ResponseStatus enum value for the given string value

getValue

public String getValue()

Gets the string value of the ResponseStatus.

Returns:

String value of the ResponseStatus