com.alpineclient.plugin.api.objects

Enum Capability

java.lang.Object

java.lang.Enum<Capability>

com.alpineclient.plugin.api.objects.Capability

All Implemented Interfaces:

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

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

Describes a capability of the server. The client will either enable or disable functionality when capabilities are communicated to it directly after the handshake.

Since:

1.3.0

Enum Constant Summary

Enum Constants

Enum Constant and Description
COOLDOWNS The client should enable the cooldowns module as the server intends to use it.

Method Summary

Modifier and Type	Method and Description
static @Nullable Capability	fromId(@NotNull java.lang.String id)
@NotNull java.lang.String	getId()
static Capability	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Capability[]	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

COOLDOWNS

public static final Capability COOLDOWNS

The client should enable the cooldowns module as the server intends to use it.

Method Detail

values

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

Returns:

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

valueOf

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

getId

@NotNull
public @NotNull java.lang.String getId()

fromId

@ApiStatus.Internal
 @Nullable
public static @Nullable Capability fromId(@NotNull
                                                                         @NotNull java.lang.String id)