org.opennms.features.jest.client.index

Enum IndexStrategy

java.lang.Object

java.lang.Enum<IndexStrategy>

org.opennms.features.jest.client.index.IndexStrategy

All Implemented Interfaces:

Serializable, Comparable<IndexStrategy>

public enum IndexStrategy
extends Enum<IndexStrategy>

Defines a strategy on how to define the index when persisting. This implementation is thread safe.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DAILY
HOURLY
MONTHLY
YEARLY

Method Summary

Modifier and Type	Method and Description
String	getIndex(IndexSettings indexSettings, String indexName, java.time.temporal.TemporalAccessor temporal)
String	getPattern()
static IndexStrategy	valueOf(String name) Returns the enum constant of this type with the specified name.
static IndexStrategy[]	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

YEARLY

public static final IndexStrategy YEARLY

MONTHLY

public static final IndexStrategy MONTHLY

DAILY

public static final IndexStrategy DAILY

HOURLY

public static final IndexStrategy HOURLY

Method Detail

values

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

Returns:

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

valueOf

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

getIndex

public String getIndex(IndexSettings indexSettings,
                       String indexName,
                       java.time.temporal.TemporalAccessor temporal)

getPattern

public String getPattern()