net.namibsun.papio.lib.money

Class Value

net.namibsun.papio.lib.money.Value

public class Value

Class that models a generic monetary value. A Value object is immutable. All changing operations yield a new Value object and do not affect the original object.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Value.Companion Contains static methods

Field Summary

Fields

Modifier and Type	Field and Description
static Value.Companion	Companion Contains static methods

Constructor Summary

Constructors

Constructor and Description
Value(java.math.BigDecimal value, Currency currency) Class that models a generic monetary value. A Value object is immutable. All changing operations yield a new Value object and do not affect the original object.
Value(java.lang.String value, Currency currency) Generates a Value object from a String and a currency.

Method Summary

Modifier and Type	Method and Description
java.math.BigDecimal	component1() :
Currency	component2() :
Value	convert(Currency currency) Converts this Value to another currency
Value	copy(java.math.BigDecimal value, Currency currency) Class that models a generic monetary value. A Value object is immutable. All changing operations yield a new Value object and do not affect the original object.
boolean	equals(java.lang.Object other) Overrides the data class equals method to use the compareTo instead of equals method of the BigDecimal class. This ensures that 0.00 and 0.0 are treated the same.
java.lang.String	format(boolean useCurrencySymbol, java.lang.String decimalSymbol, boolean currencySymbolPositionBack, java.lang.Integer overrideAccuracy) Formats the value into a configurable human-readable String
Currency	getCurrency() :
java.math.BigDecimal	getValue() :
int	hashCode()
Value	minus(Value value) Subtracts a value from this value and returns the result
Value	not() Negates the value of this Value object. Equivalent to multiplying with -1
Value	plus(Value value) Adds two Values and returns the sum
java.lang.String	serialize() Serializes the value
Value	times(int multiplicand) Multiplies the value by an integer value
java.lang.String	toString() Creates a string representation of the value that is automatically used in string interpolation

Field Detail

Companion

public static Value.Companion Companion

Contains static methods

Constructor Detail

Value

public Value(java.math.BigDecimal value,
             Currency currency)

Class that models a generic monetary value. A Value object is immutable. All changing operations yield a new Value object and do not affect the original object.

Parameters:

value - : The value of the Value as a BigDecimal, which allows arbitrary precision without rounding errors

currency - : The currency of the Value

value - : The value of the Value as a BigDecimal, which allows arbitrary precision without rounding errors

currency - : The currency of the Value

Value

public Value(java.lang.String value,
             Currency currency)

Generates a Value object from a String and a currency.

Parameters:

value - : The String to parse a value from

currency - : The currency of the value

Throws:

- : If the String does not contain a valid value

Method Detail

plus

public Value plus(Value value)

Adds two Values and returns the sum

Parameters:

value - : The value with which to create a sum with

Returns:

The sum of the two values

minus

public Value minus(Value value)

Subtracts a value from this value and returns the result

Parameters:

value - : The value to subtract from this value

Returns:

: The result of the subtraction

times

public Value times(int multiplicand)

Multiplies the value by an integer value

Parameters:

multiplicand - : The value with which to multiply this value

Returns:

: A new Value object whose value is the product of this value and the multiplicand

not

public Value not()

Negates the value of this Value object. Equivalent to multiplying with -1

Returns:

The negated value

equals

public boolean equals(java.lang.Object other)

Overrides the data class equals method to use the compareTo instead of equals method of the BigDecimal class. This ensures that 0.00 and 0.0 are treated the same.

Parameters:

other - : The object to compare to

Returns:

true if the objects are equal, false otherwise

convert

public Value convert(Currency currency)

Converts this Value to another currency

Parameters:

currency - : The currency to which to convert to

Returns:

The converted Value

format

public java.lang.String format(boolean useCurrencySymbol,
                               java.lang.String decimalSymbol,
                               boolean currencySymbolPositionBack,
                               java.lang.Integer overrideAccuracy)

Formats the value into a configurable human-readable String

Parameters:

useCurrencySymbol - : Specifies if the currency's symbol (e.g. €) should be used or the currency's name (EUR)

decimalSymbol - : The symbol to use as a decimal point. Defaults to a decimal point.

currencySymbolPositionBack - : Specifies if the currency symbol is displayed before or after the value

overrideAccuracy - : Overrides the inherent accuracy of a currency

toString

public java.lang.String toString()

Creates a string representation of the value that is automatically used in string interpolation

Returns:

The String representation of the value

serialize

public java.lang.String serialize()

Serializes the value

Returns:

The serialized String of the value

getValue

public java.math.BigDecimal getValue()

:

The value of the Value as a BigDecimal, which allows arbitrary precision without rounding errors

getCurrency

public Currency getCurrency()

:

The currency of the Value

component1

public java.math.BigDecimal component1()

:

The value of the Value as a BigDecimal, which allows arbitrary precision without rounding errors

component2

public Currency component2()

:

The currency of the Value

copy

public Value copy(java.math.BigDecimal value,
                  Currency currency)

Class that models a generic monetary value. A Value object is immutable. All changing operations yield a new Value object and do not affect the original object.

Parameters:

value - : The value of the Value as a BigDecimal, which allows arbitrary precision without rounding errors

currency - : The currency of the Value

hashCode

public int hashCode()