org.opennms.netmgt.statsd
Enum RelativeTime

java.lang.Object
  java.lang.Enum<RelativeTime>
      org.opennms.netmgt.statsd.RelativeTime

All Implemented Interfaces:

Serializable, Comparable<RelativeTime>

public enum RelativeTime
extends Enum<RelativeTime>

RelativeTime class.

Version:

$Id: $

Author:

DJ Gregor

Enum Constant Summary

LASTHOUR

LASTSEVENDAYS

LASTTHIRTYONEDAYS

THISYEAR

YESTERDAY

Method Summary

protected long	getCurrentTime() getCurrentTime
abstract Date	getEnd() getEnd
abstract Date	getStart() getStart
protected Date	getStartDate(int offset) getStartDate
protected Date	getStartOfToday() getStartOfToday
TimeKeeper	getTimeKeeper() getTimeKeeper
void	setTimeKeeper(TimeKeeper timeKeeper) setTimeKeeper
static RelativeTime	valueOf(String name) Returns the enum constant of this type with the specified name.
static RelativeTime[]	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

THISYEAR

public static final RelativeTime THISYEAR

LASTTHIRTYONEDAYS

public static final RelativeTime LASTTHIRTYONEDAYS

LASTSEVENDAYS

public static final RelativeTime LASTSEVENDAYS

YESTERDAY

public static final RelativeTime YESTERDAY

LASTHOUR

public static final RelativeTime LASTHOUR

Method Detail

values

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

Returns:

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

valueOf

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

getStartDate

protected Date getStartDate(int offset)

getStartDate

Parameters:

offset - a int.

Returns:

a Date object.

getStartOfToday

protected Date getStartOfToday()

getStartOfToday

Returns:

a Date object.

getStart

public abstract Date getStart()

getStart

Returns:

a Date object.

getEnd

public abstract Date getEnd()

getEnd

Returns:

a Date object.

getTimeKeeper

public TimeKeeper getTimeKeeper()

getTimeKeeper

Returns:

a TimeKeeper object.

setTimeKeeper

public void setTimeKeeper(TimeKeeper timeKeeper)

setTimeKeeper

Parameters:

timeKeeper - a TimeKeeper object.

getCurrentTime

protected long getCurrentTime()

getCurrentTime

Returns:

a long.