Class USDCurrency

java.lang.Object

net.okapia.osid.primordium.financials.spi.AbstractCurrency

net.okapia.osid.primordium.financials.USDCurrency

All Implemented Interfaces:

Serializable, Comparable<Currency>, Currency, OsidPrimitive, Currency, OsidPrimitive

public final class USDCurrency
extends AbstractCurrency
implements Currency

USD Currency with arbitrary precision. The amounts can be any decimal number greater than or equal to zero. A USDCurrency may have a Precision where input amounts are rounded to DOLLAR, CENT, or MILL. ARBITRARY Precision will leave the input amounts alone. A USDCurrency supports two output formats. One using the $ SYMBOL and the other using a USD suffix.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	USDCurrency.Format	Format is used to specify the output toString() format of a USD currency value.
static enum	USDCurrency.Precision	Precision is used to specify the rounding of input values to a USD currency.

Constructor Summary

Constructors

Constructor	Description
USDCurrency(BigDecimal amount)	Constructs a new USDCurrency.
USDCurrency(BigDecimal amount, USDCurrency.Precision precision, USDCurrency.Format format)	Constructs a new USDCurrency of the specified precision and format.

Method Summary

Modifier and Type	Method	Description
static Currency	currency(long cents)	Makes a USDCurrency from a number of cents.
static Currency	currency(String str)	Makes a USDCurrency from a string.
static Currency	currency(BigDecimal amount)	Makes a USDCurrency from a BigDecimal.
String	toString()	Returns a string representation of this Currency.
static Currency	valueOf(long cents)	Makes a USDCurrency from a number of cents.
static Currency	valueOf(long cents, USDCurrency.Format format)	Makes a USDCurrency from a number of cents.
static Currency	valueOf(String str)	Makes a USDCurrency from a string.
static Currency	valueOf(BigDecimal amount)	Makes a USDCurrency from a BigDecimal.
static Currency	valueOf(BigDecimal amount, USDCurrency.Format format)	Makes a USDCurrency from a BigDecimal.

Methods inherited from class AbstractCurrency

compare, compareTo, equals, getAmount, getCurrencyType, hashCode, isLarger, isSmaller

Modifier and Type	Method	Description
protected static int	compare(Currency currency1, Currency currency2)	Compares two Currencies for performing value comparisons.
int	compareTo(Currency currency)	Compares this currency with the specified Currency for order.
final boolean	equals(Object obj)	Determines if the given Currency is equal to this one.
final BigDecimal	getAmount()	Gets the total amount.
final Type	getCurrencyType()	Gets the currency type.
final int	hashCode()	Returns a hash code value for this Currency.
final boolean	isLarger(Currency currency)	Tests if this Currency is greater than the given Currency.
final boolean	isSmaller(Currency currency)	Tests if this Currency is less than the given Currency.

Methods inherited from class Object

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

Constructor Details

USDCurrency

public USDCurrency(BigDecimal amount)

Constructs a new USDCurrency. The default precision is Precision.CENT and default output format is Format.SYMBOL.

Parameters:

amount - the currency amount in cents

Throws:

InvalidArgumentException - amount is negative

NullArgumentException - amount is null

USDCurrency

public USDCurrency(BigDecimal amount,
 USDCurrency.Precision precision,
 USDCurrency.Format format)

Constructs a new USDCurrency of the specified precision and format.

Parameters:

amount - the currency amount in decimal dollars

precision - the precision

format - the output format

Throws:

InvalidArgumentException - amount is negative

NullArgumentException - amount, precision or format is null

Method Details

toString

@OSIDBinding
public String toString()

Returns a string representation of this Currency.

Specified by:

toString in interface OsidPrimitive

Overrides:

toString in class AbstractCurrency

Returns:

a string

currency

public static Currency currency(String str)

Makes a USDCurrency from a string. The Precision is based on the decimal places in the supplied string and the output format is determined by the symbols in the supplied string. Formats are:

• $D ($1,500)
• D USD (1,500 USD)
• $D.CC ($1,500.00)
• D.CC USD (1,500.00 USD)
• $D.CCCCC ($1,500.00000)
• D.CCCCC USD (1,500.00000 USD)

Parameters:

str - a string representation of the amount

Returns:

a Currency

Throws:

InvalidArgumentException - cannot parse str

NullArgumentException - str is null

See Also:

• valueOf(String)

valueOf

public static Currency valueOf(String str)

Makes a USDCurrency from a string. The Precision is based on the decimal places in the supplied string and the output format is determined by the symbols in the supplied string. Formats are:

• $D ($1,500)
• D USD (1,500 USD)
• $D.CC ($1,500.00)
• D.CC USD (1,500.00 USD)
• $D.CCCCC ($1,500.00000)
• D.CCCCC USD (1,500.00000 USD)

Parameters:

str - a string representation of the amount

Returns:

a Currency

Throws:

InvalidArgumentException - cannot parse str

NullArgumentException - str is null

See Also:

• currency(String)

valueOf

public static Currency valueOf(BigDecimal amount)

Makes a USDCurrency from a BigDecimal. The Precision is based on the scale of the BigDecimal and the output format is Format.SYMBOL.

Parameters:

amount - the currency amount

Returns:

a Currency

Throws:

InvalidArgumentException - amount is negative

NullArgumentException - amount is null

See Also:

• currency(java.math.BigDecimal)

currency

public static Currency currency(BigDecimal amount)

Makes a USDCurrency from a BigDecimal. The Precision is based on the scale of the BigDecimal and the output format is Format.SYMBOL.

Parameters:

amount - the currency amount

Returns:

a Currency

Throws:

InvalidArgumentException - amount is negative

NullArgumentException - amount is null

See Also:

• valueOf(java.math.BigDecimal)

valueOf

public static Currency valueOf(BigDecimal amount,
 USDCurrency.Format format)

Makes a USDCurrency from a BigDecimal. The Precision is based on the scale of the BigDecimal.

Parameters:

amount - the currency amount

format - the output format

Returns:

a Currency

Throws:

InvalidArgumentException - amount is negative

NullArgumentException - amount or format is null

valueOf

public static Currency valueOf(long cents)

Makes a USDCurrency from a number of cents. The Precision is set to Precision.CENT and the output format is Format.SYMBOL.

Parameters:

cents - the number of cents

Returns:

a Currency

Throws:

InvalidArgumentException - cents is negative

See Also:

• currency(long)

currency

public static Currency currency(long cents)

Makes a USDCurrency from a number of cents. The Precision is set to Precision.CENT and the output format is Format.SYMBOL.

Parameters:

cents - the number of cents

Returns:

a Currency

Throws:

InvalidArgumentException - cents is negative

See Also:

• valueOf(long)

valueOf

public static Currency valueOf(long cents,
 USDCurrency.Format format)

Makes a USDCurrency from a number of cents. The Precision is set to Precision.CENT.

Parameters:

cents - the currency cents

format - the output format

Returns:

a Currency

Throws:

InvalidArgumentException - cents is negative