Module de.powerstat.validation

Package de.powerstat.validation.values

Class Currency

java.lang.Object

de.powerstat.validation.values.Currency

All Implemented Interfaces:

IValueObject, Comparable<Currency>

public final class Currency
extends Object
implements Comparable<Currency>, IValueObject

Currency ISO 4217 codes. Not DSGVO relevant. TODO Translations

Field Summary

Fields

Modifier and Type	Field	Description
private final String	code	ISO 4217 currency code.
private static final Pattern	CURRENCY_REGEXP	Currency regexp.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	Currency(String code)	Constructor.

Method Summary

Modifier and Type	Method	Description
int	compareTo(Currency obj)	Compare with another object.
boolean	equals(Object obj)	Is equal with another object.
int	hashCode()	Calculate hash code.
static Currency	of(String code)	Currency factory.
String	stringValue()	Returns the value of this Currency as a ISO 4217 string.
String	toString()	Returns the string representation of this Currency.

Methods inherited from class java.lang.Object

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

Field Details

CURRENCY_REGEXP

private static final Pattern CURRENCY_REGEXP

Currency regexp.

code

private final String code

ISO 4217 currency code.

Constructor Details

Currency

private Currency(String code)

Constructor.

Parameters:

code - ISO 4217 code

Throws:

NullPointerException - if code is null

IllegalArgumentException - if code is not a known 4217 code

Method Details

of

public static Currency of(String code)

Currency factory.

Parameters:

code - 4217 code

Returns:

Currency object

stringValue

public String stringValue()

Returns the value of this Currency as a ISO 4217 string.

Specified by:

stringValue in interface IValueObject

Returns:

The text value represented by this object after conversion to type string.

hashCode

public int hashCode()

Calculate hash code.

Overrides:

hashCode in class Object

Returns:

Hash

See Also:

• Object.hashCode()

equals

public boolean equals(Object obj)

Is equal with another object.

Overrides:

equals in class Object

Parameters:

obj - Object

Returns:

true when equal, false otherwise

See Also:

• Object.equals(java.lang.Object)

toString

public String toString()

Returns the string representation of this Currency. The exact details of this representation are unspecified and subject to change, but the following may be regarded as typical: "Currency[code=EUR]"

Overrides:

toString in class Object

Returns:

String representation of this Currency

See Also:

• Object.toString()

compareTo

public int compareTo(Currency obj)

Compare with another object.

Specified by:

compareTo in interface Comparable<Currency>

Parameters:

obj - Object to compare with

Returns:

0: equal; 1: greater; -1: smaller

See Also:

• Comparable.compareTo(java.lang.Object)