org.apache.calcite.sql

Enum SqlWriterConfig.LineFolding

java.lang.Object

java.lang.Enum<SqlWriterConfig.LineFolding>

org.apache.calcite.sql.SqlWriterConfig.LineFolding

All Implemented Interfaces:

Serializable, Comparable<SqlWriterConfig.LineFolding>

Enclosing interface:

SqlWriterConfig

public static enum SqlWriterConfig.LineFolding
extends Enum<SqlWriterConfig.LineFolding>

Policy for how to do deal with long lines.

The following examples all have ClauseEndsLine=true, Indentation=4, and FoldLength=25 (so that the long SELECT clause folds but the shorter GROUP BY clause does not).

Note that ClauseEndsLine is observed in STEP and TALL modes, and in CHOP mode when a line is long.

SQL formatted with each Folding value

Folding	Example
WIDE	SELECT abc, def, ghi, jkl, mno, pqr FROM t GROUP BY abc, def
STEP	SELECT abc, def, ghi, jkl, mno, pqr FROM t GROUP BY abc, def
FOLD	SELECT abc, def, ghi, jkl, mno, pqr FROM t GROUP BY abc, def
CHOP	SELECT abc, def, ghi, jkl, mno, pqr FROM t GROUP BY abc, def
TALL	SELECT abc, def, ghi, jkl, mno, pqr FROM t GROUP BY abc, def

Enum Constant Summary

Enum Constants

Enum Constant and Description
CHOP Chop down if long.
FOLD Wrap if long.
STEP As WIDE but start a new line if SqlWriterConfig.clauseEndsLine().
TALL Wrap always.
WIDE Do not wrap.

Method Summary

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

WIDE

public static final SqlWriterConfig.LineFolding WIDE

Do not wrap. Items are on the same line, regardless of length.

STEP

public static final SqlWriterConfig.LineFolding STEP

As WIDE but start a new line if SqlWriterConfig.clauseEndsLine().

FOLD

public static final SqlWriterConfig.LineFolding FOLD

Wrap if long. Items are on the same line, but if the line's length exceeds SqlWriterConfig.foldLength(), move items to the next line.

CHOP

public static final SqlWriterConfig.LineFolding CHOP

Chop down if long. Items are on the same line, but if the line grows longer than SqlWriterConfig.foldLength(), put all items on separate lines.

TALL

public static final SqlWriterConfig.LineFolding TALL

Wrap always. Items are on separate lines.

Method Detail

values

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

Returns:

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

valueOf

public static SqlWriterConfig.LineFolding 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