net.degreedays.api.data

Enum TimeSeriesInterval

java.lang.Object

java.lang.Enum<TimeSeriesInterval>

net.degreedays.api.data.TimeSeriesInterval

All Implemented Interfaces:

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

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

Defines the interval (e.g. hourly) that time-series data should be calculated with.

Since:

1.2

Enum Constant Summary

Enum Constants

Enum Constant and Description
HOURLY For regular hourly time-series data i.e. readings on the hour every hour.

Method Summary

Modifier and Type	Method and Description
static TimeSeriesInterval	fromString(java.lang.String string) Returns the non-null TimeSeriesInterval with the specified string (returned by its toString() method).
java.lang.String	toString() Returns a non-null, non-empty string representation of this enum constant in the format required by the request XML (e.g. "Hourly").
static TimeSeriesInterval	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static TimeSeriesInterval[]	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

HOURLY

public static final TimeSeriesInterval HOURLY

For regular hourly time-series data i.e. readings on the hour every hour.

Method Detail

values

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

Returns:

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

valueOf

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

toString

public java.lang.String toString()

Returns a non-null, non-empty string representation of this enum constant in the format required by the request XML (e.g. "Hourly").

Overrides:

toString in class java.lang.Enum<TimeSeriesInterval>

fromString

public static TimeSeriesInterval fromString(java.lang.String string)

Returns the non-null TimeSeriesInterval with the specified string (returned by its toString() method).

Throws:

java.lang.NullPointerException - if string is null.

java.lang.IllegalArgumentException - if string is not "Hourly" (as at present HOURLY is the only TimeSeriesInterval).