de.ipcon.tools

Enum SimpleRoundingMode

java.lang.Object

java.lang.Enum<SimpleRoundingMode>

de.ipcon.tools.SimpleRoundingMode

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<SimpleRoundingMode>

public enum SimpleRoundingMode
extends java.lang.Enum<SimpleRoundingMode>

Enumeration representing rounding modes.

This enum provides a mapping between string representations and their corresponding BigDecimal rounding modes.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CEILING Rounding mode to round towards positive infinity.
DOWN Rounding mode to round towards zero.
FLOOR Rounding mode to round towards negative infinity.
HALF_DOWN Rounding mode to round towards "nearest neighbor" unless both neighbors are equidistant, in which case round down.
HALF_EVEN Rounding mode to round towards the "nearest neighbor" unless both neighbors are equidistant, in which case, round towards the even neighbor.
HALF_UP Rounding mode to round towards "nearest neighbor" unless both neighbors are equidistant, in which case round up.
UP Rounding mode to round away from zero.

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.Map<java.lang.String,SimpleRoundingMode>	MODE_MAP An immutable map of rounding mode names (in uppercase) to their corresponding SimpleRoundingMode enum values.

Method Summary

Modifier and Type	Method and Description
static SimpleRoundingMode	fromString(java.lang.String modeString) Returns the SimpleRoundingMode associated with the given string representation, or null if no matching mode is found.
int	getMode() Returns the integer value representing the rounding mode.
static SimpleRoundingMode	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static SimpleRoundingMode[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

FLOOR

public static final SimpleRoundingMode FLOOR

Rounding mode to round towards negative infinity. Corresponds to BigDecimal.ROUND_FLOOR.

CEILING

public static final SimpleRoundingMode CEILING

Rounding mode to round towards positive infinity. Corresponds to BigDecimal.ROUND_CEILING.

DOWN

public static final SimpleRoundingMode DOWN

Rounding mode to round towards zero. Corresponds to BigDecimal.ROUND_DOWN.

UP

public static final SimpleRoundingMode UP

Rounding mode to round away from zero. Corresponds to BigDecimal.ROUND_UP.

HALF_DOWN

public static final SimpleRoundingMode HALF_DOWN

Rounding mode to round towards "nearest neighbor" unless both neighbors are equidistant, in which case round down. Corresponds to BigDecimal.ROUND_HALF_DOWN.

HALF_EVEN

public static final SimpleRoundingMode HALF_EVEN

Rounding mode to round towards the "nearest neighbor" unless both neighbors are equidistant, in which case, round towards the even neighbor. Corresponds to BigDecimal.ROUND_HALF_EVEN.

HALF_UP

public static final SimpleRoundingMode HALF_UP

Rounding mode to round towards "nearest neighbor" unless both neighbors are equidistant, in which case round up. Corresponds to BigDecimal.ROUND_HALF_UP.

Field Detail

MODE_MAP

public static final java.util.Map<java.lang.String,SimpleRoundingMode> MODE_MAP

An immutable map of rounding mode names (in uppercase) to their corresponding SimpleRoundingMode enum values. Used for efficient lookup of rounding modes from string representations.

Method Detail

values

public static SimpleRoundingMode[] 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 (SimpleRoundingMode c : SimpleRoundingMode.values())
    System.out.println(c);

Returns:

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

valueOf

public static SimpleRoundingMode valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getMode

public int getMode()

Returns the integer value representing the rounding mode.

Returns:

the rounding mode as an int value

fromString

public static SimpleRoundingMode fromString(java.lang.String modeString)

Returns the SimpleRoundingMode associated with the given string representation, or null if no matching mode is found. The comparison is case-insensitive.

Parameters:

modeString - the string representation of the rounding mode

Returns:

the SimpleRoundingMode, or null if not found