org.seasar.doma.jdbc

Class AbstractSql<P extends SqlParameter>

java.lang.Object

org.seasar.doma.jdbc.AbstractSql<P>

All Implemented Interfaces:

Sql<P>

Direct Known Subclasses:

CallableSql, PreparedSql, ScriptCommand.ScriptSql

public abstract class AbstractSql<P extends SqlParameter>
extends java.lang.Object
implements Sql<P>

A skeletal implementation of the Sql interface.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	formattedSql
protected SqlKind	kind
protected java.util.List<P>	parameters
protected java.lang.String	rawSql
protected java.lang.String	sqlFilePath
protected SqlLogType	sqlLogType

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractSql(SqlKind kind, java.lang.CharSequence rawSql, java.lang.CharSequence formattedSql, java.lang.String sqlFilePath, java.util.List<? extends P> parameters, SqlLogType sqlLogType, java.util.function.Function<java.lang.String,java.lang.String> commenter)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getFormattedSql() Returns the formatted SQL string.
SqlKind	getKind() Returns the kind of the SQL.
java.util.List<P>	getParameters() Returns the parameter list.
java.lang.String	getRawSql() Returns the raw SQL string.
java.lang.String	getSqlFilePath() Returns the file path that contains this SQL.
SqlLogType	getSqlLogType() Returns the type of the SQL log.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

kind

protected final SqlKind kind

rawSql

protected final java.lang.String rawSql

formattedSql

protected final java.lang.String formattedSql

sqlFilePath

protected final java.lang.String sqlFilePath

parameters

protected final java.util.List<P extends SqlParameter> parameters

sqlLogType

protected final SqlLogType sqlLogType

Constructor Detail

AbstractSql

protected AbstractSql(SqlKind kind,
                      java.lang.CharSequence rawSql,
                      java.lang.CharSequence formattedSql,
                      java.lang.String sqlFilePath,
                      java.util.List<? extends P> parameters,
                      SqlLogType sqlLogType,
                      java.util.function.Function<java.lang.String,java.lang.String> commenter)

Method Detail

getKind

public SqlKind getKind()

Description copied from interface: Sql

Returns the kind of the SQL.

Specified by:

getKind in interface Sql<P extends SqlParameter>

Returns:

the kind of the SQL

getRawSql

public java.lang.String getRawSql()

Description copied from interface: Sql

Returns the raw SQL string.

The bind variables are displayed as ?.

Specified by:

getRawSql in interface Sql<P extends SqlParameter>

Returns:

the raw SQL string

getFormattedSql

public java.lang.String getFormattedSql()

Description copied from interface: Sql

Returns the formatted SQL string.

The bind variables are replaced with the string representations of the parameters.

Specified by:

getFormattedSql in interface Sql<P extends SqlParameter>

Returns:

the formatted SQL string

getSqlFilePath

public java.lang.String getSqlFilePath()

Description copied from interface: Sql

Returns the file path that contains this SQL.

Specified by:

getSqlFilePath in interface Sql<P extends SqlParameter>

Returns:

the file path that contains this SQL、or null if this SQL is auto-generated

getParameters

public java.util.List<P> getParameters()

Description copied from interface: Sql

Returns the parameter list.

Specified by:

getParameters in interface Sql<P extends SqlParameter>

Returns:

the parameter list

getSqlLogType

public SqlLogType getSqlLogType()

Description copied from interface: Sql

Returns the type of the SQL log.

Specified by:

getSqlLogType in interface Sql<P extends SqlParameter>

Returns:

the type of the SQL log

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object