org.apache.flink.table.utils

Enum DateTimeUtils.TimeUnit

java.lang.Object

java.lang.Enum<DateTimeUtils.TimeUnit>

org.apache.flink.table.utils.DateTimeUtils.TimeUnit

All Implemented Interfaces:

Serializable, Comparable<DateTimeUtils.TimeUnit>

Enclosing class:

DateTimeUtils

@Internal
public static enum DateTimeUtils.TimeUnit
extends Enum<DateTimeUtils.TimeUnit>

Enumeration of time units used to construct an interval.

Only YEAR, MONTH, DAY, HOUR, MINUTE, SECOND can be the unit of a SQL interval.

The others (QUARTER, WEEK, MILLISECOND, DOW, DOY, EPOCH, DECADE, CENTURY, MILLENNIUM, MICROSECOND, NANOSECOND, ISODOW and ISOYEAR) are convenient to use internally, when converting to and from UNIX timestamps. And also may be arguments to the EXTRACT, TIMESTAMPADD and TIMESTAMPDIFF functions.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CENTURY
DAY
DECADE
DOW
DOY
EPOCH
HOUR
ISODOW
ISOYEAR
MICROSECOND
MILLENNIUM
MILLISECOND
MINUTE
MONTH
NANOSECOND
QUARTER
SECOND
WEEK
YEAR

Field Summary

Fields

Modifier and Type	Field and Description
BigDecimal	multiplier
char	separator
boolean	yearMonth

Method Summary

Modifier and Type	Method and Description
static DateTimeUtils.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 DateTimeUtils.TimeUnit	valueOf(String name) Returns the enum constant of this type with the specified name.
static DateTimeUtils.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 DateTimeUtils.TimeUnit YEAR

MONTH

public static final DateTimeUtils.TimeUnit MONTH

DAY

public static final DateTimeUtils.TimeUnit DAY

HOUR

public static final DateTimeUtils.TimeUnit HOUR

MINUTE

public static final DateTimeUtils.TimeUnit MINUTE

SECOND

public static final DateTimeUtils.TimeUnit SECOND

QUARTER

public static final DateTimeUtils.TimeUnit QUARTER

ISOYEAR

public static final DateTimeUtils.TimeUnit ISOYEAR

WEEK

public static final DateTimeUtils.TimeUnit WEEK

MILLISECOND

public static final DateTimeUtils.TimeUnit MILLISECOND

MICROSECOND

public static final DateTimeUtils.TimeUnit MICROSECOND

NANOSECOND

public static final DateTimeUtils.TimeUnit NANOSECOND

DOW

public static final DateTimeUtils.TimeUnit DOW

ISODOW

public static final DateTimeUtils.TimeUnit ISODOW

DOY

public static final DateTimeUtils.TimeUnit DOY

EPOCH

public static final DateTimeUtils.TimeUnit EPOCH

DECADE

public static final DateTimeUtils.TimeUnit DECADE

CENTURY

public static final DateTimeUtils.TimeUnit CENTURY

MILLENNIUM

public static final DateTimeUtils.TimeUnit MILLENNIUM

Field Detail

yearMonth

public final boolean yearMonth

separator

public final char separator

multiplier

public final BigDecimal multiplier

Method Detail

values

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