org.osgl.storage

Enum KeyGenerator.Predefined

java.lang.Object

java.lang.Enum<KeyGenerator.Predefined>

org.osgl.storage.KeyGenerator.Predefined

All Implemented Interfaces:

Serializable, Comparable<KeyGenerator.Predefined>, KeyGenerator

Enclosing interface:

KeyGenerator

public static enum KeyGenerator.Predefined
extends Enum<KeyGenerator.Predefined>
implements KeyGenerator

Nested Class Summary

Nested classes/interfaces inherited from interface org.osgl.storage.KeyGenerator

KeyGenerator.Predefined

Enum Constant Summary

Enum Constants

Enum Constant and Description
BY_DATE Items stored in a hierarchy structured by date: /yyyy/MM/dd/item
BY_DATETIME Deprecated.
BY_HOUR Items stored in a hierarchy structured by date and time: /yyyy/MM/dd/HH/item
BY_MINUTE Items stored in a hierarchy structured by date and time: /yyyy/MM/dd/HH/mm/item
BY_SECOND Items stored in a hierarchy structured by date and time: /yyyy/MM/dd/HH/mm/ss/item
PLAIN All item stored in the bucket (root folder) without hierarchy

Method Summary

Methods

Modifier and Type	Method and Description
String	getKey(String name, KeyNameProvider keyNameProvider)
protected abstract String	tmpl()
static KeyGenerator.Predefined	valueOf(String name) Returns the enum constant of this type with the specified name.
static KeyGenerator	valueOfIgnoreCase(String s)
static KeyGenerator.Predefined[]	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

PLAIN

public static final KeyGenerator.Predefined PLAIN

All item stored in the bucket (root folder) without hierarchy

BY_DATE

public static final KeyGenerator.Predefined BY_DATE

Items stored in a hierarchy structured by date: /yyyy/MM/dd/item

BY_HOUR

public static final KeyGenerator.Predefined BY_HOUR

Items stored in a hierarchy structured by date and time: /yyyy/MM/dd/HH/item

BY_MINUTE

public static final KeyGenerator.Predefined BY_MINUTE

Items stored in a hierarchy structured by date and time: /yyyy/MM/dd/HH/mm/item

BY_SECOND

public static final KeyGenerator.Predefined BY_SECOND

Items stored in a hierarchy structured by date and time: /yyyy/MM/dd/HH/mm/ss/item

BY_DATETIME

@Deprecated
public static final KeyGenerator.Predefined BY_DATETIME

Deprecated.

Items stored in a hierarchy structured by date and time: /yyyy/MM/dd/HH/mm/ss/item Note this enum value is deprecated, please use `BY_SECOND` instead

Method Detail

values

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

Returns:

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

valueOf

public static KeyGenerator.Predefined 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

tmpl

protected abstract String tmpl()

getKey

public String getKey(String name,
            KeyNameProvider keyNameProvider)

Specified by:

getKey in interface KeyGenerator

valueOfIgnoreCase

public static KeyGenerator valueOfIgnoreCase(String s)