no.g9.support

Enum HookType

java.lang.Object

java.lang.Enum<HookType>

no.g9.support.HookType

All Implemented Interfaces:

Serializable, Comparable<HookType>

public enum HookType
extends Enum<HookType>

Used to document the hook type that is applicable for an action.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CHECKABLE Hooks that implement the checkable interface can be registered on this kind of actions.
CLEARABLE Hooks that implement the clearable interface can be registered on this kind of actions.
DISPLAYABLE Hooks that implement the displayable interface can be registered on this kind of actions.
HOOKABLE Hooks that implement the hookable interface can be registered on this kind of actions.
NONE No hooks can be registered on this action type
OBTAINABLE Hooks that implement the obtainable interface can be registered on this kind of actions.
PARAMETERIZED Actions of this kind can be parameterized by special hooks.

Field Summary

Fields

Modifier and Type	Field and Description
int	MASK The bit-mask value.

Method Summary

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

No hooks can be registered on this action type

HOOKABLE

public static final HookType HOOKABLE

Hooks that implement the hookable interface can be registered on this kind of actions.

CHECKABLE

public static final HookType CHECKABLE

Hooks that implement the checkable interface can be registered on this kind of actions.

OBTAINABLE

public static final HookType OBTAINABLE

Hooks that implement the obtainable interface can be registered on this kind of actions.

CLEARABLE

public static final HookType CLEARABLE

Hooks that implement the clearable interface can be registered on this kind of actions.

DISPLAYABLE

public static final HookType DISPLAYABLE

Hooks that implement the displayable interface can be registered on this kind of actions.

PARAMETERIZED

public static final HookType PARAMETERIZED

Actions of this kind can be parameterized by special hooks.

Field Detail

MASK

public final int MASK

The bit-mask value.

Method Detail

values

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

Returns:

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

valueOf

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