Package cn.nukkit.api

Enum Class API.Definition

java.lang.Object

java.lang.Enum<API.Definition>

cn.nukkit.api.API.Definition

All Implemented Interfaces:

Serializable, Comparable<API.Definition>, Constable

Enclosing class:

API

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

Enum constant for API definition. Indicates which client platform this API element supports.

See Also:

• INTERNAL
• PLATFORM_NATIVE
• UNIVERSAL

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
INTERNAL	Intended for features should only be used by Nukkit itself.
PLATFORM_NATIVE	Intended for features only available on one or several client platforms.
UNIVERSAL	Intended for features implemented in all client platforms.

Method Summary

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

INTERNAL

public static final API.Definition INTERNAL

Intended for features should only be used by Nukkit itself. Should not be used in production.

PLATFORM_NATIVE

public static final API.Definition PLATFORM_NATIVE

Intended for features only available on one or several client platforms.

By using PLATFORM_NATIVE features, program will lose some cross-platform features provided. Might not available in some client platforms. Read the documents carefully before using this API element.

UNIVERSAL

public static final API.Definition UNIVERSAL

Intended for features implemented in all client platforms.

Preferred to use for production use, but sometimes be lack of platform-native features.

Method Details

values

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