com.scvngr.levelup.core.net

Enum LevelUpStatus

java.lang.Object

java.lang.Enum<LevelUpStatus>

com.scvngr.levelup.core.net.LevelUpStatus

All Implemented Interfaces:

Serializable, Comparable<LevelUpStatus>

@LevelUpApi(contract=PUBLIC)
public enum LevelUpStatus
extends Enum<LevelUpStatus>

Enum for translating generic network responses (and exceptions) into more broad categories for use within client apps.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ERROR_BAD_REQUEST The request was bad before sending.
ERROR_MAINTENANCE The server is down for maintenance.
ERROR_NETWORK Was unable to get to the server.
ERROR_NOT_FOUND Server responded that the resource requested couldn't be found.
ERROR_PARSING Server responded with JSON that we failed to parse.
ERROR_RESPONSE_TOO_LARGE The response from the server was too big to read.
ERROR_SERVER Server responded with an error code.
ERROR_UNKNOWN No response passed and no error thrown, unknown problem.
LOGIN_REQUIRED The client must be logged in to complete the request.
OK Server responded with success code.
PROCESSING The server is processing a long request.
UPGRADE The server instructed the client that an upgrade is required.

Method Summary

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

OK

public static final LevelUpStatus OK

Server responded with success code.

ERROR_BAD_REQUEST

public static final LevelUpStatus ERROR_BAD_REQUEST

The request was bad before sending.

ERROR_NOT_FOUND

public static final LevelUpStatus ERROR_NOT_FOUND

Server responded that the resource requested couldn't be found.

ERROR_PARSING

public static final LevelUpStatus ERROR_PARSING

Server responded with JSON that we failed to parse.

ERROR_SERVER

public static final LevelUpStatus ERROR_SERVER

Server responded with an error code.

ERROR_MAINTENANCE

public static final LevelUpStatus ERROR_MAINTENANCE

The server is down for maintenance.

ERROR_NETWORK

public static final LevelUpStatus ERROR_NETWORK

Was unable to get to the server.

ERROR_RESPONSE_TOO_LARGE

public static final LevelUpStatus ERROR_RESPONSE_TOO_LARGE

The response from the server was too big to read.

ERROR_UNKNOWN

public static final LevelUpStatus ERROR_UNKNOWN

No response passed and no error thrown, unknown problem.

LOGIN_REQUIRED

public static final LevelUpStatus LOGIN_REQUIRED

The client must be logged in to complete the request.

PROCESSING

public static final LevelUpStatus PROCESSING

The server is processing a long request.

UPGRADE

public static final LevelUpStatus UPGRADE

The server instructed the client that an upgrade is required.

Method Detail

values

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

Returns:

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

valueOf

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