ccc.api.types
Enum FailureCode

java.lang.Object
  java.lang.Enum<FailureCode>
      ccc.api.types.FailureCode

All Implemented Interfaces:

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

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

Failure codes for the public API.

Author:

Civic Computing Ltd.

Enum Constant Summary

CYCLE
CYCLE : FailureCode.

EXISTS
EXISTS : FailureCode.

INVALID
INVALID : FailureCode.

LOCK_MISMATCH
LOCK_MISMATCH : FailureCode.

NOT_FOUND
NOT_FOUND : FailureCode.

PRIVILEGES
PRIVILEGES : FailureCode.

UNEXPECTED
UNEXPECTED : FailureCode.

UNLOCKED
UNLOCKED : FailureCode.

WC_UNSUPPORTED
WC_UNSUPPORTED : FailureCode.

Method Summary

static FailureCode	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static FailureCode[]	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

UNEXPECTED

public static final FailureCode UNEXPECTED

UNEXPECTED : FailureCode.

UNLOCKED

public static final FailureCode UNLOCKED

UNLOCKED : FailureCode.

LOCK_MISMATCH

public static final FailureCode LOCK_MISMATCH

LOCK_MISMATCH : FailureCode.

EXISTS

public static final FailureCode EXISTS

EXISTS : FailureCode.

PRIVILEGES

public static final FailureCode PRIVILEGES

PRIVILEGES : FailureCode.

WC_UNSUPPORTED

public static final FailureCode WC_UNSUPPORTED

WC_UNSUPPORTED : FailureCode.

CYCLE

public static final FailureCode CYCLE

CYCLE : FailureCode.

NOT_FOUND

public static final FailureCode NOT_FOUND

NOT_FOUND : FailureCode.

INVALID

public static final FailureCode INVALID

INVALID : FailureCode.

Method Detail

values

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

Returns:

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

valueOf

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