org.decimal4j.truncate

Interface TruncationPolicy

All Known Implementing Classes:

CheckedRounding, UncheckedRounding

public interface TruncationPolicy

Policy defining how to handle truncation due to overflow or rounding. A TruncationPolicy is uniquely defined by the two elements overflow mode and rounding mode.

Truncation policies are are defined by UncheckedRounding and CheckedRounding. Some special truncation policies are also defined by

• DEFAULT
• VALUES
• UncheckedRounding.VALUES
• CheckedRounding.VALUES

Field Summary

Fields

Modifier and Type	Field and Description
static TruncationPolicy	DEFAULT Default truncation policy: UncheckedRounding.HALF_UP.
static Set<TruncationPolicy>	VALUES Unmodifiable set with all possible truncation policies.

Method Summary

Modifier and Type	Method and Description
OverflowMode	getOverflowMode() Returns the overflow mode which defines how to deal the situation when an operation that causes an overflow.
RoundingMode	getRoundingMode() Returns the rounding mode which defines how to deal the situation when an operation leads to truncation or rounding.

Field Detail

DEFAULT

static final TruncationPolicy DEFAULT

Default truncation policy: UncheckedRounding.HALF_UP.

VALUES

static final Set<TruncationPolicy> VALUES

Unmodifiable set with all possible truncation policies.

Method Detail

getOverflowMode

OverflowMode getOverflowMode()

Returns the overflow mode which defines how to deal the situation when an operation that causes an overflow.

Returns:

the mode to apply if an arithmetic operation causes an overflow

getRoundingMode

RoundingMode getRoundingMode()

Returns the rounding mode which defines how to deal the situation when an operation leads to truncation or rounding.

Returns:

the rounding mode indicating how the least significant returned digit of a rounded result is to be calculated