Enum Class CompactPreviewOrder

java.lang.Object

java.lang.Enum<CompactPreviewOrder>

com.misterpemodder.shulkerboxtooltip.api.config.CompactPreviewOrder

All Implemented Interfaces:

Serializable, Comparable<CompactPreviewOrder>, Constable

public enum CompactPreviewOrder
extends Enum<CompactPreviewOrder>

The ordering strategy used for compact preview rendering.

Since:

5.3.0

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
PREVIEW_ORDER	Preserve the order of items as they appear in the container preview.
STACK_SIZE	Sort compact preview items by stack size, largest first.

Method Summary

Modifier and Type	Method	Description
Comparator<com.misterpemodder.shulkerboxtooltip.impl.util.MergedItemStack>	toComparator()	Returns the Comparator that implements this ordering strategy.
String	toString()
static CompactPreviewOrder	valueOf(String name)	Returns the enum constant of this class with the specified name.
static CompactPreviewOrder[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

STACK_SIZE

public static final CompactPreviewOrder STACK_SIZE

Sort compact preview items by stack size, largest first.

PREVIEW_ORDER

public static final CompactPreviewOrder PREVIEW_ORDER

Preserve the order of items as they appear in the container preview.

Method Details

values

public static CompactPreviewOrder[] values()

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

Returns:

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

valueOf

public static CompactPreviewOrder valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

toComparator

public Comparator<com.misterpemodder.shulkerboxtooltip.impl.util.MergedItemStack> toComparator()

Returns the Comparator that implements this ordering strategy.

Returns:

a comparator for MergedItemStack.

Since:

5.3.0

toString

public String toString()

Overrides:

toString in class Enum<CompactPreviewOrder>