com.inmanlabs.commons.web

Enum ApiResponseStatus

java.lang.Object

java.lang.Enum<ApiResponseStatus>

com.inmanlabs.commons.web.ApiResponseStatus

All Implemented Interfaces:

Serializable, Comparable<ApiResponseStatus>

public enum ApiResponseStatus
extends Enum<ApiResponseStatus>

Response statuses for JSON API. Follows the Jsend standard: https://github.com/omniti-labs/jsend

Enum Constant Summary

Enum Constants

Enum Constant and Description
error
fail
success

Method Summary

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

success

public static final ApiResponseStatus success

error

public static final ApiResponseStatus error

fail

public static final ApiResponseStatus fail

Method Detail

values

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

Returns:

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

valueOf

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