Package com.storedobject.core

Class Rate

java.lang.Object

com.storedobject.core.DecimalNumber

com.storedobject.core.Rate

All Implemented Interfaces:

Storable, Comparable<DecimalNumber>

public final class Rate
extends DecimalNumber

Class that represents a rate value such as currency rate etc. The default number of decimals is 6. It can not be zero or negative. This class is immutable.

Author:

Syam

Field Summary

Fields

Modifier and Type	Field	Description
static final Rate	ONE

Fields inherited from class com.storedobject.core.DecimalNumber

value, ZERO

Constructor Summary

Constructors

Constructor	Description
Rate()	Create a rate of value 1.
Rate(int decimals)	Create a rate of value 1 with given number of decimals.
Rate(Money from, Money to)	Construct a rate from the monetary values passed.
Rate(Rate rate)	Construct a rate from another one.
Rate(String value)	Create a rate.
Rate(String value, int decimals)	Create a rate with given number of decimals.
Rate(BigDecimal value)	Construct a rate from a BigDecimal.
Rate(BigDecimal value, int decimals)	Construct a rate from a BigDecimal with given number of decimals.
Rate(BigDecimal from, BigDecimal to)	Construct a rate from the values passed.

Method Summary

Modifier and Type	Method	Description
Rate	average(Rate second)
Rate	average(BigDecimal another)
void	checkLimit(String name, int width)
static Rate	create(Object value, int decimals)
boolean	isOne()
Rate	reverse()

Methods inherited from class com.storedobject.core.DecimalNumber

compareTo, create, equals, getAverageValue, getAverageValue, getDecimals, getStorableValue, getValue, hashCode, isZero, toString, toString, zero, zero

Methods inherited from class java.lang.Object

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

Field Details

ONE

public static final Rate ONE

Constructor Details

Rate

public Rate()

Create a rate of value 1.

Rate

public Rate(String value)

Create a rate.

Parameters:

value - The value

Rate

public Rate(Rate rate)

Construct a rate from another one.

Parameters:

rate - The rate to be set.

Rate

public Rate(BigDecimal value)

Construct a rate from a BigDecimal.

Parameters:

value - The BigDecimal value.

Rate

public Rate(int decimals)

Create a rate of value 1 with given number of decimals.

Parameters:

decimals - Decimal places

Rate

public Rate(String value,
 int decimals)

Create a rate with given number of decimals.

Parameters:

value - The value

decimals - Decimal places

Rate

public Rate(BigDecimal value,
 int decimals)

Construct a rate from a BigDecimal with given number of decimals.

Parameters:

value - The BigDecimal value.

decimals - Decimal places

Rate

public Rate(Money from,
 Money to)

Construct a rate from the monetary values passed.

Note: A rate is created by dividing "from" by "to". Only the values are considered, not the currency.

Parameters:

from - Monetary value.

to - Monetary value.

Rate

public Rate(BigDecimal from,
 BigDecimal to)

Construct a rate from the values passed.

Note: A rate is created by dividing "from" by "to".

Parameters:

from - Monetary value.

to - Monetary value.

Method Details

create

public static Rate create(Object value,
 int decimals)

checkLimit

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

Overrides:

checkLimit in class DecimalNumber

Throws:

Invalid_Value

isOne

public boolean isOne()

average

public Rate average(BigDecimal another)

average

public Rate average(Rate second)

reverse

public Rate reverse()