org.salespointframework.quantity

Interface RoundingStrategy

All Known Implementing Classes:

BasicRoundingStrategy

public interface RoundingStrategy

This is interface is implemented by classes, which are used to round numbers. Specifically, Quantity uses classes implementing RoundingStrategy to facilitate arithmetic operations.

Author:

Hannes Weisbach

Field Summary

Fields

Modifier and Type	Field and Description
static RoundingStrategy	MONETARY_ROUNDING Convenience instance, which can be used for monetary rounding.
static RoundingStrategy	ROUND_ONE Convenience instance, which can be used for rounding of integral types.

Method Summary

Modifier and Type	Method and Description
BigDecimal	round(BigDecimal amount) Rounds the given BigDecimal instance amount with a specific strategy.

Field Detail

MONETARY_ROUNDING

static final RoundingStrategy MONETARY_ROUNDING

Convenience instance, which can be used for monetary rounding. Rounds towards zero with 4 digits after the decimal delimiter.

ROUND_ONE

static final RoundingStrategy ROUND_ONE

Convenience instance, which can be used for rounding of integral types. Rounds towards zero, with 0 digits after the decimal delimiter.

Method Detail

round

BigDecimal round(BigDecimal amount)

Rounds the given BigDecimal instance amount with a specific strategy. Because BigDecimal is immutable, a new instance with a rounded value is returned.

Parameters:

amount - The BigDecimal instance which should be rounded.

Returns:

A new BigDecimal instance which has a rounded value.