Package cn.nukkit.api

Enum Class API.Usage

java.lang.Object

java.lang.Enum<API.Usage>

cn.nukkit.api.API.Usage

All Implemented Interfaces:

Serializable, Comparable<API.Usage>, Constable

Enclosing class:

API

public static enum API.Usage
extends Enum<API.Usage>

Enum constant for API usage. Indicates when to use this API element.

See Also:

• DEPRECATED
• INCUBATING
• BLEEDING
• EXPERIMENTAL
• MAINTAINED
• STABLE

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
BLEEDING	Intended for features in early development.
DEPRECATED	Should no longer be used, might disappear in the next minor release.
EXPERIMENTAL	Intended for new, experimental features where we are looking for feedback.
INCUBATING	Intended for features in drafts.
MAINTAINED	Intended for features that was tested, documented and at least stable for production use.
STABLE	Intended for features that was tested, documented and is preferred in production use.

Method Summary

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

DEPRECATED

public static final API.Usage DEPRECATED

Should no longer be used, might disappear in the next minor release.

INCUBATING

public static final API.Usage INCUBATING

Intended for features in drafts. Should only be used for tests.

Might contains notable new features, but will be moved to a new package before remarking to BLEEDING. Could be unsafe, might be removed without prior notice. Warnings will be send if used.

BLEEDING

public static final API.Usage BLEEDING

Intended for features in early development. Should only be used for tests.

Might be unwrapped, unsafe or have unchecked parameters. Further contribution was demanded to enhance, strengthen or simplify before remarking to EXPERIMENTAL. Might be removed or modified without prior notice.

EXPERIMENTAL

public static final API.Usage EXPERIMENTAL

Intended for new, experimental features where we are looking for feedback. At least stable for development.

Use with caution, might be remarked to MAINTAINED or STABLE in the future, but also might be removed without prior notice.

MAINTAINED

public static final API.Usage MAINTAINED

Intended for features that was tested, documented and at least stable for production use.

These features will not be modified in a backwards-incompatible way for at least next minor release of the current major version. Will be remarked to DEPRECATED first if scheduled for removal.

STABLE

public static final API.Usage STABLE

Intended for features that was tested, documented and is preferred in production use.

Will not be changed in a backwards-incompatible way in the current version.

Method Details

values

public static API.Usage[] 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 API.Usage 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