net.sf.eBus.util.logging

Enum StatusReport.ReportFrequency

java.lang.Object

java.lang.Enum<StatusReport.ReportFrequency>

net.sf.eBus.util.logging.StatusReport.ReportFrequency

All Implemented Interfaces:

Serializable, Comparable<StatusReport.ReportFrequency>

Enclosing class:

StatusReport

public static enum StatusReport.ReportFrequency
extends Enum<StatusReport.ReportFrequency>

Enumerates the allowed status report frequencies:

1. FIVE_MINUTE: generate a report every five minutes on the five minute.
2. TEN_MINUTE: generate a report every ten minutes on the ten minute;
3. FIFTEEN_MINUTE: generate a report every fifteen minutes on the quarter hour.
4. TWENTY_MINUTE: generate a report every twenty minutes on the twenty minute.
5. THIRTY_MINUTE: generate a report every thirty minutes on the half hour.
6. HOURLY: generate a report every hour on the hour.

Enum Constant Summary

Enum Constants

Enum Constant and Description
FIFTEEN_MINUTE Report every fifteen minutes.
FIVE_MINUTE Report every five minutes.
HOURLY Report every sixty minutes.
TEN_MINUTE Report every ten minutes.
THIRTY_MINUTE Report every thirty minutes.
THIRTY_SECONDS Report every one minute.
TWENTY_MINUTE Report every twenty minutes.

Method Summary

Modifier and Type	Method and Description
long	getFrequency() Returns the report frequency in milliseconds.
static StatusReport.ReportFrequency	valueOf(String name) Returns the enum constant of this type with the specified name.
static StatusReport.ReportFrequency[]	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

THIRTY_SECONDS

public static final StatusReport.ReportFrequency THIRTY_SECONDS

Report every one minute. Used for testing purposes.

FIVE_MINUTE

public static final StatusReport.ReportFrequency FIVE_MINUTE

Report every five minutes.

TEN_MINUTE

public static final StatusReport.ReportFrequency TEN_MINUTE

Report every ten minutes.

FIFTEEN_MINUTE

public static final StatusReport.ReportFrequency FIFTEEN_MINUTE

Report every fifteen minutes.

TWENTY_MINUTE

public static final StatusReport.ReportFrequency TWENTY_MINUTE

Report every twenty minutes.

THIRTY_MINUTE

public static final StatusReport.ReportFrequency THIRTY_MINUTE

Report every thirty minutes.

HOURLY

public static final StatusReport.ReportFrequency HOURLY

Report every sixty minutes.

Method Detail

values

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

Returns:

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

valueOf

public static StatusReport.ReportFrequency 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

getFrequency

public long getFrequency()

Returns the report frequency in milliseconds.

Returns:

the report frequency in milliseconds.