net.uku3lig.ukulib.config

Enum Position

java.lang.Object

java.lang.Enum<Position>

net.uku3lig.ukulib.config.Position

All Implemented Interfaces:

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

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

An enum used to represent various positions. The actual position is implementation specific.

Enum Constant Summary

Enum Constants

Enum Constant and Description
BOTTOM_LEFT The bottom left of the screen.
BOTTOM_RIGHT The bottom right of the screen.
MIDDLE Above the experience bar, usually between the health and hunger bars.
TOP_LEFT The top left of the screen.
TOP_RIGHT The top right of the screen.

Method Summary

Modifier and Type	Method and Description
int	getId()
static ConfigOption<Position>	getOption(int id, java.util.Collection<Position> allowedValues, java.util.function.Supplier<Position> getter, java.util.function.Consumer<Position> setter) Creates a ConfigOption that allows to choose between all the allowedValues.
static ConfigOption<Position>	getOption(int id, java.util.function.Supplier<Position> getter, java.util.function.Consumer<Position> setter) Creates a ConfigOption that allows to choose between all of this enum's values.
java.lang.String	getText()
boolean	isBottom() Checks if the position is at the bottom of the screen.
boolean	isRight() Checks if the position is on the right of the screen.
static Position	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Position[]	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

TOP_LEFT

public static final Position TOP_LEFT

The top left of the screen.

TOP_RIGHT

public static final Position TOP_RIGHT

The top right of the screen.

BOTTOM_LEFT

public static final Position BOTTOM_LEFT

The bottom left of the screen.

BOTTOM_RIGHT

public static final Position BOTTOM_RIGHT

The bottom right of the screen.

MIDDLE

public static final Position MIDDLE

Above the experience bar, usually between the health and hunger bars.

Method Detail

values

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

Returns:

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

valueOf

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

isRight

public boolean isRight()

Checks if the position is on the right of the screen.

Returns:

true if the position is on the right of the screen

isBottom

public boolean isBottom()

Checks if the position is at the bottom of the screen.

Returns:

true if the position is at the bottom of the screen

getOption

public static ConfigOption<Position> getOption(int id,
                                               java.util.function.Supplier<Position> getter,
                                               java.util.function.Consumer<Position> setter)

Creates a ConfigOption that allows to choose between all of this enum's values.

Parameters:

getter - Gets the default value for the option

setter - The action to be performed when the value changes

Returns:

The generated option

See Also:

getOption(int, Collection, Supplier, Consumer)

getOption

public static ConfigOption<Position> getOption(int id,
                                               java.util.Collection<Position> allowedValues,
                                               java.util.function.Supplier<Position> getter,
                                               java.util.function.Consumer<Position> setter)

Creates a ConfigOption that allows to choose between all the allowedValues.

Parameters:

allowedValues - The values the option will cycle through

getter - Gets the default value for the option

setter - The action to be performed when the value changes

Returns:

The generated option

getId

public int getId()

getText

public java.lang.String getText()