Package org.apache.ibatis.annotations

Annotation Interface DeleteProvider

@Documented
@Retention(RUNTIME)
@Target(METHOD)
@Repeatable(DeleteProvider.List.class)
public @interface DeleteProvider

The annotation that specify a method that provide an SQL for deleting record(s).

How to use:

 public interface UserMapper {

   @DeleteProvider(type = SqlProvider.class, method = "deleteById")
   boolean deleteById(int id);

   public static class SqlProvider {
     public static String deleteById() {
       return "DELETE FROM users WHERE id = #{id}";
     }
   }

 }
 

Author:

Clinton Begin

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static @interface	DeleteProvider.List	The container annotation for DeleteProvider.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
String	databaseId
String	method	Specify a method for providing an SQL.
Class<?>	type	Specify a type that implements an SQL provider method.
Class<?>	value	Specify a type that implements an SQL provider method.

Element Details

value

Class<?> value

Specify a type that implements an SQL provider method.

Returns:

a type that implements an SQL provider method

Since:

3.5.2

See Also:

• type()

Default:

void.class

type

Class<?> type

Specify a type that implements an SQL provider method.

This attribute is alias of value().

Returns:

a type that implements an SQL provider method

See Also:

• value()

Default:

void.class

method

String method

Specify a method for providing an SQL.

Since 3.5.1, this attribute can omit.

If this attribute omit, the MyBatis will call a method that decide by following rules.

• If class that specified the type() attribute implements the ProviderMethodResolver, the MyBatis use a method that returned by it
• If cannot resolve a method by ProviderMethodResolver(= not implement it or it was returned null), the MyBatis will search and use a fallback method that named provideSql from specified type

Returns:

a method name of method for providing an SQL

Default:

""

databaseId

String databaseId

Returns:

A database id that correspond this provider

Since:

3.5.5

Default:

""