Class NumberType<N extends Number & Comparable<N>>

java.lang.Object

net.ixdarklord.coolcatcore.api.config.type.NumberType<N>

All Implemented Interfaces:

ConfigType<N>

public final class NumberType<N extends Number & Comparable<N>>
extends Object
implements ConfigType<N>

An int, long, float or double, optionally within a range. Out-of-range values are clamped when a file is read. A bounded number can be shown as a slider.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	NumberType.Kind<N extends Number & Comparable<N>>	One of the four number types: INT, LONG, FLOAT, DOUBLE.

Field Summary

Fields

Modifier and Type	Field	Description
static final NumberType.Kind<Double>	DOUBLE
static final NumberType.Kind<Float>	FLOAT
static final NumberType.Kind<Integer>	INT
static final NumberType.Kind<Long>	LONG

Method Summary

Modifier and Type	Method	Description
com.mojang.serialization.Codec<N>	codec()
List<net.minecraft.network.chat.Component>	describe()	The constraints in words, for the file's comments and the screen's tooltips ("Range: 0 ~ 10").
boolean	equals(Object other)
String	format(N value)	The value as a player would type it, the inverse of ConfigType.parse(String).
N	fromDouble(double value)	The number nearest to a double, clamped into the range.
int	hashCode()
boolean	isBounded()	Whether a range narrower than the whole type was set.
boolean	isIntegral()
boolean	isSlider()	Whether the config screen shows a slider rather than a text box.
NumberType.Kind<N>	kind()
N	max()
N	min()
ValidationResult<N>	parse(String text)	Reads a value typed by a player, and validates it.
ValidationResult<N>	validate(N value)	Checks a value, possibly correcting it.
NumberType<N>	withRange(N min, N max)
NumberType<N>	withSlider(boolean slider)

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface ConfigType

equals, suggestions

Field Details

INT

public static final NumberType.Kind<Integer> INT

LONG

public static final NumberType.Kind<Long> LONG

FLOAT

public static final NumberType.Kind<Float> FLOAT

DOUBLE

public static final NumberType.Kind<Double> DOUBLE

Method Details

kind

public NumberType.Kind<N> kind()

min

public N min()

max

public N max()

isSlider

public boolean isSlider()

Whether the config screen shows a slider rather than a text box.

isBounded

public boolean isBounded()

Whether a range narrower than the whole type was set.

isIntegral

public boolean isIntegral()

withRange

public NumberType<N> withRange(N min,
 N max)

withSlider

public NumberType<N> withSlider(boolean slider)

fromDouble

public N fromDouble(double value)

The number nearest to a double, clamped into the range.

codec

public com.mojang.serialization.Codec<N> codec()

Specified by:

codec in interface ConfigType<N extends Number & Comparable<N>>

validate

public ValidationResult<N> validate(N value)

Description copied from interface: ConfigType

Checks a value, possibly correcting it.

Specified by:

validate in interface ConfigType<N extends Number & Comparable<N>>

parse

public ValidationResult<N> parse(String text)

Description copied from interface: ConfigType

Reads a value typed by a player, and validates it. By default the text is JSON for the codec.

Specified by:

parse in interface ConfigType<N extends Number & Comparable<N>>

format

public String format(N value)

Description copied from interface: ConfigType

The value as a player would type it, the inverse of ConfigType.parse(String). By default compact JSON.

Specified by:

format in interface ConfigType<N extends Number & Comparable<N>>

describe

public List<net.minecraft.network.chat.Component> describe()

Description copied from interface: ConfigType

The constraints in words, for the file's comments and the screen's tooltips ("Range: 0 ~ 10").

Specified by:

describe in interface ConfigType<N extends Number & Comparable<N>>

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object