Module java.money

Package javax.money.format

Class AmountFormatContextBuilder

java.lang.Object

javax.money.AbstractContextBuilder<AmountFormatContextBuilder,AmountFormatContext>

javax.money.format.AmountFormatContextBuilder

public final class AmountFormatContextBuilder
extends AbstractContextBuilder<AmountFormatContextBuilder,AmountFormatContext>

Builder class for creating new instances of AmountFormatContext adding detailed information about a MonetaryAmountFormat instance.

Note this class is NOT thread-safe.

See Also:

MonetaryAmountFormat.getContext()

Method Summary

Modifier and Type	Method	Description
AmountFormatContext	build()	Creates a new instance of AmountFormatContext that configures a .MonetaryAmountFormat.
static AmountFormatContextBuilder	create(AmountFormatQuery formatQuery)	Creates a new AmountFormatContextBuilder.
static AmountFormatContextBuilder	of(java.lang.String formatName)	Creates a new AmountFormatContextBuilder.
static AmountFormatContextBuilder	of(java.util.Locale locale)	Creates a new default AmountFormatContextBuilder for a formatter based on the locale specific defaults.
static AmountFormatContextBuilder	of(AmountFormatContext context)	Creates a new AmountFormatContextBuilder.
AmountFormatContextBuilder	setFormatName(java.lang.String formatName)	Sets a format's name.
AmountFormatContextBuilder	setLocale(java.util.Locale locale)	Sets a Locale to be applied.
AmountFormatContextBuilder	setMonetaryAmountFactory(MonetaryAmountFactory monetaryAmountBuilder)	Sets the MonetaryContext to be used, when amount's are parsed.

Methods inherited from class javax.money.AbstractContextBuilder

importContext, importContext, removeAttributes, set, set, set, set, set, set, set, set, set, setProviderName, toString

Methods inherited from class java.lang.Object

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

Method Details

setFormatName

public AmountFormatContextBuilder setFormatName(java.lang.String formatName)

Sets a format's name.

Parameters:

formatName - the formatName, not null.

Returns:

the Builder, for chaining.

setLocale

public AmountFormatContextBuilder setLocale(java.util.Locale locale)

Sets a Locale to be applied.

Parameters:

locale - the locale, not null.

Returns:

the Builder, for chaining.

setMonetaryAmountFactory

public AmountFormatContextBuilder setMonetaryAmountFactory(MonetaryAmountFactory monetaryAmountBuilder)

Sets the MonetaryContext to be used, when amount's are parsed.

Parameters:

monetaryAmountBuilder - the monetary amount factory, not null.

Returns:

this builder for chaining.

build

public AmountFormatContext build()

Creates a new instance of AmountFormatContext that configures a .MonetaryAmountFormat.

Specified by:

build in class AbstractContextBuilder<AmountFormatContextBuilder,AmountFormatContext>

Returns:

a new AmountFormatContext instance.

create

public static AmountFormatContextBuilder create(AmountFormatQuery formatQuery)

Creates a new AmountFormatContextBuilder.

Parameters:

formatQuery - the base AmountFormatContext, not null.

Returns:

a new AmountFormatContextBuilder instance, never null.

of

public static AmountFormatContextBuilder of(AmountFormatContext context)

Creates a new AmountFormatContextBuilder.

Parameters:

context - the AmountFormatContext

Returns:

a new AmountFormatContextBuilder instance, never null.

of

public static AmountFormatContextBuilder of(java.lang.String formatName)

Creates a new AmountFormatContextBuilder.

Parameters:

formatName - the target formatName String, not null.

Returns:

a new AmountFormatContextBuilder instance, never null.

of

public static AmountFormatContextBuilder of(java.util.Locale locale)

Creates a new default AmountFormatContextBuilder for a formatter based on the locale specific defaults.

Parameters:

locale - the target Locale, not null.

Returns:

a new AmountFormatContextBuilder instance, never null.