Module java.money

Package javax.money.convert

Class ProviderContext

java.lang.Object

javax.money.AbstractContext

javax.money.convert.ProviderContext

All Implemented Interfaces:

java.io.Serializable

public final class ProviderContext
extends AbstractContext

This class describes what kind of ExchangeRates a .ExchangeRateProvider delivers, including the provider's name, rate type and additional data. By default such a context supports the following attributes:

• a unique non localizable provider name. This provider name is also used to identify a concrete instance of ExchangeRateProvider.
• a set of RateType an ExchangeRateProvider supports
• a time range for which an ExchangeRateProvider delivers rates.

Additionally a instance of ProviderContext can have arbitrary additional attributes describing more precisely the capabilities of a concrete ExchangeRateProvider} implementation.

Instances of this class are immutable and thread-safe.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
(package private) static java.lang.String	KEY_RATE_TYPES	Key used for the rate types attribute.
private static long	serialVersionUID

Fields inherited from class javax.money.AbstractContext

KEY_PROVIDER

Constructor Summary

Constructors

Constructor	Description
ProviderContext(ProviderContextBuilder builder)	Private constructor, used by ProviderContextBuilder.

Method Summary

Modifier and Type	Method	Description
java.util.Set<RateType>	getRateTypes()	Get the deferred flag.
static ProviderContext	of(java.lang.String provider)	Creates a new ProviderContext based on the provider id and rate type(s).
static ProviderContext	of(java.lang.String provider, RateType rateType, RateType... rateTypes)	Creates a new ProviderContext based on the provider id and rate type(s).
ProviderContextBuilder	toBuilder()	Creates a ProviderContextBuilder initialized with this instance's data.

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_RATE_TYPES

static final java.lang.String KEY_RATE_TYPES

Key used for the rate types attribute.

See Also:

Constant Field Values

Constructor Detail

ProviderContext

ProviderContext(ProviderContextBuilder builder)

Private constructor, used by ProviderContextBuilder.

Parameters:

builder - the Builder.

Method Detail

getRateTypes

public java.util.Set<RateType> getRateTypes()

Get the deferred flag. Exchange rates can be deferred or real.time.

Returns:

the deferred flag, or {code null}.

toBuilder

public ProviderContextBuilder toBuilder()

Creates a ProviderContextBuilder initialized with this instance's data.

Returns:

a new ProviderContextBuilder, never null.

of

public static ProviderContext of(java.lang.String provider,
                                 RateType rateType,
                                 RateType... rateTypes)

Creates a new ProviderContext based on the provider id and rate type(s).

Parameters:

provider - the provider id, not null.

rateType - the required RateType, not null.

rateTypes - the required RateTypes, not null

Returns:

a new ProviderContext instance.

of

public static ProviderContext of(java.lang.String provider)

Creates a new ProviderContext based on the provider id and rate type(s).

Parameters:

provider - the provider id, not null.

Returns:

a new ProviderContext instance.