com.dukascopy.api
Enum CalendarFilter.TimeFrame

java.lang.Object
  extended by java.lang.Enum<CalendarFilter.TimeFrame>
      extended by com.dukascopy.api.CalendarFilter.TimeFrame
All Implemented Interfaces:
NewsFilter.ITimeFrame, java.io.Serializable, java.lang.Comparable<CalendarFilter.TimeFrame>
Enclosing class:
CalendarFilter
public static enum CalendarFilter.TimeFrame
extends java.lang.Enum<CalendarFilter.TimeFrame>
implements NewsFilter.ITimeFrame

Utility enum for end date calculations

Enum Constant Summary
DAY
           
WEEK
           
 
Method Summary
 int getInterval()
           
 java.util.concurrent.TimeUnit getTimeUnit()
           
 java.lang.String toString()
           
static CalendarFilter.TimeFrame valueOf(java.lang.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
clone, compareTo, equals, finalize, 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(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

getInterval

public int getInterval()
Specified by:
getInterval in interface NewsFilter.ITimeFrame

getTimeUnit

public java.util.concurrent.TimeUnit getTimeUnit()
Specified by:
getTimeUnit in interface NewsFilter.ITimeFrame

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Enum<CalendarFilter.TimeFrame>