com.scvngr.levelup.core.annotation

Enum LevelUpApi.Contract

java.lang.Object

java.lang.Enum<LevelUpApi.Contract>

com.scvngr.levelup.core.annotation.LevelUpApi.Contract

All Implemented Interfaces:

Serializable, Comparable<LevelUpApi.Contract>

Enclosing class:

LevelUpApi

public static enum LevelUpApi.Contract
extends Enum<LevelUpApi.Contract>

Documents the intended visibility.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DRAFT This is a draft public API that may change.
ENTERPRISE This is an API that is only available to clients in the LevelUp Enterprise Program.
INTERNAL This is a non-public API that is used internally within the LevelUp SDK.
PUBLIC This is a final public API.

Method Summary

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

PUBLIC

public static final LevelUpApi.Contract PUBLIC

This is a final public API.

This API is unlikely to change in future versions of the SDK.

DRAFT

public static final LevelUpApi.Contract DRAFT

This is a draft public API that may change.

INTERNAL

public static final LevelUpApi.Contract INTERNAL

This is a non-public API that is used internally within the LevelUp SDK. Clients of the SDK should not use APIs annotated with this.

ENTERPRISE

public static final LevelUpApi.Contract ENTERPRISE

This is an API that is only available to clients in the LevelUp Enterprise Program.

Method Detail

values

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

Returns:

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

valueOf

public static LevelUpApi.Contract 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