Module io.github.tonywasher.joceanus.oceanus

Package io.github.tonywasher.joceanus.oceanus.decimal

Class OceanusPrice

java.lang.Object

io.github.tonywasher.joceanus.oceanus.decimal.OceanusDecimal

io.github.tonywasher.joceanus.oceanus.decimal.OceanusMoney

io.github.tonywasher.joceanus.oceanus.decimal.OceanusPrice

All Implemented Interfaces:

Comparable<OceanusDecimal>

public class OceanusPrice
extends OceanusMoney

Represents a Price object.

Field Summary

Fields

Modifier and Type	Field	Description
(package private) static final int	XTRA_DECIMALS	Additional number of decimals for Price.

Fields inherited from class io.github.tonywasher.joceanus.oceanus.decimal.OceanusMoney

BYTE_LEN, DEFAULT_CURRENCY, ERROR_DIFFER

Fields inherited from class io.github.tonywasher.joceanus.oceanus.decimal.OceanusDecimal

MAX_DECIMALS, RADIX_TEN

Constructor Summary

Constructors

Constructor	Description
OceanusPrice()	Constructor for price of value zero in the default currency.
OceanusPrice(byte[] pBuffer)	Create the price from a byte array.
OceanusPrice(OceanusPrice pPrice)	Construct a new Price by copying another price.
OceanusPrice(String pSource)	Constructor for price from a decimal string.
OceanusPrice(String pSource, Currency pCurrency)	Constructor for price from a decimal string.
OceanusPrice(Currency pCurrency)	Constructor for money of value zero in specified currency.

Method Summary

Modifier and Type	Method	Description
OceanusPrice	changeCurrency(Currency pCurrency)	Obtain value in different currency.
OceanusPrice	convertCurrency(Currency pCurrency, OceanusRatio pRate)	Obtain converted money.
static OceanusPrice	getWholeUnits(long pUnits)	Factory method for generating whole monetary units (e.g. £)
static OceanusPrice	getWholeUnits(long pUnits, Currency pCurrency)	Factory method for generating whole monetary units for a currency (e.g. £)
void	subtractPrice(OceanusPrice pValue)	Subtract a monetary price from the value.

Methods inherited from class io.github.tonywasher.joceanus.oceanus.decimal.OceanusMoney

addAmount, addValue, equals, getCurrency, getDefaultCurrency, getDilutedMoney, grossValueAtRate, hashCode, subtractAmount, subtractValue, taxCreditAtRate, toBytes, valueAtRate, valueAtRatio, valueAtWeight, valueAtWeight

Methods inherited from class io.github.tonywasher.joceanus.oceanus.decimal.OceanusDecimal

add, adjustDecimals, adjustToScale, byteValue, byteValueExact, calculateProduct, calculateQuotient, calculateSafeQuotient, checkFractionalZero, compareTo, divide, divide, divideToIntegralValue, doubleValue, floatValue, getFactor, intValue, intValueExact, isNonZero, isPositive, isZero, longValue, longValueExact, max, min, movePointLeft, movePointRight, multiply, multiply, negate, recordScale, reduceScale, remainder, scale, setValue, setZero, shortValue, shortValueExact, signum, subtract, toBigDecimal, toBigInteger, toBigIntegerExact, toString, unscaledValue

Methods inherited from class java.lang.Object

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

Field Details

XTRA_DECIMALS

static final int XTRA_DECIMALS

Additional number of decimals for Price.

See Also:

• Constant Field Values

Constructor Details

OceanusPrice

public OceanusPrice()

Constructor for price of value zero in the default currency.

OceanusPrice

public OceanusPrice(Currency pCurrency)

Constructor for money of value zero in specified currency.

Parameters:

pCurrency - the currency

OceanusPrice

public OceanusPrice(OceanusPrice pPrice)

Construct a new Price by copying another price.

Parameters:

pPrice - the Price to copy

OceanusPrice

public OceanusPrice(String pSource)

Constructor for price from a decimal string.

Parameters:

pSource - The source decimal string

Throws:

IllegalArgumentException - on invalidly formatted argument

OceanusPrice

public OceanusPrice(String pSource,
 Currency pCurrency)

Constructor for price from a decimal string.

Parameters:

pSource - The source decimal string

pCurrency - the currency

Throws:

IllegalArgumentException - on invalidly formatted argument

OceanusPrice

public OceanusPrice(byte[] pBuffer)

Create the price from a byte array.

Parameters:

pBuffer - the buffer

Method Details

getWholeUnits

public static OceanusPrice getWholeUnits(long pUnits,
 Currency pCurrency)

Factory method for generating whole monetary units for a currency (e.g. £)

Parameters:

pUnits - the number of whole monetary units

pCurrency - the currency

Returns:

the allocated price

getWholeUnits

public static OceanusPrice getWholeUnits(long pUnits)

Factory method for generating whole monetary units (e.g. £)

Parameters:

pUnits - the number of whole monetary units

Returns:

the allocated price

changeCurrency

public OceanusPrice changeCurrency(Currency pCurrency)

Description copied from class: OceanusMoney

Obtain value in different currency.

Overrides:

changeCurrency in class OceanusMoney

Parameters:

pCurrency - the currency to convert to

Returns:

the converted money in the new currency

convertCurrency

public OceanusPrice convertCurrency(Currency pCurrency,
 OceanusRatio pRate)

Description copied from class: OceanusMoney

Obtain converted money.

Overrides:

convertCurrency in class OceanusMoney

Parameters:

pCurrency - the currency to convert to

pRate - the conversion rate

Returns:

the converted money in the new currency

subtractPrice

public void subtractPrice(OceanusPrice pValue)

Subtract a monetary price from the value.

Parameters:

pValue - The money to subtract from this one.