org.seasar.doma.jdbc
インタフェース Sql<P extends SqlParameter>

型パラメータ:

P - パラメータの種別を表す型

public interface Sql<P extends SqlParameter>

SQLを表します。

SQLとSQL実行時のパラメータをカプセル化します。また、SQLのバインド変数をパラメータで置換した文字列やSQLファイルのパスを保持します。

このインタフェースの実装はスレッドセーフであることを要求されません。

作成者:

taedium

メソッドの概要

String	getFormattedSql() フォーマット済みSQLを返します。
SqlKind	getKind() SQLの種別を返します。
List<P>	getParameters() バインド変数へのパラメータのリストを返します。
String	getRawSql() 未加工SQLを返します。
String	getSqlFilePath() 未加工SQLが記述されているSQLファイルのパスを返します。

メソッドの詳細

getKind

SqlKind getKind()

SQLの種別を返します。

戻り値:

SQLの種別

getRawSql

String getRawSql()

未加工SQLを返します。

バインド変数は ? で表されます。

戻り値:

未加工SQL

getFormattedSql

String getFormattedSql()

フォーマット済みSQLを返します。

バインド変数 ? が、 SqlLogFormattingVisitor の実装によって適切な文字列に置換されたSQLです。

戻り値:

フォーマット済みSQL

getSqlFilePath

String getSqlFilePath()

未加工SQLが記述されているSQLファイルのパスを返します。

戻り値:

SQLファイルのパス、SQLが自動生成された場合は null

getParameters

List<P> getParameters()

バインド変数へのパラメータのリストを返します。

戻り値:

バインド変数のパラメータのリスト