io.github.cottonmc.cotton.gui.widget.data

Enum InputResult

java.lang.Object

java.lang.Enum<InputResult>

io.github.cottonmc.cotton.gui.widget.data.InputResult

All Implemented Interfaces:

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

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

Specifies whether an input event was ignored or processed. Used for mouse input events.

Since:

4.0.0

Enum Constant Summary

Enum Constants

Enum Constant and Description
IGNORED
PROCESSED

Method Summary

Modifier and Type	Method and Description
static InputResult	of(boolean processed) Gets the corresponding input result for a processed boolean.
static InputResult	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static InputResult[]	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

PROCESSED

public static final InputResult PROCESSED

IGNORED

public static final InputResult IGNORED

Method Detail

values

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

Returns:

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

valueOf

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

of

public static InputResult of(boolean processed)

Gets the corresponding input result for a processed boolean.

Parameters:

processed - whether an input event was processed

Returns:

PROCESSED if true, IGNORED otherwise