Top Description Fields Constructors Methods
javax.money.format

public final Class AmountFormatContextBuilder

extends AbstractContextBuilder<AmountFormatContextBuilder, AmountFormatContext>
Class Inheritance
Imports
javax.money.AbstractContextBuilder, .MonetaryAmountFactory, java.util.Locale, .Objects
Builder class for creating new instances of javax.money.format.AmountFormatContext adding detailed information about a javax.money.format.MonetaryAmountFormat instance.

Note this class is NOT thread-safe.

See Also
MonetaryAmountFormat#getContext()

Field Summary

Modifier and TypeField and Description
private static final String
DEFAULT_FORMAT_NAME

Map key used for the style identifier attribute.

Constructor Summary

AccessConstructor and Description
private
AmountFormatContextBuilder(AmountFormatQuery
the base AmountFormatQuery, not null.
formatQuery)

Creates a new AmountFormatContextBuilder.

private
AmountFormatContextBuilder(AmountFormatContext
the base AmountFormatContext, not null.
context)

Creates a new AmountFormatContextBuilder.

private
AmountFormatContextBuilder(String
the target formatName String, not null.
formatName)

Creates a new AmountFormatContextBuilder.

private
AmountFormatContextBuilder(Locale
the target java.util.Locale, not null.
locale)

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

Method Summary

Modifier and TypeMethod and Description
public AmountFormatContext

Returns:

a new AmountFormatContext instance.
build()

Implements abstract javax.money.AbstractContextBuilder.build.

Creates a new instance of AmountFormatContext that configures a .MonetaryAmountFormat.
public static AmountFormatContextBuilder

Returns:

a new javax.money.format.AmountFormatContextBuilder instance, never null.
create(AmountFormatQuery
the base AmountFormatContext, not null.
formatQuery)

Creates a new AmountFormatContextBuilder.

public static AmountFormatContextBuilder

Returns:

a new javax.money.format.AmountFormatContextBuilder instance, never null.
of(AmountFormatContext
the AmountFormatContext
context)

Creates a new AmountFormatContextBuilder.

public static AmountFormatContextBuilder

Returns:

a new javax.money.format.AmountFormatContextBuilder instance, never null.
of(String
the target formatName String, not null.
formatName)

Creates a new AmountFormatContextBuilder.

public static AmountFormatContextBuilder

Returns:

a new javax.money.format.AmountFormatContextBuilder instance, never null.
of(Locale
the target java.util.Locale, not null.
locale)

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

public AmountFormatContextBuilder

Returns:

the Builder, for chaining.
setFormatName(String
the formatName, not null.
formatName)

Sets a format's name.

public AmountFormatContextBuilder

Returns:

the Builder, for chaining.
setLocale(Locale
the locale, not null.
locale)

Sets a Locale to be applied.

public AmountFormatContextBuilder

Returns:

this builder for chaining.
setMonetaryAmountFactory(MonetaryAmountFactory<T extends MonetaryAmount>
the monetary amount factory, not null.
monetaryAmountBuilder)

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

Inherited from javax.money.AbstractContextBuilder:
importContextimportContextremoveAttributessetsetsetsetsetsetsetsetsetsetProviderNametoString

Field Detail

DEFAULT_FORMAT_NAMEback to summary
private static final String DEFAULT_FORMAT_NAME

Map key used for the style identifier attribute.

Constructor Detail

AmountFormatContextBuilderback to summary
private AmountFormatContextBuilder(AmountFormatQuery formatQuery)

Creates a new AmountFormatContextBuilder.

Parameters
formatQuery:AmountFormatQuery

the base AmountFormatQuery, not null.

AmountFormatContextBuilderback to summary
private AmountFormatContextBuilder(AmountFormatContext context)

Creates a new AmountFormatContextBuilder.

Parameters
context:AmountFormatContext

the base AmountFormatContext, not null.

AmountFormatContextBuilderback to summary
private AmountFormatContextBuilder(String formatName)

Creates a new AmountFormatContextBuilder.

Parameters
formatName:String

the target formatName String, not null.

AmountFormatContextBuilderback to summary
private AmountFormatContextBuilder(Locale locale)

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

Parameters
locale:Locale

the target java.util.Locale, not null.

Method Detail

buildback to summary
public AmountFormatContext build()

Implements abstract javax.money.AbstractContextBuilder.build.

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

Returns:AmountFormatContext

a new AmountFormatContext instance.

Annotations
@Override
createback to summary
public static AmountFormatContextBuilder create(AmountFormatQuery formatQuery)

Creates a new AmountFormatContextBuilder.

Parameters
formatQuery:AmountFormatQuery

the base AmountFormatContext, not null.

Returns:AmountFormatContextBuilder

a new javax.money.format.AmountFormatContextBuilder instance, never null.

ofback to summary
public static AmountFormatContextBuilder of(AmountFormatContext context)

Creates a new AmountFormatContextBuilder.

Parameters
context:AmountFormatContext

the AmountFormatContext

Returns:AmountFormatContextBuilder

a new javax.money.format.AmountFormatContextBuilder instance, never null.

ofback to summary
public static AmountFormatContextBuilder of(String formatName)

Creates a new AmountFormatContextBuilder.

Parameters
formatName:String

the target formatName String, not null.

Returns:AmountFormatContextBuilder

a new javax.money.format.AmountFormatContextBuilder instance, never null.

ofback to summary
public static AmountFormatContextBuilder of(Locale locale)

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

Parameters
locale:Locale

the target java.util.Locale, not null.

Returns:AmountFormatContextBuilder

a new javax.money.format.AmountFormatContextBuilder instance, never null.

setFormatNameback to summary
public AmountFormatContextBuilder setFormatName(String formatName)

Sets a format's name.

Parameters
formatName:String

the formatName, not null.

Returns:AmountFormatContextBuilder

the Builder, for chaining.

setLocaleback to summary
public AmountFormatContextBuilder setLocale(Locale locale)

Sets a Locale to be applied.

Parameters
locale:Locale

the locale, not null.

Returns:AmountFormatContextBuilder

the Builder, for chaining.

setMonetaryAmountFactoryback to summary
public AmountFormatContextBuilder setMonetaryAmountFactory(MonetaryAmountFactory<T extends MonetaryAmount> monetaryAmountBuilder)

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

Parameters
monetaryAmountBuilder:MonetaryAmountFactory<T extends MonetaryAmount>

the monetary amount factory, not null.

Returns:AmountFormatContextBuilder

this builder for chaining.