CacheMode (OANDA FXTrade Java API)

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD

DETAIL: ENUM CONSTANTS | FIELD | METHOD

com.oanda.fxtrade.api
Enum CacheMode

java.lang.Object
  java.lang.Enum<CacheMode>
      com.oanda.fxtrade.api.CacheMode

All Implemented Interfaces:: java.io.Serializable, java.lang.Comparable<CacheMode>

public enum CacheMode
extends java.lang.Enum<CacheMode>
extends java.lang.Enum<CacheMode>

Defines caching policies that can be requested when making calls that might return cached data.

Enum Constant Summary
`ALWAYS_FETCH` Caching mode that requests the contents of the cache be disregarded, forcing a server request.
`USE_CACHE` Caching mode that allows cached data to be returned if it is available.

Method Summary
`static CacheMode`	`valueOf(java.lang.String name)` Returns the enum constant of this type with the specified name.
`static CacheMode[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
`compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf`

Methods inherited from class java.lang.Object
`getClass, notify, notifyAll, wait, wait, wait`

Enum Constant Detail

USE_CACHE

public static final CacheMode USE_CACHE

Caching mode that allows cached data to be returned if it is available. If the cache does not contain the requested data, it will be fetched and entered into the cache.

ALWAYS_FETCH

public static final CacheMode ALWAYS_FETCH

Caching mode that requests the contents of the cache be disregarded, forcing a server request. Note that the results of the request will still be entered into the cache if possible.

Method Detail

values

public static CacheMode[] 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 (CacheMode c : CacheMode.values())
    System.out.println(c);

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

valueOf

public static CacheMode 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