Top Description Fields Constructors Methods
javax.money.format

public final Class AmountFormatQueryBuilder

extends AbstractQueryBuilder<AmountFormatQueryBuilder, AmountFormatQuery>
Class Inheritance
Imports
javax.money.AbstractQueryBuilder, .MonetaryAmountFactory, .MonetaryAmountFactoryQuery, java.util.Locale, .Objects

Builder for queries for accessing/configuring javax.money.format.MonetaryAmountFormat instances.

Note this class is NOT thread-safe.

Field Summary

Modifier and TypeField and Description
private static final String
DEFAULT_FORMAT_NAME

The default format name used.

Constructor Summary

AccessConstructor and Description
private
private
AmountFormatQueryBuilder(String
the target format's name String, not null.
formatName
)

Creates a new AmountFormatQueryBuilder.

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

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

Method Summary

Modifier and TypeMethod and Description
public AmountFormatQuery

Returns:

a new javax.money.format.AmountFormatQuery instance, never null.
build
()

Implements abstract javax.money.AbstractQueryBuilder.build.

Creates a new javax.money.format.AmountFormatQuery instance.
public static AmountFormatQueryBuilder

Returns:

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

Creates a new AmountFormatQueryBuilder and initializes it with the values from formatQuery.

public static AmountFormatQueryBuilder

Returns:

a new javax.money.format.AmountFormatQueryBuilder instance, never null.
of
(String
the target format's name String, not null.
formatName
)

Creates a new AmountFormatQueryBuilder.

public static AmountFormatQueryBuilder

Returns:

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

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

public AmountFormatQueryBuilder

Returns:

the Builder, for chaining.
setFormatName
(String
the format's name, not null.
formatName
)

Sets a style's id.

public AmountFormatQueryBuilder

Returns:

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

Sets a Locale to be applied.

public AmountFormatQueryBuilder

Returns:

this builder for chaining.
setMonetaryAmountFactory
(MonetaryAmountFactory<?>
the javax.money.MonetaryAmountFactory to be used, not null.
monetaryFactory
)

Sets the javax.money.MonetaryAmountFactory to be used to of amounts during parsing.

public AmountFormatQueryBuilder

Returns:

this builder for chaining.
setMonetaryQuery
(MonetaryAmountFactoryQuery
the monetary query, not null.
monetaryQuery
)

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

Inherited from javax.money.AbstractQueryBuilder:
setsetProviderNamesetProviderNamessetProviderNamessetTargetType

Field Detail

DEFAULT_FORMAT_NAMEback to summary
private static final String DEFAULT_FORMAT_NAME

The default format name used.

Constructor Detail

AmountFormatQueryBuilderback to summary
private AmountFormatQueryBuilder(AmountFormatQuery formatQuery)

Creates a new AmountFormatQueryBuilder.

Parameters
formatQuery:AmountFormatQuery

the base AmountFormatQuery, not null.

AmountFormatQueryBuilderback to summary
private AmountFormatQueryBuilder(String formatName)

Creates a new AmountFormatQueryBuilder.

Parameters
formatName:String

the target format's name String, not null.

AmountFormatQueryBuilderback to summary
private AmountFormatQueryBuilder(Locale locale)

Creates a new default AmountFormatQueryBuilder 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 AmountFormatQuery build()

Implements abstract javax.money.AbstractQueryBuilder.build.

Creates a new javax.money.format.AmountFormatQuery instance.

Returns:AmountFormatQuery

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

ofback to summary
public static AmountFormatQueryBuilder of(AmountFormatQuery formatQuery)

Creates a new AmountFormatQueryBuilder and initializes it with the values from formatQuery.

Parameters
formatQuery:AmountFormatQuery

the base AmountFormatContext, not null.

Returns:AmountFormatQueryBuilder

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

ofback to summary
public static AmountFormatQueryBuilder of(String formatName)

Creates a new AmountFormatQueryBuilder.

Parameters
formatName:String

the target format's name String, not null.

Returns:AmountFormatQueryBuilder

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

ofback to summary
public static AmountFormatQueryBuilder of(Locale locale)

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

Parameters
locale:Locale

the target java.util.Locale, not null.

Returns:AmountFormatQueryBuilder

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

setFormatNameback to summary
public AmountFormatQueryBuilder setFormatName(String formatName)

Sets a style's id.

Parameters
formatName:String

the format's name, not null.

Returns:AmountFormatQueryBuilder

the Builder, for chaining.

setLocaleback to summary
public AmountFormatQueryBuilder setLocale(Locale locale)

Sets a Locale to be applied.

Parameters
locale:Locale

the locale, not null.

Returns:AmountFormatQueryBuilder

the Builder, for chaining.

setMonetaryAmountFactoryback to summary
public AmountFormatQueryBuilder setMonetaryAmountFactory(MonetaryAmountFactory<?> monetaryFactory)

Sets the javax.money.MonetaryAmountFactory to be used to of amounts during parsing.

Parameters
monetaryFactory:MonetaryAmountFactory<?>

the javax.money.MonetaryAmountFactory to be used, not null.

Returns:AmountFormatQueryBuilder

this builder for chaining.

setMonetaryQueryback to summary
public AmountFormatQueryBuilder setMonetaryQuery(MonetaryAmountFactoryQuery monetaryQuery)

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

Parameters
monetaryQuery:MonetaryAmountFactoryQuery

the monetary query, not null.

Returns:AmountFormatQueryBuilder

this builder for chaining.