com.dukascopy.api
Enum CalendarFilter.TimeFrame

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

All Implemented Interfaces:

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

Enclosing class:

CalendarFilter

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

Utility enum for end date calculations

Enum Constant Summary

DAY

WEEK

Method Summary

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

DAY

public static final CalendarFilter.TimeFrame DAY

WEEK

public static final CalendarFilter.TimeFrame WEEK

Method Detail

values

public static CalendarFilter.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 (CalendarFilter.TimeFrame c : CalendarFilter.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 CalendarFilter.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<CalendarFilter.TimeFrame>