Package com.storedobject.core

Class DecimalNumber

java.lang.Object

com.storedobject.core.DecimalNumber

All Implemented Interfaces:

Storable, Comparable<DecimalNumber>

Direct Known Subclasses:

Rate

public class DecimalNumber
extends Object
implements Storable, Comparable<DecimalNumber>

Class that represents a decimal number value with a defined number of decimals digits. This class is immutable.

Author:

Syam

Field Summary

Fields

Modifier and Type	Field	Description
protected BigDecimal	value
static final DecimalNumber	ZERO

Constructor Summary

Constructors

Constructor	Description
DecimalNumber()	Create a decimal number of value 0 with 2 decimal digits.
DecimalNumber(int decimals)	Create a decimal number of value 0.
DecimalNumber(DecimalNumber number)	Construct a decimal number from another one.
DecimalNumber(String value)	Create a decimal number.
DecimalNumber(String value, int decimals)	Create a decimal number.
DecimalNumber(BigDecimal value)	Construct a decimal number from a BigDecimal.
DecimalNumber(BigDecimal value, int decimals)	Construct a decimal number from a BigDecimal.

Method Summary

Modifier and Type	Method	Description
void	checkLimit(String name, int width)
int	compareTo(DecimalNumber number)
static DecimalNumber	create(Object value)
static DecimalNumber	create(Object value, int decimals)
boolean	equals(Object another)
BigDecimal	getAverageValue(DecimalNumber second)
BigDecimal	getAverageValue(BigDecimal second)
int	getDecimals()
String	getStorableValue()	Get the storable value.
BigDecimal	getValue()	Get the decimal number as BigDecimal.
int	hashCode()
boolean	isZero()
String	toString()
String	toString(int decimals)	Convert it into a String with at least minimum decimals places specified.
DecimalNumber	zero()
static DecimalNumber	zero(int decimals)

Methods inherited from class java.lang.Object

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

Field Details

ZERO

public static final DecimalNumber ZERO

value

protected BigDecimal value

Constructor Details

DecimalNumber

public DecimalNumber()

Create a decimal number of value 0 with 2 decimal digits.

DecimalNumber

public DecimalNumber(int decimals)

Create a decimal number of value 0.

Parameters:

decimals - Number of decimal places

DecimalNumber

public DecimalNumber(String value)

Create a decimal number. Number of decimal places will be taken from what is defined in the value.

Parameters:

value - The value

DecimalNumber

public DecimalNumber(String value,
 int decimals)

Create a decimal number.

Parameters:

value - The value

decimals - Number of decimal places

DecimalNumber

public DecimalNumber(DecimalNumber number)

Construct a decimal number from another one.

Parameters:

number - The decimal number to be set.

DecimalNumber

public DecimalNumber(BigDecimal value)

Construct a decimal number from a BigDecimal. Number of decimal places will be taken from what is defined in the value.

Parameters:

value - The BigDecimal value.

DecimalNumber

public DecimalNumber(BigDecimal value,
 int decimals)

Construct a decimal number from a BigDecimal.

Parameters:

value - The BigDecimal value.

decimals - Number of decimal places

Method Details

create

public static DecimalNumber create(Object value)

create

public static DecimalNumber create(Object value,
 int decimals)

zero

public static DecimalNumber zero(int decimals)

getValue

public BigDecimal getValue()

Get the decimal number as BigDecimal.

Returns:

The value.

equals

public boolean equals(Object another)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

toString

public String toString(int decimals)

Convert it into a String with at least minimum decimals places specified.

Example: Value: 4123.4500, Output: "4123.4500" (if decimals is les than zero, no conversion), "4123.450000" (for 6 decimals), "4123.45" (for 2 decimals or less)

Example: Value: 4123.0000, Output: "4123.0000" (if decimals is les than zero, no conversion), "4123.000000" (for 6 decimals), "4123.00" (for 2 decimals), "4123" (if decimals is zero)

Parameters:

decimals - Number of minimum decimals required in the output.

Returns:

String value.

getStorableValue

public String getStorableValue()

Description copied from interface: Storable

Get the storable value. By default, Object.toString() is returned.

Specified by:

getStorableValue in interface Storable

Returns:

Storable value as a string.

compareTo

public int compareTo(DecimalNumber number)

Specified by:

compareTo in interface Comparable<DecimalNumber>

isZero

public boolean isZero()

getDecimals

public int getDecimals()

zero

public DecimalNumber zero()

checkLimit

public void checkLimit(String name,
 int width)
                throws Invalid_Value

Throws:

Invalid_Value

getAverageValue

public BigDecimal getAverageValue(DecimalNumber second)

getAverageValue

public BigDecimal getAverageValue(BigDecimal second)