org.kuali.kra.budget

Class BudgetDecimal

java.lang.Object

java.lang.Number

org.kuali.rice.core.api.util.type.AbstractKualiDecimal<BudgetDecimal>

org.kuali.kra.budget.BudgetDecimal

All Implemented Interfaces:

Serializable, Comparable

public class BudgetDecimal
extends org.kuali.rice.core.api.util.type.AbstractKualiDecimal<BudgetDecimal>

This class is a wrapper around java.math.BigDecimal. It exposes the only the needed functionality of BigDecimal and uses a standard SCALE of 2 and ROUND_BEHAVIOR of BigDecimal.ROUND_HALF_UP Members of this class are, like BigDecimal, immutable; even methods which might be expected to change the value (like setScale, for example) actually just return a new instance with the new value.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	SCALE
static BudgetDecimal	ZERO

Fields inherited from class org.kuali.rice.core.api.util.type.AbstractKualiDecimal

ROUND_BEHAVIOR, value

Constructor Summary

Constructors

Modifier	Constructor and Description
	BudgetDecimal(BigDecimal value)
protected	BudgetDecimal(BigDecimal value, int scale)
	BudgetDecimal(double value)
protected	BudgetDecimal(double value, int scale)
	BudgetDecimal(int value)
protected	BudgetDecimal(int value, int scale)
	BudgetDecimal(String value) This is the base constructor, used by constructors that take other types
protected	BudgetDecimal(String value, int scale)

Method Summary

Methods

Modifier and Type	Method and Description
BudgetDecimal	divide(BudgetDecimal divisor)
float	getFloatValue() This method calls the floatValue() funciton.
BudgetDecimal	multiply(BudgetDecimal multiplier)
protected BudgetDecimal	newInstance(BigDecimal value)
protected BudgetDecimal	newInstance(BigDecimal value, int scale)
protected BudgetDecimal	newInstance(double value)
protected BudgetDecimal	newInstance(double value, int scale)
protected BudgetDecimal	newInstance(String value)
BudgetDecimal	percentage(BudgetDecimal rate)
static BudgetDecimal	returnZeroIfNull(BudgetDecimal value) return ZERO if the object is null
BudgetDecimal	setScale()
BudgetDecimal	setScale(int scale)

Methods inherited from class org.kuali.rice.core.api.util.type.AbstractKualiDecimal

abs, add, bigDecimalValue, compareTo, compareTo, divide, doubleValue, equals, floatValue, hashCode, intValue, isGreaterEqual, isGreaterThan, isLessEqual, isLessThan, isNegative, isNonZero, isNumeric, isPositive, isZero, longValue, mod, mod, multiply, negated, 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 BudgetDecimal ZERO

Constructor Detail

BudgetDecimal

public BudgetDecimal(String value)

This is the base constructor, used by constructors that take other types

Parameters:

value - String containing numeric value

Throws:

IllegalArgumentException - if the given String is null

BudgetDecimal

public BudgetDecimal(int value)

BudgetDecimal

public BudgetDecimal(double value)

BudgetDecimal

public BudgetDecimal(BigDecimal value)

BudgetDecimal

protected BudgetDecimal(String value,
             int scale)

BudgetDecimal

protected BudgetDecimal(int value,
             int scale)

BudgetDecimal

protected BudgetDecimal(double value,
             int scale)

BudgetDecimal

protected BudgetDecimal(BigDecimal value,
             int scale)

Method Detail

percentage

public BudgetDecimal percentage(BudgetDecimal rate)

setScale

public BudgetDecimal setScale()

setScale

public BudgetDecimal setScale(int scale)

divide

public BudgetDecimal divide(BudgetDecimal divisor)

Overrides:

divide in class org.kuali.rice.core.api.util.type.AbstractKualiDecimal<BudgetDecimal>

multiply

public BudgetDecimal multiply(BudgetDecimal multiplier)

Overrides:

multiply in class org.kuali.rice.core.api.util.type.AbstractKualiDecimal<BudgetDecimal>

newInstance

protected BudgetDecimal newInstance(String value)

Specified by:

newInstance in class org.kuali.rice.core.api.util.type.AbstractKualiDecimal<BudgetDecimal>

newInstance

protected BudgetDecimal newInstance(double value)

Specified by:

newInstance in class org.kuali.rice.core.api.util.type.AbstractKualiDecimal<BudgetDecimal>

newInstance

protected BudgetDecimal newInstance(double value,
                        int scale)

Specified by:

newInstance in class org.kuali.rice.core.api.util.type.AbstractKualiDecimal<BudgetDecimal>

newInstance

protected BudgetDecimal newInstance(BigDecimal value)

Specified by:

newInstance in class org.kuali.rice.core.api.util.type.AbstractKualiDecimal<BudgetDecimal>

newInstance

protected BudgetDecimal newInstance(BigDecimal value,
                        int scale)

Specified by:

newInstance in class org.kuali.rice.core.api.util.type.AbstractKualiDecimal<BudgetDecimal>

returnZeroIfNull

public static BudgetDecimal returnZeroIfNull(BudgetDecimal value)

return ZERO if the object is null

Parameters:

BudgetDecimal -

getFloatValue

public float getFloatValue()

This method calls the floatValue() funciton. It is needed so the TAGs can call this function.

Returns: