Module java.money

Package javax.money.format

Class AmountFormatQuery

java.lang.Object

javax.money.AbstractContext

javax.money.AbstractQuery

javax.money.format.AmountFormatQuery

All Implemented Interfaces:

java.io.Serializable

public final class AmountFormatQuery
extends AbstractQuery

Query for accessing instances of MonetaryAmountFormat. In general it is determined by the implementation, what formats are provided. Nevertheless the following queries must be supported:

• Accessing a format based on a Locale, that is also supported by .DecimalFormat#getAvailableLocales().

All other formats are optional. For further details about supported formats refer to the implementation's documentation.

This class is immutable, thread-safe and serializable.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
(package private) static java.lang.String	KEY_QUERY_FORMAT_NAME	Key used for the format name attribute.
private static long	serialVersionUID

Fields inherited from class javax.money.AbstractQuery

KEY_QUERY_PROVIDERS, KEY_QUERY_TARGET_TYPE, KEY_QUERY_TIMESTAMP

Fields inherited from class javax.money.AbstractContext

KEY_PROVIDER

Constructor Summary

Constructors

Constructor	Description
AmountFormatQuery(AmountFormatQueryBuilder builder)	Constructor, used from the Builder.

Method Summary

Modifier and Type	Method	Description
java.lang.String	getFormatName()	Gets a style's id.
java.util.Locale	getLocale()	Gets a Locale to be applied.
MonetaryAmountFactory	getMonetaryAmountFactory()	Gets the MonetaryAmountFactoryQuery to be used for accessing .MonetaryAmountFactory, when amount's are parsed.
static AmountFormatQuery	of(java.util.Locale locale, java.lang.String... providers)	Creates a simple format query based on a single Locale, similar to (java.util.Locale).
AmountFormatQueryBuilder	toBuilder()	Get a AmountFormatQueryBuilder preinitialized with this context instance.

Methods inherited from class javax.money.AbstractQuery

getProviderNames, getTargetType

Methods inherited from class javax.money.AbstractContext

equals, get, get, getBoolean, getDouble, getFloat, getInt, getKeys, getLong, getProviderName, getText, getType, hashCode, isEmpty, toString

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

KEY_QUERY_FORMAT_NAME

static final java.lang.String KEY_QUERY_FORMAT_NAME

Key used for the format name attribute.

See Also:

Constant Field Values

Constructor Detail

AmountFormatQuery

AmountFormatQuery(AmountFormatQueryBuilder builder)

Constructor, used from the Builder.

Parameters:

builder - the corresponding AmountFormatQueryBuilder, not null.

Method Detail

getFormatName

public java.lang.String getFormatName()

Gets a style's id.

Returns:

the styleId, or null.

getLocale

public java.util.Locale getLocale()

Gets a Locale to be applied.

Returns:

the style's locale, or null.

getMonetaryAmountFactory

public MonetaryAmountFactory getMonetaryAmountFactory()

Gets the MonetaryAmountFactoryQuery to be used for accessing .MonetaryAmountFactory, when amount's are parsed.

Returns:

the monetary context, or null.

of

public static AmountFormatQuery of(java.util.Locale locale,
                                   java.lang.String... providers)

Creates a simple format query based on a single Locale, similar to (java.util.Locale).

Parameters:

locale - the target locale, not null.

providers - the providers to be used, not null.

Returns:

a new query instance

toBuilder

public AmountFormatQueryBuilder toBuilder()

Get a AmountFormatQueryBuilder preinitialized with this context instance.

Returns:

a new preinitialized builder, never null.