org.kuali.coeus.sys.api.model

Class ScaleTwoDecimal

java.lang.Object

java.lang.Number

org.kuali.coeus.sys.api.model.AbstractDecimal<ScaleTwoDecimal>

org.kuali.coeus.sys.api.model.ScaleTwoDecimal

All Implemented Interfaces:

Serializable, Comparable<ScaleTwoDecimal>

public final class ScaleTwoDecimal
extends AbstractDecimal<ScaleTwoDecimal>

This class is a wrapper around BigDecimal. It exposes the only the needed functionality of BigDecimal, uses a standard RoundingMode of RoundingMode.HALF_UP and uses a standard SCALE of 2. This class is, like BigDecimal, immutable; even methods which might be expected to change the value actually just return a new instance with the new value.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static ScaleTwoDecimal	ONE_HUNDRED
static int	SCALE
static ScaleTwoDecimal	ZERO

Fields inherited from class org.kuali.coeus.sys.api.model.AbstractDecimal

ROUND_BEHAVIOR, value

Constructor Summary

Constructors

Constructor and Description
ScaleTwoDecimal(BigDecimal value)
ScaleTwoDecimal(double value)
ScaleTwoDecimal(int value)
ScaleTwoDecimal(String value)

Method Summary

Methods

Modifier and Type	Method and Description
protected ScaleTwoDecimal	newInstance(BigDecimal value, int scale)
protected ScaleTwoDecimal	newInstance(int value)
protected ScaleTwoDecimal	oneHundred()
static ScaleTwoDecimal	returnZeroIfNull(ScaleTwoDecimal value) return ZERO if the object is null
protected ScaleTwoDecimal	zero()

Methods inherited from class org.kuali.coeus.sys.api.model.AbstractDecimal

abs, add, bigDecimalValue, compareTo, divide, doubleValue, equals, floatValue, hashCode, intValue, isGreaterEqual, isGreaterThan, isLessEqual, isLessThan, isNegative, isNonZero, isNumeric, isPositive, isZero, longValue, mod, multiply, negated, percentage, subtract, toString

Methods inherited from class java.lang.Number

byteValue, shortValue

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

SCALE

public static final int SCALE

See Also:

Constant Field Values

ZERO

public static final ScaleTwoDecimal ZERO

ONE_HUNDRED

public static final ScaleTwoDecimal ONE_HUNDRED

Constructor Detail

ScaleTwoDecimal

public ScaleTwoDecimal(String value)

ScaleTwoDecimal

public ScaleTwoDecimal(int value)

ScaleTwoDecimal

public ScaleTwoDecimal(double value)

ScaleTwoDecimal

public ScaleTwoDecimal(BigDecimal value)

Method Detail

newInstance

protected ScaleTwoDecimal newInstance(int value)

Specified by:

newInstance in class AbstractDecimal<ScaleTwoDecimal>

newInstance

protected ScaleTwoDecimal newInstance(BigDecimal value,
                          int scale)

Specified by:

newInstance in class AbstractDecimal<ScaleTwoDecimal>

zero

protected ScaleTwoDecimal zero()

Specified by:

zero in class AbstractDecimal<ScaleTwoDecimal>

oneHundred

protected ScaleTwoDecimal oneHundred()

Specified by:

oneHundred in class AbstractDecimal<ScaleTwoDecimal>

returnZeroIfNull

public static ScaleTwoDecimal returnZeroIfNull(ScaleTwoDecimal value)

return ZERO if the object is null

Parameters:

value - the passed in value or ZERO