Module org.seasar.doma.core

Package org.seasar.doma.jdbc

Enum Class SqlLogType

java.lang.Object

java.lang.Enum<SqlLogType>

org.seasar.doma.jdbc.SqlLogType

All Implemented Interfaces:

Serializable, Comparable<SqlLogType>, Constable

public enum SqlLogType
extends Enum<SqlLogType>

Defines the output formats for SQL logs.

This enum controls how SQL statements and their parameters are formatted when logged by the Doma framework.

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
FORMATTED	The formatted SQL.
NONE	No output.
RAW	The raw SQL.

Method Summary

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

RAW

public static final SqlLogType RAW

The raw SQL.

The bind variables are displayed as ?.

FORMATTED

public static final SqlLogType FORMATTED

The formatted SQL.

The bind variables are replaced with the string representations of the parameters. The string representations is determined by the object that is return from Dialect.getSqlLogFormattingVisitor().

NONE

public static final SqlLogType NONE

No output.

Method Details

values

public static SqlLogType[] 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 SqlLogType 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