org.javamoney.moneta

Class CurrencyUnitBuilder

java.lang.Object

org.javamoney.moneta.CurrencyUnitBuilder

public final class CurrencyUnitBuilder
extends Object

Builder for constructing new instances of BuildableCurrencyUnit using a fluent API.

Method Summary

Modifier and Type	Method and Description
javax.money.CurrencyUnit	build() Returns a new instance of BuildableCurrencyUnit.
javax.money.CurrencyUnit	build(boolean register) Returns a new instance of BuildableCurrencyUnit and publishes it so it is accessible from the MonetaryCurrencies singleton.
javax.money.CurrencyUnit	build(boolean register, Locale locale) Returns a new instance of BuildableCurrencyUnit and publishes it so it is accessible from the MonetaryCurrencies singleton.
static CurrencyUnitBuilder	of(String currencyCode, javax.money.CurrencyContext currencyContext) Creates a new CurrencyUnitBuilder.
static CurrencyUnitBuilder	of(String currencyCode, String providerName) Creates a new CurrencyUnitBuilder, creates a simple CurrencyContext using the given provider name.
CurrencyUnitBuilder	setCurrencyCode(String currencyCode) Allows to set the currency code, for creating multiple instances, using one Builder.
CurrencyUnitBuilder	setDefaultFractionDigits(int defaultFractionDigits) Set the default fraction digits.
CurrencyUnitBuilder	setNumericCode(int numericCode) Set the numeric code (optional).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

of

public static CurrencyUnitBuilder of(String currencyCode,
                                     javax.money.CurrencyContext currencyContext)

Creates a new CurrencyUnitBuilder.

Parameters:

currencyCode - the (unique) and identifying currency code, not null.

currencyContext - The currency context to be used.

of

public static CurrencyUnitBuilder of(String currencyCode,
                                     String providerName)

Creates a new CurrencyUnitBuilder, creates a simple CurrencyContext using the given provider name.

Parameters:

currencyCode - the (unique) and identifying currency code, not null.

providerName - the currency provider, not null.

setCurrencyCode

public CurrencyUnitBuilder setCurrencyCode(String currencyCode)

Allows to set the currency code, for creating multiple instances, using one Builder.

Parameters:

currencyCode - the (unique) and identifying currency code, not null.

Returns:

the Builder, for chaining.

See Also:

CurrencyUnit.getCurrencyCode()

setNumericCode

public CurrencyUnitBuilder setNumericCode(int numericCode)

Set the numeric code (optional).

Parameters:

numericCode - The numeric currency code, >= -1. .1 hereby means undefined.

Returns:

the Builder, for chaining.

See Also:

CurrencyUnit.getNumericCode()

setDefaultFractionDigits

public CurrencyUnitBuilder setDefaultFractionDigits(int defaultFractionDigits)

Set the default fraction digits.

Parameters:

defaultFractionDigits - the default fraction digits, >= 0.

Returns:

the Builder, for chaining.

See Also:

CurrencyUnit.getDefaultFractionDigits()

build

public javax.money.CurrencyUnit build()

Returns a new instance of BuildableCurrencyUnit.

Returns:

the new CurrencyUnit instance.

Throws:

javax.money.MonetaryException - if creation fails

build

public javax.money.CurrencyUnit build(boolean register)

Returns a new instance of BuildableCurrencyUnit and publishes it so it is accessible from the MonetaryCurrencies singleton.

Parameters:

register - if true the instance created is published so it is accessible from the MonetaryCurrencies singleton.

Returns:

the new CurrencyUnit instance.

See Also:

Monetary.getCurrency(String, String...)

build

public javax.money.CurrencyUnit build(boolean register,
                                      Locale locale)

Returns a new instance of BuildableCurrencyUnit and publishes it so it is accessible from the MonetaryCurrencies singleton.

Parameters:

register - if true the instance created is published so it is accessible from the MonetaryCurrencies singleton.

locale - country Locale for making the currency for the given country.

Returns:

the new CurrencyUnit instance.

See Also:

Monetary.getCurrency(String, String...), Monetary.getCurrency(java.util.Locale, String...)