Enum 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:
java.io.Serializable
,java.lang.Comparable<I_CmsDateRestriction.TimeUnit>
- Enclosing interface:
- I_CmsDateRestriction
public static enum I_CmsDateRestriction.TimeUnit extends java.lang.Enum<I_CmsDateRestriction.TimeUnit>
Enum representing a time unit.
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
formatForRange(int count)
Formats a positive integer amount of the given unit for use in Solr range queries.static I_CmsDateRestriction.TimeUnit
valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name.static I_CmsDateRestriction.TimeUnit[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
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 Detail
-
values
public static I_CmsDateRestriction.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_CmsDateRestriction.TimeUnit c : I_CmsDateRestriction.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_CmsDateRestriction.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 namejava.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
-
-