com.dukascopy.api

Enum Filter

java.lang.Object

java.lang.Enum<Filter>

com.dukascopy.api.Filter

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Filter>

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

Different methods of flats filtering

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALL_FLATS Deprecated. use WEEKENDS filter which filters all holidays and market breaks
NO_FILTER Don't filter anything
WEEKENDS Filter flats at the weekends, on market breaks and holidays

Method Summary

Modifier and Type	Method and Description
static Filter	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Filter[]	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

NO_FILTER

public static final Filter NO_FILTER

Don't filter anything

WEEKENDS

public static final Filter WEEKENDS

Filter flats at the weekends, on market breaks and holidays

ALL_FLATS

@Deprecated
public static final Filter ALL_FLATS

Deprecated. use WEEKENDS filter which filters all holidays and market breaks

Equal to Filter.WEEKENDS

Method Detail

values

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

Returns:

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

valueOf

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