Package org.apache.calcite.util.format

Enum FormatElementEnum

java.lang.Object

java.lang.Enum<FormatElementEnum>

org.apache.calcite.util.format.FormatElementEnum

All Implemented Interfaces:

Serializable, Comparable<FormatElementEnum>, Constable, FormatElement

public enum FormatElementEnum
extends Enum<FormatElementEnum>
implements FormatElement

Implementation of FormatElement containing the standard format elements. These are based on Oracle's format model documentation.

See Oracle format model reference.

See Also:

• FormatModels.DEFAULT

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
am_pm
AM_PM
ampm
AMPM
CC
D
day
Day
DAY
DD
DDD
dy
Dy
DY
E
FF1
FF2
FF3
FF4
FF5
FF6
FF7
FF8
FF9
HH12
HH24
ID
IW
IYY
IYYYY
MI
MM
mon
Mon
MON
month
Month
MONTH
MS
pctY
PM
Q
SS
SSSSS
TZR
W
WW
Y
YY
YYY
YYYY

Method Summary

Modifier and Type	Method	Description
String	getDescription()	Returns the description of an element.
void	toPattern(StringBuilder sb)	Adds the appropriate SimpleDateFormat pattern for the element to provided StringBuilder.
static FormatElementEnum	valueOf(String name)	Returns the enum constant of this type with the specified name.
static FormatElementEnum[]	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, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.calcite.util.format.FormatElement

flatten, format

Enum Constant Details

CC

public static final FormatElementEnum CC

D

public static final FormatElementEnum D

DAY

public static final FormatElementEnum DAY

Day

public static final FormatElementEnum Day

day

public static final FormatElementEnum day

DD

public static final FormatElementEnum DD

DDD

public static final FormatElementEnum DDD

DY

public static final FormatElementEnum DY

Dy

public static final FormatElementEnum Dy

dy

public static final FormatElementEnum dy

E

public static final FormatElementEnum E

FF1

public static final FormatElementEnum FF1

FF2

public static final FormatElementEnum FF2

FF3

public static final FormatElementEnum FF3

FF4

public static final FormatElementEnum FF4

FF5

public static final FormatElementEnum FF5

FF6

public static final FormatElementEnum FF6

FF7

public static final FormatElementEnum FF7

FF8

public static final FormatElementEnum FF8

FF9

public static final FormatElementEnum FF9

HH12

public static final FormatElementEnum HH12

HH24

public static final FormatElementEnum HH24

ID

public static final FormatElementEnum ID

IW

public static final FormatElementEnum IW

IYY

public static final FormatElementEnum IYY

IYYYY

public static final FormatElementEnum IYYYY

MI

public static final FormatElementEnum MI

MM

public static final FormatElementEnum MM

MON

public static final FormatElementEnum MON

Mon

public static final FormatElementEnum Mon

mon

public static final FormatElementEnum mon

MONTH

public static final FormatElementEnum MONTH

Month

public static final FormatElementEnum Month

month

public static final FormatElementEnum month

PM

public static final FormatElementEnum PM

Q

public static final FormatElementEnum Q

AMPM

public static final FormatElementEnum AMPM

AM_PM

public static final FormatElementEnum AM_PM

ampm

public static final FormatElementEnum ampm

am_pm

public static final FormatElementEnum am_pm

MS

public static final FormatElementEnum MS

SS

public static final FormatElementEnum SS

SSSSS

public static final FormatElementEnum SSSSS

TZR

public static final FormatElementEnum TZR

W

public static final FormatElementEnum W

WW

public static final FormatElementEnum WW

Y

public static final FormatElementEnum Y

YY

public static final FormatElementEnum YY

YYY

public static final FormatElementEnum YYY

YYYY

public static final FormatElementEnum YYYY

pctY

public static final FormatElementEnum pctY

Method Details

values

public static FormatElementEnum[] values()

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

Returns:

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

valueOf

public static FormatElementEnum 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

getDescription

public String getDescription()

Description copied from interface: FormatElement

Returns the description of an element.

For example, %H in MySQL represents the hour in 24-hour format (e.g., 00..23). This method returns the string "The hour (24-hour clock) as a decimal number (00-23)", which is the description of HH24.

Specified by:

getDescription in interface FormatElement

toPattern

public void toPattern(StringBuilder sb)

Description copied from interface: FormatElement

Adds the appropriate SimpleDateFormat pattern for the element to provided StringBuilder.

Note that certain FormatElements may not have a Java equivalent. In such cases, calling this method will throw an UnsupportedOperationException. See Q as an example.

Specified by:

toPattern in interface FormatElement