Package org.hibernate.engine.jdbc.internal

Enum Class FormatStyle

java.lang.Object

java.lang.Enum<FormatStyle>

org.hibernate.engine.jdbc.internal.FormatStyle

All Implemented Interfaces:

Serializable, Comparable<FormatStyle>, Constable

public enum FormatStyle
extends Enum<FormatStyle>

Represents the understood types or styles of formatting.

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
BASIC	Formatting for SELECT, INSERT, UPDATE and DELETE statements
DDL	Formatting for DDL (CREATE, ALTER, DROP, etc) statements
HIGHLIGHT	Syntax highlighting via ANSI escape codes
NONE	No formatting

Method Summary

Modifier and Type	Method	Description
Formatter	getFormatter()
String	getName()
static FormatStyle	valueOf(String name)	Returns the enum constant of this class with the specified name.
static FormatStyle[]	values()	Returns an array containing the constants of this enum class, 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

Enum Constant Details

BASIC

public static final FormatStyle BASIC

Formatting for SELECT, INSERT, UPDATE and DELETE statements

DDL

public static final FormatStyle DDL

Formatting for DDL (CREATE, ALTER, DROP, etc) statements

HIGHLIGHT

public static final FormatStyle HIGHLIGHT

Syntax highlighting via ANSI escape codes

NONE

public static final FormatStyle NONE

No formatting

Method Details

values

public static FormatStyle[] values()

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

Returns:

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

valueOf

public static FormatStyle valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

getName

public String getName()

getFormatter

public Formatter getFormatter()