Package org.opencms.jsp.search.config.parser.simplesearch.daterestrictions

Enum Class I_CmsDateRestriction.TimeUnit

java.lang.Object

java.lang.Enum<I_CmsDateRestriction.TimeUnit>

org.opencms.jsp.search.config.parser.simplesearch.daterestrictions.I_CmsDateRestriction.TimeUnit

All Implemented Interfaces:

Serializable, Comparable<I_CmsDateRestriction.TimeUnit>, Constable

Enclosing interface:

I_CmsDateRestriction

public static enum I_CmsDateRestriction.TimeUnit
extends Enum<I_CmsDateRestriction.TimeUnit>

Enum representing a time unit.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
DAYS	Days.
MONTHS	Months.
WEEKS	Weeks.
YEARS	Years.

Method Summary

Modifier and Type	Method	Description
String	formatForRange(int count)	Formats a positive integer amount of the given unit for use in Solr range queries.
static I_CmsDateRestriction.TimeUnit	valueOf(String name)	Returns the enum constant of this class with the specified name.
static I_CmsDateRestriction.TimeUnit[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

DAYS

public static final I_CmsDateRestriction.TimeUnit DAYS

Days.

WEEKS

public static final I_CmsDateRestriction.TimeUnit WEEKS

Weeks.

MONTHS

public static final I_CmsDateRestriction.TimeUnit MONTHS

Months.

YEARS

public static final I_CmsDateRestriction.TimeUnit YEARS

Years.

Method Details

values

public static I_CmsDateRestriction.TimeUnit[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static I_CmsDateRestriction.TimeUnit valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

formatForRange

public String formatForRange(int count)

Formats a positive integer amount of the given unit for use in Solr range queries.

Parameters:

count - the number

Returns:

the formatted value