org.apache.calcite.avatica.util

Enum TimeUnit

java.lang.Object

java.lang.Enum<TimeUnit>

org.apache.calcite.avatica.util.TimeUnit

All Implemented Interfaces:

Serializable, Comparable<TimeUnit>

public enum TimeUnit
extends Enum<TimeUnit>

Enumeration of time units used to construct an interval.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DAY
HOUR
MILLISECOND Unlike the other units, MILLISECOND may not be the unit of a SQL interval.
MINUTE
MONTH
SECOND
YEAR

Field Summary

Fields

Modifier and Type	Field and Description
private static TimeUnit[]	CACHED_VALUES
private BigDecimal	limit
long	multiplier
char	separator
boolean	yearMonth

Method Summary

Methods

Modifier and Type	Method and Description
static TimeUnit	getValue(int ordinal) Returns the TimeUnit associated with an ordinal.
boolean	isValidValue(BigDecimal field) Returns whether a given value is valid for a field of this time unit.
static TimeUnit	valueOf(String name) Returns the enum constant of this type with the specified name.
static 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

YEAR

public static final TimeUnit YEAR

MONTH

public static final TimeUnit MONTH

DAY

public static final TimeUnit DAY

HOUR

public static final TimeUnit HOUR

MINUTE

public static final TimeUnit MINUTE

SECOND

public static final TimeUnit SECOND

MILLISECOND

public static final TimeUnit MILLISECOND

Unlike the other units, MILLISECOND may not be the unit of a SQL interval. Still, it is convenient to use it internally, when converting to and from UNIX timestamps.

Field Detail

yearMonth

public final boolean yearMonth

separator

public final char separator

multiplier

public final long multiplier

limit

private final BigDecimal limit

CACHED_VALUES

private static final TimeUnit[] CACHED_VALUES

Method Detail

values

public static 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 (TimeUnit c : 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 TimeUnit 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

getValue

public static TimeUnit getValue(int ordinal)

Returns the TimeUnit associated with an ordinal. The value returned is null if the ordinal is not a member of the TimeUnit enumeration.

isValidValue

public boolean isValidValue(BigDecimal field)

Returns whether a given value is valid for a field of this time unit.

Parameters:

field - Field value

Returns:

Whether value