com.bigdata.counters

Enum PeriodEnum

java.lang.Object

java.lang.Enum<PeriodEnum>

com.bigdata.counters.PeriodEnum

All Implemented Interfaces:

Serializable, Comparable<PeriodEnum>

public enum PeriodEnum
extends Enum<PeriodEnum>

A type-safe enumeration of the different periods at which samples may be combined within a History.

Version:

$Id$

Author:

Bryan Thompson

Enum Constant Summary

Enum Constants

Enum Constant and Description
Days
Hours
Minutes

Method Summary

Methods

Modifier and Type	Method and Description
long	getPeriodMillis() The #of milliseconds within a reporting period.
static PeriodEnum	getValue(TimeUnit unit)
TimeUnit	toTimeUnit()
static PeriodEnum	valueOf(String name) Returns the enum constant of this type with the specified name.
static PeriodEnum[]	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

Minutes

public static final PeriodEnum Minutes

Hours

public static final PeriodEnum Hours

Days

public static final PeriodEnum Days

Method Detail

values

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

Returns:

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

valueOf

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

getPeriodMillis

public long getPeriodMillis()

The #of milliseconds within a reporting period. E.g., a #Minute has a base reporting period of 60,000 milliseconds. All samples arriving within the same base reporting period are combined in the same "slot" of the History. Samples arriving in the next period are combined within the next "slot".

Returns:

The base reporting period in milliseconds.

toTimeUnit

public TimeUnit toTimeUnit()

getValue

public static PeriodEnum getValue(TimeUnit unit)