com.dukascopy.api
Enum NewsFilter.TimeFrame

java.lang.Object
  java.lang.Enum<NewsFilter.TimeFrame>
      com.dukascopy.api.NewsFilter.TimeFrame

All Implemented Interfaces:

NewsFilter.ITimeFrame, Serializable, Comparable<NewsFilter.TimeFrame>

Enclosing class:

NewsFilter

public static enum NewsFilter.TimeFrame
extends Enum<NewsFilter.TimeFrame>
implements NewsFilter.ITimeFrame

Utility enum for end date calculations

Enum Constant Summary

LAST_10_MINUTES

LAST_30_MINUTES

LAST_HOUR

ONLINE

SPECIFIC_DATE

TODAY

Method Summary

int	getInterval()
TimeUnit	getTimeUnit()
String	toString()
static NewsFilter.TimeFrame	valueOf(String name) Returns the enum constant of this type with the specified name.
static NewsFilter.TimeFrame[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ONLINE

public static final NewsFilter.TimeFrame ONLINE

LAST_10_MINUTES

public static final NewsFilter.TimeFrame LAST_10_MINUTES

LAST_30_MINUTES

public static final NewsFilter.TimeFrame LAST_30_MINUTES

LAST_HOUR

public static final NewsFilter.TimeFrame LAST_HOUR

TODAY

public static final NewsFilter.TimeFrame TODAY

SPECIFIC_DATE

public static final NewsFilter.TimeFrame SPECIFIC_DATE

Method Detail

values

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

Returns:

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

valueOf

public static NewsFilter.TimeFrame 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

getInterval

public int getInterval()

Specified by:

getInterval in interface NewsFilter.ITimeFrame

getTimeUnit

public TimeUnit getTimeUnit()

Specified by:

getTimeUnit in interface NewsFilter.ITimeFrame

toString

public String toString()

Overrides:

toString in class Enum<NewsFilter.TimeFrame>