Module java.money
Package javax.money.convert

Enum RateType

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<RateType>, java.lang.constant.Constable
    public enum RateType
extends java.lang.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

    • Nested Class Summary

      • Nested classes/interfaces inherited from class java.lang.Enum

        java.lang.Enum.EnumDesc<E extends java.lang.Enum<E>>

    • Enum Constant Summary

      Enum Constants 
      Enum Constant 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 Description
      static RateType valueOf​(java.lang.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, describeConstable, 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.

      • 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.
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static RateType valueOf​(java.lang.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:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null