org.decimal4j.truncate

Enum TruncatedPart

java.lang.Object

java.lang.Enum<TruncatedPart>

org.decimal4j.truncate.TruncatedPart

All Implemented Interfaces:

Serializable, Comparable<TruncatedPart>

public enum TruncatedPart
extends Enum<TruncatedPart>

Represents the truncated part for instance after division. It is passed to the rounding methods in DecimalRounding

Enum Constant Summary

Enum Constants

Enum Constant and Description
EQUAL_TO_HALF Truncated part t == 0.5.
GREATER_THAN_HALF Truncated part t > 0.5.
LESS_THAN_HALF_BUT_NOT_ZERO Truncated part 0 < t < 0.5.
ZERO Truncated part t == 0.

Method Summary

Modifier and Type	Method and Description
abstract boolean	isEqualToHalf() Returns true if the truncated part is equal to one half.
abstract boolean	isGreaterEqualHalf() Returns true if the truncated part is greater than or equal to one half.
abstract boolean	isGreaterThanHalf() Returns true if the truncated part is greater than one half.
abstract boolean	isGreaterThanZero() Returns true if the truncated part is greater than zero.
static TruncatedPart	valueOf(int firstTruncatedDigit, boolean zeroAfterFirstTruncatedDigit) Returns a truncated part constant given the first truncated digit and a boolean indicating whether there is non-zero digits after that.
static TruncatedPart	valueOf(String name) Returns the enum constant of this type with the specified name.
static TruncatedPart[]	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, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ZERO

public static final TruncatedPart ZERO

Truncated part t == 0.

LESS_THAN_HALF_BUT_NOT_ZERO

public static final TruncatedPart LESS_THAN_HALF_BUT_NOT_ZERO

Truncated part 0 < t < 0.5.

EQUAL_TO_HALF

public static final TruncatedPart EQUAL_TO_HALF

Truncated part t == 0.5.

GREATER_THAN_HALF

public static final TruncatedPart GREATER_THAN_HALF

Truncated part t > 0.5.

Method Detail

values

public static TruncatedPart[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (TruncatedPart c : TruncatedPart.values())
    System.out.println(c);

Returns:

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

valueOf

public static TruncatedPart 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

isGreaterThanZero

public abstract boolean isGreaterThanZero()

Returns true if the truncated part is greater than zero.

Returns:

true if this > 0

isEqualToHalf

public abstract boolean isEqualToHalf()

Returns true if the truncated part is equal to one half.

Returns:

true if this == 0.5

isGreaterEqualHalf

public abstract boolean isGreaterEqualHalf()

Returns true if the truncated part is greater than or equal to one half.

Returns:

true if this >= 0.5

isGreaterThanHalf

public abstract boolean isGreaterThanHalf()

Returns true if the truncated part is greater than one half.

Returns:

true if this > 0.5

valueOf

public static final TruncatedPart valueOf(int firstTruncatedDigit,
                                          boolean zeroAfterFirstTruncatedDigit)

Returns a truncated part constant given the first truncated digit and a boolean indicating whether there is non-zero digits after that.

Parameters:

firstTruncatedDigit - the first truncated digit, must be in [0, 1, ..., 9]

zeroAfterFirstTruncatedDigit - true if all truncated digits after the first truncated digit are zero, and false otherwise

Returns:

the truncated part constant equivalent to the given arguments