org.seasar.doma.jdbc.builder

Class DeleteBuilder

java.lang.Object

org.seasar.doma.jdbc.builder.DeleteBuilder

public class DeleteBuilder
extends java.lang.Object

A builder for an SQL DELETE statement.

This is not thread safe.

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();
 

built SQL

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

Method Summary

Modifier and Type	Method and Description
void	callerClassName(java.lang.String className) Sets the caller class name.
void	callerMethodName(java.lang.String methodName) Sets the caller method name.
int	execute() Executes an SQL DELETE statement.
Sql<?>	getSql() Returns the built SQL.
<P> DeleteBuilder	literal(java.lang.Class<P> paramClass, P param) Appends a parameter as literal.
<E> DeleteBuilder	literals(java.lang.Class<E> elementClass, java.util.List<E> params) Appends a parameter list as literal.
static DeleteBuilder	newInstance(Config config) Creates a new instance.
<P> DeleteBuilder	param(java.lang.Class<P> paramClass, P param) Appends a parameter.
<E> DeleteBuilder	params(java.lang.Class<E> elementClass, java.util.List<E> params) Appends a parameter list.
void	queryTimeout(int queryTimeout) Sets the query timeout limit in seconds.
DeleteBuilder	removeLast() Removes the last SQL fragment or parameter.
DeleteBuilder	sql(java.lang.String sql) Appends an SQL fragment.
void	sqlLogType(SqlLogType sqlLogType) Sets the SQL log format.

Methods inherited from class java.lang.Object

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

Method Detail

newInstance

public static DeleteBuilder newInstance(Config config)

Creates a new instance.

Parameters:

config - the configuration

Returns:

a builder

Throws:

DomaNullPointerException - if config is null

sql

public DeleteBuilder sql(java.lang.String sql)

Appends an SQL fragment.

Parameters:

sql - the SQL fragment

Returns:

a builder

Throws:

DomaNullPointerException - if sql is null

removeLast

public DeleteBuilder removeLast()

Removes the last SQL fragment or parameter.

Returns:

a builder

param

public <P> DeleteBuilder param(java.lang.Class<P> paramClass,
                               P param)

Appends a parameter.

The parameter type must be one of basic types or holder types.

Type Parameters:

P - the parameter type

Parameters:

paramClass - the parameter class

param - the parameter

Returns:

a builder

Throws:

DomaNullPointerException - if paramClass is null

params

public <E> DeleteBuilder params(java.lang.Class<E> elementClass,
                                java.util.List<E> params)

Appends a parameter list.

The element type of the list must be one of basic types or holder types.

Type Parameters:

E - the element type of the list

Parameters:

elementClass - the element class of the list

params - the parameter list

Returns:

a builder

Throws:

DomaNullPointerException - if elementClass or params is null

literal

public <P> DeleteBuilder literal(java.lang.Class<P> paramClass,
                                 P param)

Appends a parameter as literal.

The parameter type must be one of basic types or holder types.

Type Parameters:

P - the parameter type

Parameters:

paramClass - the parameter class

param - the parameter

Returns:

a builder

Throws:

DomaNullPointerException - if paramClass is null

literals

public <E> DeleteBuilder literals(java.lang.Class<E> elementClass,
                                  java.util.List<E> params)

Appends a parameter list as literal.

The element type of the list must be one of basic types or holder types.

Type Parameters:

E - the element type of the list

Parameters:

elementClass - the element class of the list

params - the parameter list

Returns:

a builder

Throws:

DomaNullPointerException - if elementClass or params is null

execute

public int execute()

Executes an SQL DELETE statement.

Returns:

the affected rows count

Throws:

JdbcException - if a JDBC related error occurs

queryTimeout

public void queryTimeout(int queryTimeout)

Sets the query timeout limit in seconds.

If not specified, the value of Config.getQueryTimeout() is used.

Parameters:

queryTimeout - the query timeout limit in seconds

See Also:

Statement.setQueryTimeout(int)

sqlLogType

public void sqlLogType(SqlLogType sqlLogType)

Sets the SQL log format.

Parameters:

sqlLogType - the SQL log format type

callerClassName

public void callerClassName(java.lang.String className)

Sets the caller class name.

If not specified, the class name of this instance is used.

Parameters:

className - the caller class name

Throws:

DomaNullPointerException - if className is null

callerMethodName

public void callerMethodName(java.lang.String methodName)

Sets the caller method name.

if not specified, execute is used.

Parameters:

methodName - the caller method name

Throws:

DomaNullPointerException - if methodName is null

getSql

public Sql<?> getSql()

Returns the built SQL.

Returns:

the built SQL