Module org.seasar.doma.core

Package 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 Object
implements Sql<P>

A skeletal implementation of the Sql interface.

Field Summary

Fields

Modifier and Type	Field	Description
protected final String	formattedSql
protected final SqlKind	kind
protected final List<P>	parameters
protected final String	rawSql
protected final String	sqlFilePath
protected final SqlLogType	sqlLogType

Constructor Summary

Constructors

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

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Details

kind

protected final SqlKind kind

rawSql

protected final String rawSql

formattedSql

protected final String formattedSql

sqlFilePath

protected final String sqlFilePath

parameters

protected final List<P extends SqlParameter> parameters

sqlLogType

protected final SqlLogType sqlLogType

Constructor Details

AbstractSql

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

Method Details

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 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 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 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 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 String toString()

Overrides:

toString in class Object