org.opencms.ui.apps.lists.daterestrictions

Enum I_CmsListDateRestriction.TimeUnit

java.lang.Object

java.lang.Enum<I_CmsListDateRestriction.TimeUnit>

org.opencms.ui.apps.lists.daterestrictions.I_CmsListDateRestriction.TimeUnit

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<I_CmsListDateRestriction.TimeUnit>

Enclosing interface:

I_CmsListDateRestriction

public static enum I_CmsListDateRestriction.TimeUnit
extends java.lang.Enum<I_CmsListDateRestriction.TimeUnit>

Enum representing a time unit.

Enum Constant Summary

Enum Constants

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

Method Summary

Modifier and Type	Method and Description
java.lang.String	formatForRange(int count) Formats a positive integer amount of the given unit for use in Solr range queries.
static I_CmsListDateRestriction.TimeUnit	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static I_CmsListDateRestriction.TimeUnit[]	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

DAYS

public static final I_CmsListDateRestriction.TimeUnit DAYS

Days.

WEEKS

public static final I_CmsListDateRestriction.TimeUnit WEEKS

Weeks.

MONTHS

public static final I_CmsListDateRestriction.TimeUnit MONTHS

Months.

YEARS

public static final I_CmsListDateRestriction.TimeUnit YEARS

Years.

Method Detail

values

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

Returns:

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

valueOf

public static I_CmsListDateRestriction.TimeUnit valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

formatForRange

public java.lang.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