Package io.github.thecsdev.betterstats.api.util.enumerations

Enum Class FilterSortCustomsBy

java.lang.Object

java.lang.Enum<FilterSortCustomsBy>

io.github.thecsdev.betterstats.api.util.enumerations.FilterSortCustomsBy

All Implemented Interfaces:

io.github.thecsdev.tcdcommons.api.util.interfaces.ITextProvider, Serializable, Comparable<FilterSortCustomsBy>, Constable

public enum FilterSortCustomsBy
extends Enum<FilterSortCustomsBy>
implements io.github.thecsdev.tcdcommons.api.util.interfaces.ITextProvider

A statistics filter Enum that dictates how SUGeneralStat statistics entries are sorted.

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
ALPHABETICAL	A-Z Sorts statistics entries in the alphabetical order, based on entry names.
DECREMENTAL	9-0 Sorts statistics entries based on the entry Integer values.
DEFAULT	Sorts statistics entries in the "default" order. This usually ends up displaying entries in the order their items are registered in their corresponding registries.
INCREMENTAL	0-9 Sorts statistics entries based on the entry Integer values.
LACITEBAHPLA	Z-A Sorts statistics entries in the reverse-alphabetical order, based on entry names.

Method Summary

Modifier and Type	Method	Description
final net.minecraft.text.Text	getText()
final void	sortGeneralStats(List<SUGeneralStat> stats)	Sorts a List<SUGeneralStat> based on this FilterSortCustomsBy.
static final void	sortGeneralStats(List<SUGeneralStat> stats, FilterSortCustomsBy sortBy)	Sorts a List<SUGeneralStat> based on FilterSortCustomsBy.
final void	sortPlayerBadgeStats(List<SUPlayerBadgeStat> stats)	Sorts a List<SUPlayerBadgeStat> based on this FilterSortCustomsBy.
static final void	sortPlayerBadgeStats(List<SUPlayerBadgeStat> stats, FilterSortCustomsBy sortBy)	Sorts a List<SUPlayerBadgeStat> based on FilterSortCustomsBy.
final void	sortPlayerBadgeStats(Map<?,List<SUPlayerBadgeStat>> stats)	Sorts a Map of SUPlayerBadgeStats based on this FilterSortCustomsBy.
static final void	sortPlayerBadgeStats(Map<?,List<SUPlayerBadgeStat>> stats, FilterSortCustomsBy sortBy)	Sorts a Map of SUPlayerBadgeStats based on FilterSortCustomsBy.
final <E extends SUStat<?>> void	sortStats(List<E> stats, Function<E,Integer> valueSupplier)	Sorts a List<SUStat> based on FilterSortCustomsBy.
static final <E extends SUStat<?>> void	sortStats(List<E> stats, Function<E,Integer> valueSupplier, FilterSortCustomsBy sortBy)	Sorts a List<SUStat> based on FilterSortCustomsBy.
static FilterSortCustomsBy	valueOf(String name)	Returns the enum constant of this class with the specified name.
static FilterSortCustomsBy[]	values()	Returns an array containing the constants of this enum class, 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

DEFAULT

public static final FilterSortCustomsBy DEFAULT

Sorts statistics entries in the "default" order.
This usually ends up displaying entries in the order their items are registered in their corresponding registries.

ALPHABETICAL

public static final FilterSortCustomsBy ALPHABETICAL

A-Z
Sorts statistics entries in the alphabetical order, based on entry names.

LACITEBAHPLA

public static final FilterSortCustomsBy LACITEBAHPLA

Z-A
Sorts statistics entries in the reverse-alphabetical order, based on entry names.

INCREMENTAL

public static final FilterSortCustomsBy INCREMENTAL

0-9
Sorts statistics entries based on the entry Integer values.

DECREMENTAL

public static final FilterSortCustomsBy DECREMENTAL

9-0
Sorts statistics entries based on the entry Integer values.

Method Details

values

public static FilterSortCustomsBy[] 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 FilterSortCustomsBy 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

getText

public final net.minecraft.text.Text getText()

Specified by:

getText in interface io.github.thecsdev.tcdcommons.api.util.interfaces.ITextProvider

sortStats

public final <E extends SUStat<?>> void sortStats(List<E> stats,
 Function<E,Integer> valueSupplier)

Sorts a List<SUStat> based on FilterSortCustomsBy.

Parameters:

stats - The List<SUStat> to sort.

valueSupplier - The Function that supplies the Integer value of a given SUStat.

sortGeneralStats

public final void sortGeneralStats(List<SUGeneralStat> stats)

Sorts a List<SUGeneralStat> based on this FilterSortCustomsBy.

Parameters:

stats - The List<SUGeneralStat> to sort.

sortPlayerBadgeStats

public final void sortPlayerBadgeStats(Map<?,List<SUPlayerBadgeStat>> stats)

Sorts a Map of SUPlayerBadgeStats based on this FilterSortCustomsBy.

Parameters:

stats - The Map of SUPlayerBadgeStats to sort.

sortPlayerBadgeStats

public final void sortPlayerBadgeStats(List<SUPlayerBadgeStat> stats)

Sorts a List<SUPlayerBadgeStat> based on this FilterSortCustomsBy.

Parameters:

stats - The List<SUPlayerBadgeStat> to sort.

sortStats

public static final <E extends SUStat<?>> void sortStats(List<E> stats,
 Function<E,Integer> valueSupplier,
 FilterSortCustomsBy sortBy)

Sorts a List<SUStat> based on FilterSortCustomsBy.

Parameters:

stats - The List<SUStat> to sort.

valueSupplier - The Function that supplies the Integer value of a given SUStat.

sortBy - The FilterSortCustomsBy.

sortGeneralStats

public static final void sortGeneralStats(List<SUGeneralStat> stats,
 FilterSortCustomsBy sortBy)

Sorts a List<SUGeneralStat> based on FilterSortCustomsBy.

Parameters:

stats - The List<SUGeneralStat> to sort.

sortBy - The FilterSortCustomsBy.

sortPlayerBadgeStats

public static final void sortPlayerBadgeStats(Map<?,List<SUPlayerBadgeStat>> stats,
 FilterSortCustomsBy sortBy)

Sorts a Map of SUPlayerBadgeStats based on FilterSortCustomsBy.

Parameters:

stats - The Map of SUPlayerBadgeStats to sort.

sortBy - The FilterSortCustomsBy.

sortPlayerBadgeStats

public static final void sortPlayerBadgeStats(List<SUPlayerBadgeStat> stats,
 FilterSortCustomsBy sortBy)

Sorts a List<SUPlayerBadgeStat> based on FilterSortCustomsBy.

Parameters:

stats - The List<SUPlayerBadgeStat> to sort.

sortBy - The FilterSortCustomsBy.