Module interacto.java.api

Package io.github.interacto.command

Enum Command.RegistrationPolicy

java.lang.Object

java.lang.Enum<Command.RegistrationPolicy>

io.github.interacto.command.Command.RegistrationPolicy

All Implemented Interfaces:

Serializable, Comparable<Command.RegistrationPolicy>

Enclosing interface:

Command

public static enum Command.RegistrationPolicy
extends Enum<Command.RegistrationPolicy>

Defines the registration policy of the command.

Enum Constant Summary

Enum Constants

Enum Constant	Description
LIMITED	The command is registered in the cmd register.
NONE	The command is never registered.
UNLIMITED	The command is registered in the cmd register.

Method Summary

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

NONE

public static final Command.RegistrationPolicy NONE

The command is never registered.

UNLIMITED

public static final Command.RegistrationPolicy UNLIMITED

The command is registered in the cmd register. The cmd is not flushed when the registry wants to free some commands.

LIMITED

public static final Command.RegistrationPolicy LIMITED

The command is registered in the cmd register. The cmd can be flushed by the registry.

Method Detail

values

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

Returns:

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

valueOf

public static Command.RegistrationPolicy 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