org.wattdepot.extension.openeis.domainmodel

Enum TimeInterval

java.lang.Object

java.lang.Enum<TimeInterval>

org.wattdepot.extension.openeis.domainmodel.TimeInterval

All Implemented Interfaces:

Serializable, Comparable<TimeInterval>

public enum TimeInterval
extends Enum<TimeInterval>

TimeInterval - Standard time intervals for doing OpenEIS analyses.

Author:

Cam Moore Created by carletonmoore on 4/16/15.

Enum Constant Summary

Enum Constants

Enum Constant and Description
FIVE_MONTHS Five months.
FOUR_MONTHS Four months.
FOUR_WEEKS Four weeks.
ONE_MONTH One month .
ONE_WEEK One week.
ONE_YEAR One year.
SIX_MONTHS Six months.
THREE_MONTHS Three months.
THREE_WEEKS Three weeks.
TWO_MONTHS Two months.
TWO_WEEKS Two weeks.

Method Summary

Methods

Modifier and Type	Method and Description
static TimeInterval	fromParameter(String parameter) Returns the defined TimeInterval for the given parameter, defaults to ONE_MONTH for unknown strings.
int	getNumDays()
String	getParameter()
static TimeInterval	valueOf(String name) Returns the enum constant of this type with the specified name.
static TimeInterval[]	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

ONE_WEEK

public static final TimeInterval ONE_WEEK

One week.

TWO_WEEKS

public static final TimeInterval TWO_WEEKS

Two weeks.

THREE_WEEKS

public static final TimeInterval THREE_WEEKS

Three weeks.

FOUR_WEEKS

public static final TimeInterval FOUR_WEEKS

Four weeks.

ONE_MONTH

public static final TimeInterval ONE_MONTH

One month .

TWO_MONTHS

public static final TimeInterval TWO_MONTHS

Two months.

THREE_MONTHS

public static final TimeInterval THREE_MONTHS

Three months.

FOUR_MONTHS

public static final TimeInterval FOUR_MONTHS

Four months.

FIVE_MONTHS

public static final TimeInterval FIVE_MONTHS

Five months.

SIX_MONTHS

public static final TimeInterval SIX_MONTHS

Six months.

ONE_YEAR

public static final TimeInterval ONE_YEAR

One year.

Method Detail

values

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

Returns:

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

valueOf

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

getNumDays

public int getNumDays()

Returns:

the number of days associated with this TimeInterval.

getParameter

public String getParameter()

Returns:

the string parameter associated with this TimeInterval.

fromParameter

public static TimeInterval fromParameter(String parameter)

Returns the defined TimeInterval for the given parameter, defaults to ONE_MONTH for unknown strings.

Parameters:

parameter - the pramamter.

Returns:

the defined TimeInterval for the given parameter, defaults to ONE_MONTH for unknown strings.