org.springframework.analytics.metrics

Enum AggregateCounterResolution

java.lang.Object

java.lang.Enum<AggregateCounterResolution>

org.springframework.analytics.metrics.AggregateCounterResolution

All Implemented Interfaces:

Serializable, Comparable<AggregateCounterResolution>

public enum AggregateCounterResolution
extends Enum<AggregateCounterResolution>

The resolution options available for querying an aggregate counter.

Author:

Luke Taylor

Enum Constant Summary

Enum Constants

Enum Constant and Description
day
hour
minute
month
year

Field Summary

Fields

Modifier and Type	Field and Description
org.joda.time.ReadablePeriod	unitPeriod

Method Summary

Methods

Modifier and Type	Method and Description
org.joda.time.DateTime	minus(org.joda.time.DateTime dt, int n) Subtracts this resolution a given number of times from a supplied date.
static AggregateCounterResolution	valueOf(String name) Returns the enum constant of this type with the specified name.
static AggregateCounterResolution[]	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

minute

public static final AggregateCounterResolution minute

hour

public static final AggregateCounterResolution hour

day

public static final AggregateCounterResolution day

month

public static final AggregateCounterResolution month

year

public static final AggregateCounterResolution year

Field Detail

unitPeriod

public final org.joda.time.ReadablePeriod unitPeriod

Method Detail

values

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

Returns:

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

valueOf

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

minus

public org.joda.time.DateTime minus(org.joda.time.DateTime dt,
                           int n)

Subtracts this resolution a given number of times from a supplied date.

Parameters:

dt - the date to subtract from

n - the number of periods of this resolution to subtract

Returns:

the resulting date in the past.