org.seasar.doma.jdbc.builder
クラス DeleteBuilder

java.lang.Object
  org.seasar.doma.jdbc.builder.DeleteBuilder

public class DeleteBuilder
extends Object

DELETE文を組み立て実行するクラスです。

このクラスはスレッドセーフではありません。

例

Java

 DeleteBuilder builder = DeleteBuilder.newInstance(config);
 builder.sql("delete from Emp");
 builder.sql("where");
 builder.sql("name = ").param(String.class, "SMITH");
 builder.sql("and");
 builder.sql("salary = ").param(BigDecimal.class, new BigDecimal(1000));
 builder.execute();
 

実行されるSQL

 delete from Emp
 where
 name = 'SMITH'
 and
 salary = 1000
 

導入されたバージョン:

1.8.0

作成者:

taedium

メソッドの概要

void	callerClassName(String className) 呼び出し元のクラス名です。
void	callerMethodName(String methodName) 呼び出し元のメソッド名です。
int	execute() SQLを実行します。
Sql<?>	getSql() 組み立てられたSQLを返します。
static DeleteBuilder	newInstance(Config config) ファクトリメソッドです。
<P> DeleteBuilder	param(Class<P> paramClass, P param) パラメータを追加します。
void	queryTimeout(int queryTimeout) クエリタイムアウト（秒）を設定します。
DeleteBuilder	removeLast() 最後に追加したSQLもしくはパラメータを削除します。
DeleteBuilder	sql(String sql) SQLの断片を追加します。

クラス java.lang.Object から継承されたメソッド

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

メソッドの詳細

newInstance

public static DeleteBuilder newInstance(Config config)

ファクトリメソッドです。

パラメータ:

config - 設定

戻り値:

DELETE文を組み立てるビルダー

例外:

DomaNullPointerException - 引数がnull の場合

sql

public DeleteBuilder sql(String sql)

SQLの断片を追加します。

パラメータ:

sql - SQLの断片

戻り値:

このインスタンス

例外:

DomaNullPointerException - 引数が null の場合

removeLast

public DeleteBuilder removeLast()

最後に追加したSQLもしくはパラメータを削除します。

戻り値:

このインスタンス

param

public <P> DeleteBuilder param(Class<P> paramClass,
                               P param)

パラメータを追加します。

パラメータの型には、基本型とドメインクラスを指定できます。

型パラメータ:

P - パラメータの型

パラメータ:

paramClass - パラメータのクラス

param - パラメータ

戻り値:

このインスタンス

例外:

DomaNullPointerException - parameterClass が null の場合

execute

public int execute()

SQLを実行します。

戻り値:

更新件数

例外:

JdbcException - JDBCに関する例外が発生した場合

queryTimeout

public void queryTimeout(int queryTimeout)

クエリタイムアウト（秒）を設定します。

指定しない場合、 Config.getQueryTimeout() が使用されます。

パラメータ:

queryTimeout - クエリタイムアウト（秒）

関連項目:

Statement.setQueryTimeout(int)

callerClassName

public void callerClassName(String className)

呼び出し元のクラス名です。

指定しない場合このクラスの名前が使用されます。

パラメータ:

className - 呼び出し元のクラス名

例外:

DomaNullPointerException - 引数が null の場合

callerMethodName

public void callerMethodName(String methodName)

呼び出し元のメソッド名です。

指定しない場合このSQLを生成するメソッド（execute())）の名前が使用されます。

パラメータ:

methodName - 呼び出し元のメソッド名

例外:

DomaNullPointerException - 引数が null の場合

getSql

public Sql<?> getSql()

組み立てられたSQLを返します。

戻り値:

組み立てられたSQL