Package alexiil.mc.lib.attributes.fluid.amount

Enum Class FluidAmount.FluidMergeRounding

java.lang.Object

java.lang.Enum<FluidAmount.FluidMergeRounding>

alexiil.mc.lib.attributes.fluid.amount.FluidAmount.FluidMergeRounding

All Implemented Interfaces:

Serializable, Comparable<FluidAmount.FluidMergeRounding>, Constable

Enclosing class:

FluidAmount

public static enum FluidAmount.FluidMergeRounding
extends Enum<FluidAmount.FluidMergeRounding>

Specifies how merged FluidAmount's should handle rounding.

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
FAIL	Specifies that any fluid amounts that don't completely fit together should fail.
MAXIMUM_POSSIBLE	Move only an amount which can be validly moved, leaving the rest in the source.
ROUND_CEILING	Always empty the source, but leave the target with (potentially) slightly different amount fluid than the exact sum of the two volumes.
ROUND_DOWN	Always empty the source, but leave the target with (potentially) slightly less fluid than the exact sum of the two volumes.
ROUND_FLOOR	Always empty the source, but leave the target with (potentially) slightly different amount fluid than the exact sum of the two volumes.
ROUND_HALF_DOWN	Always empty the source, but leave the target with (potentially) slightly different amount of fluid than the exact sum of the two volumes.
ROUND_HALF_EVEN	Always empty the source, but leave the target with (potentially) slightly different amount of fluid than the exact sum of the two volumes.
ROUND_HALF_UP	Always empty the source, but leave the target with (potentially) slightly different amount of fluid than the exact sum of the two volumes.
ROUND_UNNECESSARY	Throw an ArithmeticException if the end result needs to be rounded.
ROUND_UP	Always empty the source, but leave the target with (potentially) slightly more fluid than the exact sum of the two volumes.

Field Summary

Fields

Modifier and Type	Field	Description
static final FluidAmount.FluidMergeRounding	DEFAULT
final RoundingMode	rounding	The rounding mode to use, or null if this requires special handling.

Method Summary

Modifier and Type	Method	Description
static FluidAmount.FluidMergeRounding	fromRounding(RoundingMode rounding)
static FluidAmount.FluidMergeRounding	valueOf(String name)	Returns the enum constant of this class with the specified name.
static FluidAmount.FluidMergeRounding[]	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

FAIL

public static final FluidAmount.FluidMergeRounding FAIL

Specifies that any fluid amounts that don't completely fit together should fail.

MAXIMUM_POSSIBLE

public static final FluidAmount.FluidMergeRounding MAXIMUM_POSSIBLE

Move only an amount which can be validly moved, leaving the rest in the source. (As such fluid will never be lost, but you might get some leftovers).

ROUND_UP

public static final FluidAmount.FluidMergeRounding ROUND_UP

Always empty the source, but leave the target with (potentially) slightly more fluid than the exact sum of the two volumes.

Use FluidAmount.safeAdd(FluidAmount, RoundingMode) with a RoundingMode of UP.

ROUND_DOWN

public static final FluidAmount.FluidMergeRounding ROUND_DOWN

Always empty the source, but leave the target with (potentially) slightly less fluid than the exact sum of the two volumes.

Use FluidAmount.safeAdd(FluidAmount, RoundingMode) with a RoundingMode of DOWN.

ROUND_CEILING

public static final FluidAmount.FluidMergeRounding ROUND_CEILING

Always empty the source, but leave the target with (potentially) slightly different amount fluid than the exact sum of the two volumes.

Use FluidAmount.safeAdd(FluidAmount, RoundingMode) with a RoundingMode of UP.

ROUND_FLOOR

public static final FluidAmount.FluidMergeRounding ROUND_FLOOR

Always empty the source, but leave the target with (potentially) slightly different amount fluid than the exact sum of the two volumes.

Use FluidAmount.safeAdd(FluidAmount, RoundingMode) with a RoundingMode of FLOOR.

ROUND_HALF_UP

public static final FluidAmount.FluidMergeRounding ROUND_HALF_UP

Always empty the source, but leave the target with (potentially) slightly different amount of fluid than the exact sum of the two volumes.

Use FluidAmount.safeAdd(FluidAmount, RoundingMode) with a RoundingMode of HALF_UP.

ROUND_HALF_DOWN

public static final FluidAmount.FluidMergeRounding ROUND_HALF_DOWN

Always empty the source, but leave the target with (potentially) slightly different amount of fluid than the exact sum of the two volumes.

Use FluidAmount.safeAdd(FluidAmount, RoundingMode) with a RoundingMode of HALF_DOWN.

ROUND_HALF_EVEN

public static final FluidAmount.FluidMergeRounding ROUND_HALF_EVEN

Always empty the source, but leave the target with (potentially) slightly different amount of fluid than the exact sum of the two volumes.

Use FluidAmount.safeAdd(FluidAmount, RoundingMode) with a RoundingMode of HALF_EVEN.

ROUND_UNNECESSARY

public static final FluidAmount.FluidMergeRounding ROUND_UNNECESSARY

Throw an ArithmeticException if the end result needs to be rounded.

Use FluidAmount.checkedAdd(FluidAmount).

Field Details

DEFAULT

public static final FluidAmount.FluidMergeRounding DEFAULT

rounding

@Nullable
public final RoundingMode rounding

The rounding mode to use, or null if this requires special handling.

Method Details

values

public static FluidAmount.FluidMergeRounding[] 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 FluidAmount.FluidMergeRounding 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

fromRounding

public static FluidAmount.FluidMergeRounding fromRounding(@Nullable
 RoundingMode rounding)