org.decimal4j.truncate

Enum OverflowMode

java.lang.Object

java.lang.Enum<OverflowMode>

org.decimal4j.truncate.OverflowMode

All Implemented Interfaces:

Serializable, Comparable<OverflowMode>

public enum OverflowMode
extends Enum<OverflowMode>

Mode to apply if arithmetic operations cause an overflow.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CHECKED Operations causing an overflow throw an ArithmeticException.
UNCHECKED Operations causing an overflow silently return the truncated result (the low order bytes of the extended result); no exception is thrown.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	isChecked() Returns true if overflow leads to an ArithmeticException
static OverflowMode	valueOf(String name) Returns the enum constant of this type with the specified name.
static OverflowMode[]	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

UNCHECKED

public static final OverflowMode UNCHECKED

Operations causing an overflow silently return the truncated result (the low order bytes of the extended result); no exception is thrown.

CHECKED

public static final OverflowMode CHECKED

Operations causing an overflow throw an ArithmeticException.

Method Detail

values

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

Returns:

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

valueOf

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

isChecked

public final boolean isChecked()

Returns true if overflow leads to an ArithmeticException

Returns:

true if this == CHECKED