Package com.atlassian.confluence.search.v2.lucene

Enum LuceneUtils.Resolution

java.lang.Object

java.lang.Enum<LuceneUtils.Resolution>

com.atlassian.confluence.search.v2.lucene.LuceneUtils.Resolution

All Implemented Interfaces:

Serializable, Comparable<LuceneUtils.Resolution>

Enclosing class:

LuceneUtils

public static enum LuceneUtils.Resolution
extends Enum<LuceneUtils.Resolution>

Specifies the time granularity.

Enum Constant Summary

Enum Constants

Enum Constant	Description
DAY	Limit a date's resolution to day granularity.
HOUR	Limit a date's resolution to hour granularity.
MILLISECOND	Limit a date's resolution to millisecond granularity.
MINUTE	Limit a date's resolution to minute granularity.
MONTH	Limit a date's resolution to month granularity.
SECOND	Limit a date's resolution to second granularity.
YEAR	Limit a date's resolution to year granularity.

Method Summary

Modifier and Type	Method	Description
SimpleDateFormat	getFormat()
String	toString()	this method returns the name of the resolution in lowercase (for backwards compatibility)
static LuceneUtils.Resolution	valueOf(String name)	Returns the enum constant of this type with the specified name.
static LuceneUtils.Resolution[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

YEAR

public static final LuceneUtils.Resolution YEAR

Limit a date's resolution to year granularity.

MONTH

public static final LuceneUtils.Resolution MONTH

Limit a date's resolution to month granularity.

DAY

public static final LuceneUtils.Resolution DAY

Limit a date's resolution to day granularity.

HOUR

public static final LuceneUtils.Resolution HOUR

Limit a date's resolution to hour granularity.

MINUTE

public static final LuceneUtils.Resolution MINUTE

Limit a date's resolution to minute granularity.

SECOND

public static final LuceneUtils.Resolution SECOND

Limit a date's resolution to second granularity.

MILLISECOND

public static final LuceneUtils.Resolution MILLISECOND

Limit a date's resolution to millisecond granularity.

Method Detail

values

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

Returns:

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

valueOf

public static LuceneUtils.Resolution 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

getFormat

public SimpleDateFormat getFormat()

Returns:

the date format to convert dates into string for this resolution

Since:

8.6

toString

public String toString()

this method returns the name of the resolution in lowercase (for backwards compatibility)

Overrides:

toString in class Enum<LuceneUtils.Resolution>