Module java.money

Package javax.money.convert

Class ConversionContext

java.lang.Object

javax.money.AbstractContext

javax.money.convert.ConversionContext

All Implemented Interfaces:

java.io.Serializable

public final class ConversionContext
extends AbstractContext

This class models a context for which a ExchangeRate is valid. It allows to define different settings such as

• the required RateType,
• the required target timestamp
• the required validity duration
• additional non standard or extended attributes determined by the implementations participating in the ExchangeRateProvider chain.

This class is immutable, thread-safe and serializable.

Author:

Anatole Tresch

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static ConversionContext	ANY_CONVERSION	ConversionContext that queries any conversion available.
static ConversionContext	DEFERRED_CONVERSION	ConversionContext querying for any deferred rates.
static ConversionContext	HISTORIC_CONVERSION	ConversionContext querying for any historic rates.
static ConversionContext	OTHER_CONVERSION	ConversionContext querying for any other rates.
static ConversionContext	REALTIME_CONVERSION	ConversionContext querying for real-time rates.

Fields inherited from class javax.money.AbstractContext

KEY_PROVIDER

Method Summary

Modifier and Type	Method	Description
static ConversionContext	from(ProviderContext providerContext, RateType rateType)	Creates a new ConversionContext for the given ProviderContext and the given RateType.
java.lang.String	getProviderName()	Get the provider of this rate.
RateType	getRateType()	Get the deferred flag.
static ConversionContext	of()	Simple factory method for ConversionContext.
static ConversionContext	of(java.lang.String provider, RateType rateType)	Simple factory method for ConversionContext.
static ConversionContext	of(RateType rateType)	Creates a ConversionContext for accessing rates of the given type, without specifying the rate's provider.
ConversionContextBuilder	toBuilder()	Creates a conversion query builder with the context data from this context instance.
ConversionQueryBuilder	toQueryBuilder()	Creates a query builder based on this context.

Methods inherited from class javax.money.AbstractContext

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

Methods inherited from class java.lang.Object

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

Field Detail

ANY_CONVERSION

public static final ConversionContext ANY_CONVERSION

ConversionContext that queries any conversion available.

DEFERRED_CONVERSION

public static final ConversionContext DEFERRED_CONVERSION

ConversionContext querying for any deferred rates.

HISTORIC_CONVERSION

public static final ConversionContext HISTORIC_CONVERSION

ConversionContext querying for any historic rates.

REALTIME_CONVERSION

public static final ConversionContext REALTIME_CONVERSION

ConversionContext querying for real-time rates.

OTHER_CONVERSION

public static final ConversionContext OTHER_CONVERSION

ConversionContext querying for any other rates.

Method Detail

getRateType

public RateType getRateType()

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

Returns:

the deferred flag, or {code null}.

getProviderName

public java.lang.String getProviderName()

Get the provider of this rate. The provider of a rate can have different contexts in different usage scenarios, such as the service type or the stock exchange.

Overrides:

getProviderName in class AbstractContext

Returns:

the provider, or {code null}.

toBuilder

public ConversionContextBuilder toBuilder()

Creates a conversion query builder with the context data from this context instance.

Returns:

a corresponding conversion query builder instance, never null.

toQueryBuilder

public ConversionQueryBuilder toQueryBuilder()

Creates a query builder based on this context.

Returns:

a new instance of ConversionQueryBuilder, never null.

of

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

Simple factory method for ConversionContext. For more possibilities to initialize a ConversionContext, please use a ConversionContextBuilder,

Parameters:

provider - the provider name, not null

rateType - the required rate type.

Returns:

a new instance of ConversionContext

from

public static ConversionContext from(ProviderContext providerContext,
                                     RateType rateType)

Creates a new ConversionContext for the given ProviderContext and the given RateType.

Note: for adding additional attributes use (ProviderContext, RateType).

Parameters:

providerContext - the provider context, not null.

rateType - the rate type, not null.

Returns:

a corresponding instance of ConversionContext.

of

public static ConversionContext of(RateType rateType)

Creates a ConversionContext for accessing rates of the given type, without specifying the rate's provider.

Parameters:

rateType - the required rate type.

Returns:

a new instance of ConversionContext

of

public static ConversionContext of()

Simple factory method for ConversionContext. For more possibilities to initialize a ConversionContext, please use a ConversionContextBuilder,

Returns:

a new instance of ConversionContext