Package com.github.stefvanschie.inventoryframework.pane

Enum Pane.Priority

java.lang.Object

java.lang.Enum<Pane.Priority>

com.github.stefvanschie.inventoryframework.pane.Pane.Priority

All Implemented Interfaces:

Serializable, Comparable<Pane.Priority>, java.lang.constant.Constable

Enclosing class:

Pane

public static enum Pane.Priority
extends Enum<Pane.Priority>

An enum representing the rendering priorities for the panes. Uses a similar system to Bukkit's EventPriority system

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
HIGH	A higher priority, higher than default
HIGHEST	The highest priority for production use
LOW	A low priority, lower than default
LOWEST	The lowest priority, will be rendered first
MONITOR	The highest priority, will always be called last, should not be used for production code
NORMAL	A normal priority, the default

Method Summary

Modifier and Type	Method	Description
boolean	isGreaterThan(@NotNull Pane.Priority priority)	Whether this priority is greater than the priority specified.
abstract boolean	isLessThan(@NotNull Pane.Priority priority)	Whether this priority is less than the priority specified.
static Pane.Priority	valueOf(String name)	Returns the enum constant of this type with the specified name.
static Pane.Priority[]	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, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

LOWEST

public static final Pane.Priority LOWEST

The lowest priority, will be rendered first

LOW

public static final Pane.Priority LOW

A low priority, lower than default

NORMAL

public static final Pane.Priority NORMAL

A normal priority, the default

HIGH

public static final Pane.Priority HIGH

A higher priority, higher than default

HIGHEST

public static final Pane.Priority HIGHEST

The highest priority for production use

MONITOR

public static final Pane.Priority MONITOR

The highest priority, will always be called last, should not be used for production code

Method Details

values

public static Pane.Priority[] values()

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

Returns:

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

valueOf

public static Pane.Priority 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

isLessThan

@Contract(pure=true)
public abstract boolean isLessThan(@NotNull
 @NotNull Pane.Priority priority)

Whether this priority is less than the priority specified.

Parameters:

priority - the priority to compare against

Returns:

true if this priority is less than the specified priority, false otherwise

Since:

0.8.0

isGreaterThan

@Contract(pure=true)
public boolean isGreaterThan(@NotNull
 @NotNull Pane.Priority priority)

Whether this priority is greater than the priority specified.

Parameters:

priority - the priority to compare against

Returns:

true if this priority is greater than the specified priority, false otherwise

Since:

0.8.0