javax.money.convert

Enum RateType

java.lang.Object

java.lang.Enum<RateType>

javax.money.convert.RateType

All Implemented Interfaces:

Serializable, Comparable<RateType>

public enum RateType
extends Enum<RateType>

This enumeration defines the different type of rates that can be provided by .ExchangeRateProvider implementations. Hereby the rate provider's ProviderContext can contain additional information about the rates provided. Similarly, when accessing .ExchangeRateProvider or CurrencyConversion instances corresponding attributes can be passed within an (optional) ConversionContext.

Author:

Anatole Tresch, Werner Keil

Enum Constant Summary

Enum Constants

Enum Constant and Description
ANY Any type of rates.
DEFERRED Deferred rates are basically also current rates, but have some fixed delay, e.g.
HISTORIC Historic rates, e.g.
OTHER Any other type of rates.
REALTIME Real-time rates should be as adequate as possible, basically not more than a few milliseconds late.

Method Summary

Modifier and Type	Method and Description
static RateType	valueOf(String name) Returns the enum constant of this type with the specified name.
static RateType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

HISTORIC

public static final RateType HISTORIC

Historic rates, e.g. from the day before or older.

REALTIME

public static final RateType REALTIME

Real-time rates should be as adequate as possible, basically not more than a few milliseconds late.

DEFERRED

public static final RateType DEFERRED

Deferred rates are basically also current rates, but have some fixed delay, e.g. 20 minutes.

OTHER

public static final RateType OTHER

Any other type of rates. You may use the ProviderContext, ConversionContext to define additional details.

ANY

public static final RateType ANY

Any type of rates. This can be used, where any type of rate is suitable. This may be feasible if you access a specific chain of rate providers, where the order of providers already implies a prioritization and the rate type in that scenario is not relevant.

Method Detail

values

public static RateType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (RateType c : RateType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static RateType valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null