+ * How to use: + * + *
+ * public class User {
+ *
+ * private int id;
+ * private String name;
+ *
+ * public User(int id) {
+ * this.id = id;
+ * }
+ *
+ * @AutomapConstructor
+ * public User(int id, String name) {
+ * this.id = id;
+ * this.name = name;
+ * }
+ * // ...
+ * }
+ *
+ *
+ * @author Tim Chen
+ * @since 3.4.3
+ */
+@Documented
+@Retention(RetentionPolicy.RUNTIME)
+@Target({ ElementType.CONSTRUCTOR })
+public @interface AutomapConstructor {
+}
diff --git a/src/main/java/org/apache/ibatis/annotations/CacheNamespace.java b/src/main/java/org/apache/ibatis/annotations/CacheNamespace.java
index a7d5c69b73f..5d1616bf88e 100644
--- a/src/main/java/org/apache/ibatis/annotations/CacheNamespace.java
+++ b/src/main/java/org/apache/ibatis/annotations/CacheNamespace.java
@@ -1,5 +1,5 @@
/**
- * Copyright 2009-2015 the original author or authors.
+ * Copyright 2009-2020 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -15,30 +15,89 @@
*/
package org.apache.ibatis.annotations;
+import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
+import org.apache.ibatis.cache.Cache;
import org.apache.ibatis.cache.decorators.LruCache;
import org.apache.ibatis.cache.impl.PerpetualCache;
/**
+ * The annotation that specify to use cache on namespace(e.g. mapper interface).
+ *
+ * + * How to use: + * + *
+ * @CacheNamespace(implementation = CustomCache.class, properties = {
+ * @Property(name = "host", value = "${mybatis.cache.host}"),
+ * @Property(name = "port", value = "${mybatis.cache.port}"),
+ * @Property(name = "name", value = "usersCache")
+ * })
+ * public interface UserMapper {
+ * // ...
+ * }
+ *
+ *
* @author Clinton Begin
+ * @author Kazuki Shimizu
*/
+@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
public @interface CacheNamespace {
- Class implementation() default PerpetualCache.class;
- Class eviction() default LruCache.class;
+ /**
+ * Returns the cache implementation type to use.
+ *
+ * @return the cache implementation type
+ */
+ Class implementation() default PerpetualCache.class;
+
+ /**
+ * Returns the cache evicting implementation type to use.
+ *
+ * @return the cache evicting implementation type
+ */
+ Class eviction() default LruCache.class;
+ /**
+ * Returns the flush interval.
+ *
+ * @return the flush interval
+ */
long flushInterval() default 0;
+ /**
+ * Return the cache size.
+ *
+ * @return the cache size
+ */
int size() default 1024;
+ /**
+ * Returns whether use read/write cache.
+ *
+ * @return {@code true} if use read/write cache; {@code false} if otherwise
+ */
boolean readWrite() default true;
-
+
+ /**
+ * Returns whether block the cache at request time or not.
+ *
+ * @return {@code true} if block the cache; {@code false} if otherwise
+ */
boolean blocking() default false;
-
+
+ /**
+ * Returns property values for a implementation object.
+ *
+ * @return property values
+ * @since 3.4.2
+ */
+ Property[] properties() default {};
+
}
diff --git a/src/main/java/org/apache/ibatis/annotations/CacheNamespaceRef.java b/src/main/java/org/apache/ibatis/annotations/CacheNamespaceRef.java
index 7e4c1a79b9d..cc8e3ebf3e7 100644
--- a/src/main/java/org/apache/ibatis/annotations/CacheNamespaceRef.java
+++ b/src/main/java/org/apache/ibatis/annotations/CacheNamespaceRef.java
@@ -1,5 +1,5 @@
/**
- * Copyright 2009-2015 the original author or authors.
+ * Copyright 2009-2020 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -15,16 +15,47 @@
*/
package org.apache.ibatis.annotations;
+import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
+ * The annotation that reference a cache.
+ *
+ * If you use this annotation, should be specified either {@link #value()} or {@link #name()} attribute. + * + *
+ * How to use: + * + *
+ * @CacheNamespaceRef(UserMapper.class)
+ * public interface AdminUserMapper {
+ * // ...
+ * }
+ *
+ *
* @author Clinton Begin
+ * @author Kazuki Shimizu
*/
+@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
public @interface CacheNamespaceRef {
- Class value();
+
+ /**
+ * Returns the namespace type to reference a cache (the namespace name become a FQCN of specified type).
+ *
+ * @return the namespace type to reference a cache
+ */
+ Class value() default void.class;
+
+ /**
+ * Returns the namespace name to reference a cache.
+ *
+ * @return the namespace name
+ * @since 3.4.2
+ */
+ String name() default "";
}
diff --git a/src/main/java/org/apache/ibatis/annotations/Case.java b/src/main/java/org/apache/ibatis/annotations/Case.java
index fd7a8a8371a..544448b5565 100644
--- a/src/main/java/org/apache/ibatis/annotations/Case.java
+++ b/src/main/java/org/apache/ibatis/annotations/Case.java
@@ -1,5 +1,5 @@
/**
- * Copyright 2009-2015 the original author or authors.
+ * Copyright 2009-2019 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -15,22 +15,52 @@
*/
package org.apache.ibatis.annotations;
-import java.lang.annotation.ElementType;
+import java.lang.annotation.Documented;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
+ * The annotation that conditional mapping definition for {@link TypeDiscriminator}.
+ *
+ * @see TypeDiscriminator
+ * @see Result
+ * @see Arg
+ * @see Results
+ * @see ConstructorArgs
* @author Clinton Begin
*/
+@Documented
@Retention(RetentionPolicy.RUNTIME)
-@Target(ElementType.METHOD)
+@Target({})
public @interface Case {
+
+ /**
+ * Return the condition value to apply this mapping.
+ *
+ * @return the condition value
+ */
String value();
+ /**
+ * Return the object type that create a object using this mapping.
+ *
+ * @return the object type
+ */
Class type();
+ /**
+ * Return mapping definitions for property.
+ *
+ * @return mapping definitions for property
+ */
Result[] results() default {};
+ /**
+ * Return mapping definitions for constructor.
+ *
+ * @return mapping definitions for constructor
+ */
Arg[] constructArgs() default {};
+
}
diff --git a/src/main/java/org/apache/ibatis/annotations/ConstructorArgs.java b/src/main/java/org/apache/ibatis/annotations/ConstructorArgs.java
index 2843143ec01..7fbec830083 100644
--- a/src/main/java/org/apache/ibatis/annotations/ConstructorArgs.java
+++ b/src/main/java/org/apache/ibatis/annotations/ConstructorArgs.java
@@ -1,5 +1,5 @@
/**
- * Copyright 2009-2015 the original author or authors.
+ * Copyright 2009-2020 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -15,16 +15,40 @@
*/
package org.apache.ibatis.annotations;
+import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
+ * The annotation that be grouping mapping definitions for constructor.
+ *
+ * + * How to use: + * + *
+ * public interface UserMapper {
+ * @ConstructorArgs({
+ * @Arg(column = "id", javaType = int.class, id = true),
+ * @Arg(column = "name", javaType = String.class),
+ * @Arg(javaType = UserEmail.class, select = "selectUserEmailById", column = "id")
+ * })
+ * @Select("SELECT id, name FROM users WHERE id = #{id}")
+ * User selectById(int id);
+ * }
+ *
+ *
* @author Clinton Begin
*/
+@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface ConstructorArgs {
+ /**
+ * Returns mapping definitions for constructor.
+ *
+ * @return mapping definitions
+ */
Arg[] value() default {};
}
diff --git a/src/main/java/org/apache/ibatis/annotations/Delete.java b/src/main/java/org/apache/ibatis/annotations/Delete.java
index 66ad85611dc..4801cbbf862 100644
--- a/src/main/java/org/apache/ibatis/annotations/Delete.java
+++ b/src/main/java/org/apache/ibatis/annotations/Delete.java
@@ -1,5 +1,5 @@
/**
- * Copyright 2009-2015 the original author or authors.
+ * Copyright 2009-2020 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -15,16 +15,56 @@
*/
package org.apache.ibatis.annotations;
+import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
+import java.lang.annotation.Repeatable;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
+ * The annotation that specify an SQL for deleting record(s).
+ *
+ * + * How to use: + * + *
+ * public interface UserMapper {
+ * @Delete("DELETE FROM users WHERE id = #{id}")
+ * boolean deleteById(int id);
+ * }
+ *
+ *
* @author Clinton Begin
*/
+@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
+@Repeatable(Delete.List.class)
public @interface Delete {
+ /**
+ * Returns an SQL for deleting record(s).
+ *
+ * @return an SQL for deleting record(s)
+ */
String[] value();
+
+ /**
+ * @return A database id that correspond this statement
+ * @since 3.5.5
+ */
+ String databaseId() default "";
+
+ /**
+ * The container annotation for {@link Delete}.
+ * @author Kazuki Shimizu
+ * @since 3.5.5
+ */
+ @Documented
+ @Retention(RetentionPolicy.RUNTIME)
+ @Target(ElementType.METHOD)
+ @interface List {
+ Delete[] value();
+ }
+
}
diff --git a/src/main/java/org/apache/ibatis/annotations/DeleteProvider.java b/src/main/java/org/apache/ibatis/annotations/DeleteProvider.java
index 0f2be2646a0..c7833c3394a 100644
--- a/src/main/java/org/apache/ibatis/annotations/DeleteProvider.java
+++ b/src/main/java/org/apache/ibatis/annotations/DeleteProvider.java
@@ -1,5 +1,5 @@
/**
- * Copyright 2009-2015 the original author or authors.
+ * Copyright 2009-2020 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -15,18 +15,100 @@
*/
package org.apache.ibatis.annotations;
+import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
+import java.lang.annotation.Repeatable;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
+ * 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
*/
+@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
+@Repeatable(DeleteProvider.List.class)
public @interface DeleteProvider {
- Class type();
- String method();
+ /**
+ * Specify a type that implements an SQL provider method.
+ *
+ * @return a type that implements an SQL provider method
+ * @since 3.5.2
+ * @see #type()
+ */
+ Class value() default void.class;
+
+ /**
+ * Specify a type that implements an SQL provider method.
+ * + * This attribute is alias of {@link #value()}. + *
+ * + * @return a type that implements an SQL provider method + * @see #value() + */ + Class type() default void.class; + + /** + * 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. + *
+ * How to use: + * + *
+ * public interface UserMapper {
+ * @Flush
+ * List<BatchResult> flush();
+ * }
+ *
+ *
+ * @since 3.3.0
* @author Kazuki Shimizu
*/
+@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface Flush {
diff --git a/src/main/java/org/apache/ibatis/annotations/Insert.java b/src/main/java/org/apache/ibatis/annotations/Insert.java
index 5e000e074d8..0fa6ebe48a2 100644
--- a/src/main/java/org/apache/ibatis/annotations/Insert.java
+++ b/src/main/java/org/apache/ibatis/annotations/Insert.java
@@ -1,5 +1,5 @@
/**
- * Copyright 2009-2015 the original author or authors.
+ * Copyright 2009-2020 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -15,16 +15,56 @@
*/
package org.apache.ibatis.annotations;
+import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
+import java.lang.annotation.Repeatable;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
+ * The annotation that specify an SQL for inserting record(s).
+ *
+ * + * How to use: + * + *
+ * public interface UserMapper {
+ * @Insert("INSERT INTO users (id, name) VALUES(#{id}, #{name})")
+ * void insert(User user);
+ * }
+ *
+ *
* @author Clinton Begin
*/
+@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
+@Repeatable(Insert.List.class)
public @interface Insert {
+ /**
+ * Returns an SQL for inserting record(s).
+ *
+ * @return an SQL for inserting record(s)
+ */
String[] value();
+
+ /**
+ * @return A database id that correspond this statement
+ * @since 3.5.5
+ */
+ String databaseId() default "";
+
+ /**
+ * The container annotation for {@link Insert}.
+ * @author Kazuki Shimizu
+ * @since 3.5.5
+ */
+ @Documented
+ @Retention(RetentionPolicy.RUNTIME)
+ @Target(ElementType.METHOD)
+ @interface List {
+ Insert[] value();
+ }
+
}
diff --git a/src/main/java/org/apache/ibatis/annotations/InsertProvider.java b/src/main/java/org/apache/ibatis/annotations/InsertProvider.java
index 3d51199592e..9d73a663e63 100644
--- a/src/main/java/org/apache/ibatis/annotations/InsertProvider.java
+++ b/src/main/java/org/apache/ibatis/annotations/InsertProvider.java
@@ -1,5 +1,5 @@
/**
- * Copyright 2009-2015 the original author or authors.
+ * Copyright 2009-2020 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -15,18 +15,100 @@
*/
package org.apache.ibatis.annotations;
+import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
+import java.lang.annotation.Repeatable;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
+ * The annotation that specify a method that provide an SQL for inserting record(s).
+ *
+ * + * How to use: + * + *
+ * public interface UserMapper {
+ *
+ * @InsertProvider(type = SqlProvider.class, method = "insert")
+ * void insert(User user);
+ *
+ * public static class SqlProvider {
+ * public static String insert() {
+ * return "INSERT INTO users (id, name) VALUES(#{id}, #{name})";
+ * }
+ * }
+ *
+ * }
+ *
+ *
* @author Clinton Begin
*/
+@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
+@Repeatable(InsertProvider.List.class)
public @interface InsertProvider {
- Class type();
- String method();
+ /**
+ * Specify a type that implements an SQL provider method.
+ *
+ * @return a type that implements an SQL provider method
+ * @since 3.5.2
+ * @see #type()
+ */
+ Class value() default void.class;
+
+ /**
+ * Specify a type that implements an SQL provider method.
+ * + * This attribute is alias of {@link #value()}. + *
+ * + * @return a type that implements an SQL provider method + * @see #value() + */ + Class type() default void.class; + + /** + * 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. + *
+ * How to use: + * + *
+ * public interface UserMapper {
+ * @Lang(MyXMLLanguageDriver.class)
+ * @Select("SELECT id, name FROM users WHERE id = #{id}")
+ * User selectById(int id);
+ * }
+ *
+ *
* @author Clinton Begin
*/
+@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface Lang {
- Class value();
+ /**
+ * Returns the {@link LanguageDriver} implementation type to use.
+ *
+ * @return the {@link LanguageDriver} implementation type
+ */
+ Class value();
}
diff --git a/src/main/java/org/apache/ibatis/annotations/Many.java b/src/main/java/org/apache/ibatis/annotations/Many.java
index 80b8df619cc..4d9fc229648 100644
--- a/src/main/java/org/apache/ibatis/annotations/Many.java
+++ b/src/main/java/org/apache/ibatis/annotations/Many.java
@@ -1,5 +1,5 @@
/**
- * Copyright 2009-2015 the original author or authors.
+ * Copyright 2009-2020 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -15,7 +15,7 @@
*/
package org.apache.ibatis.annotations;
-import java.lang.annotation.ElementType;
+import java.lang.annotation.Documented;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
@@ -23,13 +23,44 @@
import org.apache.ibatis.mapping.FetchType;
/**
+ * The annotation that specify the nested statement for retrieving collections.
+ *
+ * @see Result
+ * @see Results
* @author Clinton Begin
*/
+@Documented
@Retention(RetentionPolicy.RUNTIME)
-@Target(ElementType.METHOD)
+@Target({})
public @interface Many {
+ /**
+ * Returns the columnPrefix.
+ *
+ * @return the columnPrefix.
+ * @since 3.5.5
+ */
+ String columnPrefix() default "";
+
+ /**
+ * Returns the result map id used to map collection.
+ *
+ * @return the result map id
+ * @since 3.5.5
+ */
+ String resultMap() default "";
+
+ /**
+ * Returns the statement id that retrieves collection.
+ *
+ * @return the statement id
+ */
String select() default "";
+ /**
+ * Returns the fetch strategy for nested statement.
+ *
+ * @return the fetch strategy
+ */
FetchType fetchType() default FetchType.DEFAULT;
}
diff --git a/src/main/java/org/apache/ibatis/annotations/MapKey.java b/src/main/java/org/apache/ibatis/annotations/MapKey.java
index dd5d916d3e2..388438da615 100644
--- a/src/main/java/org/apache/ibatis/annotations/MapKey.java
+++ b/src/main/java/org/apache/ibatis/annotations/MapKey.java
@@ -1,5 +1,5 @@
/**
- * Copyright 2009-2015 the original author or authors.
+ * Copyright 2009-2020 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -15,16 +15,36 @@
*/
package org.apache.ibatis.annotations;
+import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
+ * The annotation that specify the property name(or column name) for a key value of {@link java.util.Map}.
+ *
+ * + * How to use: + * + *
+ * public interface UserMapper {
+ * @MapKey("id")
+ * @Select("SELECT id, name FROM users WHERE name LIKE #{name} || '%")
+ * Map<Integer, User> selectByStartingWithName(String name);
+ * }
+ *
+ *
* @author Clinton Begin
*/
+@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface MapKey {
+ /**
+ * Returns the property name(or column name) for a key value of {@link java.util.Map}.
+ *
+ * @return the property name(or column name)
+ */
String value();
}
diff --git a/src/main/java/org/apache/ibatis/annotations/Mapper.java b/src/main/java/org/apache/ibatis/annotations/Mapper.java
new file mode 100644
index 00000000000..f07835ac750
--- /dev/null
+++ b/src/main/java/org/apache/ibatis/annotations/Mapper.java
@@ -0,0 +1,46 @@
+/**
+ * Copyright 2009-2020 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.ibatis.annotations;
+
+import java.lang.annotation.Documented;
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Inherited;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+/**
+ * Marker interface for MyBatis mappers.
+ *
+ * + * How to use: + * + *
+ * @Mapper
+ * public interface UserMapper {
+ * // ...
+ * }
+ *
+ *
+ * @author Frank David Martínez
+ */
+@Documented
+@Inherited
+@Retention(RetentionPolicy.RUNTIME)
+@Target({ ElementType.TYPE, ElementType.METHOD, ElementType.FIELD, ElementType.PARAMETER })
+public @interface Mapper {
+ // Interface Mapper
+}
diff --git a/src/main/java/org/apache/ibatis/annotations/One.java b/src/main/java/org/apache/ibatis/annotations/One.java
index 137a271515c..8491a00dded 100644
--- a/src/main/java/org/apache/ibatis/annotations/One.java
+++ b/src/main/java/org/apache/ibatis/annotations/One.java
@@ -1,5 +1,5 @@
/**
- * Copyright 2009-2015 the original author or authors.
+ * Copyright 2009-2020 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -15,7 +15,7 @@
*/
package org.apache.ibatis.annotations;
-import java.lang.annotation.ElementType;
+import java.lang.annotation.Documented;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
@@ -23,13 +23,44 @@
import org.apache.ibatis.mapping.FetchType;
/**
+ * The annotation that specify the nested statement for retrieving single object.
+ *
+ * @see Result
+ * @see Results
* @author Clinton Begin
*/
+@Documented
@Retention(RetentionPolicy.RUNTIME)
-@Target(ElementType.METHOD)
+@Target({})
public @interface One {
+ /**
+ * Returns the columnPrefix.
+ *
+ * @return the columnPrefix.
+ * @since 3.5.5
+ */
+ String columnPrefix() default "";
+
+ /**
+ * Returns the result map id used to map single object.
+ *
+ * @return the result map id
+ * @since 3.5.5
+ */
+ String resultMap() default "";
+
+ /**
+ * Returns the statement id that retrieves single object.
+ *
+ * @return the statement id
+ */
String select() default "";
+ /**
+ * Returns the fetch strategy for nested statement.
+ *
+ * @return the fetch strategy
+ */
FetchType fetchType() default FetchType.DEFAULT;
}
diff --git a/src/main/java/org/apache/ibatis/annotations/Options.java b/src/main/java/org/apache/ibatis/annotations/Options.java
index 671fa194706..80d6b492718 100644
--- a/src/main/java/org/apache/ibatis/annotations/Options.java
+++ b/src/main/java/org/apache/ibatis/annotations/Options.java
@@ -1,5 +1,5 @@
/**
- * Copyright 2009-2015 the original author or authors.
+ * Copyright 2009-2020 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -15,7 +15,9 @@
*/
package org.apache.ibatis.annotations;
+import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
+import java.lang.annotation.Repeatable;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
@@ -24,26 +26,134 @@
import org.apache.ibatis.mapping.StatementType;
/**
+ * The annotation that specify options for customizing default behaviors.
+ *
+ * + * How to use: + * + *
+ * public interface UserMapper {
+ * @Options(useGeneratedKeys = true, keyProperty = "id")
+ * @Insert("INSERT INTO users (name) VALUES(#{name})")
+ * boolean insert(User user);
+ * }
+ *
+ *
* @author Clinton Begin
*/
+@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
+@Repeatable(Options.List.class)
public @interface Options {
+ /**
+ * The options for the {@link Options#flushCache()}.
+ * The default is {@link FlushCachePolicy#DEFAULT}
+ */
+ enum FlushCachePolicy {
+ /** false for select statement; true for insert/update/delete statement. */
+ DEFAULT,
+ /** Flushes cache regardless of the statement type. */
+ TRUE,
+ /** Does not flush cache regardless of the statement type. */
+ FALSE
+ }
+
+ /**
+ * Returns whether use the 2nd cache feature if assigned the cache.
+ *
+ * @return {@code true} if use; {@code false} if otherwise
+ */
boolean useCache() default true;
- boolean flushCache() default false;
+ /**
+ * Returns the 2nd cache flush strategy.
+ *
+ * @return the 2nd cache flush strategy
+ */
+ FlushCachePolicy flushCache() default FlushCachePolicy.DEFAULT;
- ResultSetType resultSetType() default ResultSetType.FORWARD_ONLY;
+ /**
+ * Returns the result set type.
+ *
+ * @return the result set type
+ */
+ ResultSetType resultSetType() default ResultSetType.DEFAULT;
+ /**
+ * Return the statement type.
+ *
+ * @return the statement type
+ */
StatementType statementType() default StatementType.PREPARED;
+ /**
+ * Returns the fetch size.
+ *
+ * @return the fetch size
+ */
int fetchSize() default -1;
+ /**
+ * Returns the statement timeout.
+ *
+ * @return the statement timeout
+ */
int timeout() default -1;
+ /**
+ * Returns whether use the generated keys feature supported by JDBC 3.0
+ *
+ * @return {@code true} if use; {@code false} if otherwise
+ */
boolean useGeneratedKeys() default false;
- String keyProperty() default "id";
+ /**
+ * Returns property names that holds a key value.
+ * + * If you specify multiple property, please separate using comma(','). + *
+ * + * @return property names that separate with comma(',') + */ + String keyProperty() default ""; + /** + * Returns column names that retrieves a key value. + *+ * If you specify multiple column, please separate using comma(','). + *
+ * + * @return column names that separate with comma(',') + */ String keyColumn() default ""; + + /** + * Returns result set names. + *+ * If you specify multiple result set, please separate using comma(','). + *
+ * + * @return result set names that separate with comma(',') + */ + String resultSets() default ""; + + /** + * @return A database id that correspond this options + * @since 3.5.5 + */ + String databaseId() default ""; + + /** + * The container annotation for {@link Options}. + * @author Kazuki Shimizu + * @since 3.5.5 + */ + @Documented + @Retention(RetentionPolicy.RUNTIME) + @Target(ElementType.METHOD) + @interface List { + Options[] value(); + } + } diff --git a/src/main/java/org/apache/ibatis/annotations/Param.java b/src/main/java/org/apache/ibatis/annotations/Param.java index 899587807e9..78f65c62448 100644 --- a/src/main/java/org/apache/ibatis/annotations/Param.java +++ b/src/main/java/org/apache/ibatis/annotations/Param.java @@ -1,5 +1,5 @@ /** - * Copyright 2009-2015 the original author or authors. + * Copyright 2009-2020 the original author or authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -15,16 +15,35 @@ */ package org.apache.ibatis.annotations; +import java.lang.annotation.Documented; import java.lang.annotation.ElementType; import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; import java.lang.annotation.Target; /** + * The annotation that specify the parameter name. + * + *+ * How to use: + * + *
+ * public interface UserMapper {
+ * @Select("SELECT id, name FROM users WHERE name = #{name}")
+ * User selectById(@Param("name") String value);
+ * }
+ *
+ *
* @author Clinton Begin
*/
+@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.PARAMETER)
public @interface Param {
+ /**
+ * Returns the parameter name.
+ *
+ * @return the parameter name
+ */
String value();
}
diff --git a/src/main/java/org/apache/ibatis/annotations/Property.java b/src/main/java/org/apache/ibatis/annotations/Property.java
new file mode 100644
index 00000000000..9cc5a71ec8d
--- /dev/null
+++ b/src/main/java/org/apache/ibatis/annotations/Property.java
@@ -0,0 +1,48 @@
+/**
+ * Copyright 2009-2019 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.ibatis.annotations;
+
+import java.lang.annotation.Documented;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+/**
+ * The annotation that inject a property value.
+ *
+ * @since 3.4.2
+ * @author Kazuki Shimizu
+ * @see CacheNamespace
+ */
+@Documented
+@Retention(RetentionPolicy.RUNTIME)
+@Target({})
+public @interface Property {
+
+ /**
+ * Returns the property name.
+ *
+ * @return the property name
+ */
+ String name();
+
+ /**
+ * Returns the property value or placeholder.
+ *
+ * @return the property value or placeholder
+ */
+ String value();
+}
diff --git a/src/main/java/org/apache/ibatis/annotations/Result.java b/src/main/java/org/apache/ibatis/annotations/Result.java
index da33150bd98..86db4a8d526 100644
--- a/src/main/java/org/apache/ibatis/annotations/Result.java
+++ b/src/main/java/org/apache/ibatis/annotations/Result.java
@@ -1,5 +1,5 @@
/**
- * Copyright 2009-2015 the original author or authors.
+ * Copyright 2009-2019 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -15,7 +15,9 @@
*/
package org.apache.ibatis.annotations;
+import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
+import java.lang.annotation.Repeatable;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
@@ -25,24 +27,69 @@
import org.apache.ibatis.type.UnknownTypeHandler;
/**
+ * The annotation that specify a mapping definition for the property.
+ *
+ * @see Results
* @author Clinton Begin
*/
+@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
+@Repeatable(Results.class)
public @interface Result {
+ /**
+ * Returns whether id column or not.
+ *
+ * @return {@code true} if id column; {@code false} if otherwise
+ */
boolean id() default false;
+ /**
+ * Return the column name(or column label) to map to this argument.
+ *
+ * @return the column name(or column label)
+ */
String column() default "";
+ /**
+ * Returns the property name for applying this mapping.
+ *
+ * @return the property name
+ */
String property() default "";
+ /**
+ * Return the java type for this argument.
+ *
+ * @return the java type
+ */
Class javaType() default void.class;
+ /**
+ * Return the jdbc type for column that map to this argument.
+ *
+ * @return the jdbc type
+ */
JdbcType jdbcType() default JdbcType.UNDEFINED;
- Class> typeHandler() default UnknownTypeHandler.class;
+ /**
+ * Returns the {@link TypeHandler} type for retrieving a column value from result set.
+ *
+ * @return the {@link TypeHandler} type
+ */
+ Class typeHandler() default UnknownTypeHandler.class;
+ /**
+ * Returns the mapping definition for single relationship.
+ *
+ * @return the mapping definition for single relationship
+ */
One one() default @One;
+ /**
+ * Returns the mapping definition for collection relationship.
+ *
+ * @return the mapping definition for collection relationship
+ */
Many many() default @Many;
}
diff --git a/src/main/java/org/apache/ibatis/annotations/ResultMap.java b/src/main/java/org/apache/ibatis/annotations/ResultMap.java
index 9c348e470db..a3d4114b3ae 100644
--- a/src/main/java/org/apache/ibatis/annotations/ResultMap.java
+++ b/src/main/java/org/apache/ibatis/annotations/ResultMap.java
@@ -1,5 +1,5 @@
/**
- * Copyright 2009-2015 the original author or authors.
+ * Copyright 2009-2020 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -15,16 +15,52 @@
*/
package org.apache.ibatis.annotations;
+import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
+ * The annotation that specify result map names to use.
+ *
+ *
+ * How to use:
+ * Mapper interface:
+ *
+ *
+ * public interface UserMapper {
+ * @Select("SELECT id, name FROM users WHERE id = #{id}")
+ * @ResultMap("userMap")
+ * User selectById(int id);
+ *
+ * @Select("SELECT u.id, u.name FROM users u INNER JOIN users_email ue ON u.id = ue.id WHERE ue.email = #{email}")
+ * @ResultMap("userMap")
+ * User selectByEmail(String email);
+ * }
+ *
+ * Mapper XML:
+ * {@code
+ *
+ *
+ *
+ *
+ * }
+ *
+ *
* @author Jeff Butler
*/
+@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface ResultMap {
+ /**
+ * Returns result map names to use.
+ *
+ * @return result map names
+ */
String[] value();
}
diff --git a/src/main/java/org/apache/ibatis/annotations/ResultType.java b/src/main/java/org/apache/ibatis/annotations/ResultType.java
index 5eaa9c3371b..a6437cf138d 100644
--- a/src/main/java/org/apache/ibatis/annotations/ResultType.java
+++ b/src/main/java/org/apache/ibatis/annotations/ResultType.java
@@ -1,5 +1,5 @@
/**
- * Copyright 2009-2015 the original author or authors.
+ * Copyright 2009-2020 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -15,6 +15,7 @@
*/
package org.apache.ibatis.annotations;
+import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
@@ -25,12 +26,29 @@
* ResultHandler. Those methods must have void return type, so
* this annotation can be used to tell MyBatis what kind of object
* it should build for each row.
- *
+ *
+ * + * How to use: + * + *
+ * public interface UserMapper {
+ * @ResultType(User.class)
+ * @Select("SELECT id, name FROM users WHERE name LIKE #{name} || '%' ORDER BY id")
+ * void collectByStartingWithName(String name, ResultHandler<User> handler);
+ * }
+ *
+ *
* @since 3.2.0
* @author Jeff Butler
*/
+@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface ResultType {
+ /**
+ * Returns the return type.
+ *
+ * @return the return type
+ */
Class value();
}
diff --git a/src/main/java/org/apache/ibatis/annotations/Results.java b/src/main/java/org/apache/ibatis/annotations/Results.java
index 00ad42106dd..69144e50927 100644
--- a/src/main/java/org/apache/ibatis/annotations/Results.java
+++ b/src/main/java/org/apache/ibatis/annotations/Results.java
@@ -1,5 +1,5 @@
/**
- * Copyright 2009-2015 the original author or authors.
+ * Copyright 2009-2020 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -15,16 +15,48 @@
*/
package org.apache.ibatis.annotations;
+import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
+ * The annotation that be grouping mapping definitions for property.
+ *
+ * + * How to use: + * + *
+ * public interface UserMapper {
+ * @Results({
+ * @Result(property = "id", column = "id", id = true),
+ * @Result(property = "name", column = "name"),
+ * @Result(property = "email" column = "id", one = @One(select = "selectUserEmailById", fetchType = FetchType.LAZY)),
+ * @Result(property = "telephoneNumbers" column = "id", many = @Many(select = "selectAllUserTelephoneNumberById", fetchType = FetchType.LAZY))
+ * })
+ * @Select("SELECT id, name FROM users WHERE id = #{id}")
+ * User selectById(int id);
+ * }
+ *
+ *
* @author Clinton Begin
*/
+@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface Results {
+ /**
+ * Returns the id of this result map.
+ *
+ * @return the id of this result map
+ */
+ String id() default "";
+
+ /**
+ * Returns mapping definitions for property.
+ *
+ * @return mapping definitions
+ */
Result[] value() default {};
}
diff --git a/src/main/java/org/apache/ibatis/annotations/Select.java b/src/main/java/org/apache/ibatis/annotations/Select.java
index d43d4d1db9b..7f7a5342ffb 100644
--- a/src/main/java/org/apache/ibatis/annotations/Select.java
+++ b/src/main/java/org/apache/ibatis/annotations/Select.java
@@ -1,5 +1,5 @@
/**
- * Copyright 2009-2015 the original author or authors.
+ * Copyright 2009-2020 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -15,16 +15,56 @@
*/
package org.apache.ibatis.annotations;
+import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
+import java.lang.annotation.Repeatable;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
+ * The annotation that specify an SQL for retrieving record(s).
+ *
+ * + * How to use: + * + *
+ * public interface UserMapper {
+ * @Select("SELECT id, name FROM users WHERE id = #{id}")
+ * User selectById(int id);
+ * }
+ *
+ *
* @author Clinton Begin
*/
+@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
+@Repeatable(Select.List.class)
public @interface Select {
+ /**
+ * Returns an SQL for retrieving record(s).
+ *
+ * @return an SQL for retrieving record(s)
+ */
String[] value();
+
+ /**
+ * @return A database id that correspond this statement
+ * @since 3.5.5
+ */
+ String databaseId() default "";
+
+ /**
+ * The container annotation for {@link Select}.
+ * @author Kazuki Shimizu
+ * @since 3.5.5
+ */
+ @Documented
+ @Retention(RetentionPolicy.RUNTIME)
+ @Target(ElementType.METHOD)
+ @interface List {
+ Select[] value();
+ }
+
}
diff --git a/src/main/java/org/apache/ibatis/annotations/SelectKey.java b/src/main/java/org/apache/ibatis/annotations/SelectKey.java
index a793a0ab946..58d8b2418e2 100644
--- a/src/main/java/org/apache/ibatis/annotations/SelectKey.java
+++ b/src/main/java/org/apache/ibatis/annotations/SelectKey.java
@@ -1,5 +1,5 @@
/**
- * Copyright 2009-2015 the original author or authors.
+ * Copyright 2009-2020 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -15,7 +15,9 @@
*/
package org.apache.ibatis.annotations;
+import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
+import java.lang.annotation.Repeatable;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
@@ -23,20 +25,90 @@
import org.apache.ibatis.mapping.StatementType;
/**
+ * The annotation that specify an SQL for retrieving a key value.
+ *
+ * + * How to use: + * + *
+ * public interface UserMapper {
+ * @SelectKey(statement = "SELECT identity('users')", keyProperty = "id", before = true, resultType = int.class)
+ * @Insert("INSERT INTO users (id, name) VALUES(#{id}, #{name})")
+ * boolean insert(User user);
+ * }
+ *
+ *
* @author Clinton Begin
*/
+@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
+@Repeatable(SelectKey.List.class)
public @interface SelectKey {
+ /**
+ * Returns an SQL for retrieving a key value.
+ *
+ * @return an SQL for retrieving a key value
+ */
String[] statement();
+ /**
+ * Returns property names that holds a key value.
+ * + * If you specify multiple property, please separate using comma(','). + *
+ * + * @return property names that separate with comma(',') + */ String keyProperty(); + /** + * Returns column names that retrieves a key value. + *+ * If you specify multiple column, please separate using comma(','). + *
+ * + * @return column names that separate with comma(',') + */ String keyColumn() default ""; + /** + * Returns whether retrieves a key value before executing insert/update statement. + * + * @return {@code true} if execute before; {@code false} if otherwise + */ boolean before(); + /** + * Returns the key value type. + * + * @return the key value type + */ Class resultType(); + /** + * Returns the statement type to use. + * + * @return the statement type + */ StatementType statementType() default StatementType.PREPARED; + + /** + * @return A database id that correspond this select key + * @since 3.5.5 + */ + String databaseId() default ""; + + /** + * The container annotation for {@link SelectKey}. + * @author Kazuki Shimizu + * @since 3.5.5 + */ + @Documented + @Retention(RetentionPolicy.RUNTIME) + @Target(ElementType.METHOD) + @interface List { + SelectKey[] value(); + } + } diff --git a/src/main/java/org/apache/ibatis/annotations/SelectProvider.java b/src/main/java/org/apache/ibatis/annotations/SelectProvider.java index b6d9e1cfe34..e691d9f5fca 100644 --- a/src/main/java/org/apache/ibatis/annotations/SelectProvider.java +++ b/src/main/java/org/apache/ibatis/annotations/SelectProvider.java @@ -1,5 +1,5 @@ /** - * Copyright 2009-2015 the original author or authors. + * Copyright 2009-2020 the original author or authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -15,18 +15,100 @@ */ package org.apache.ibatis.annotations; +import java.lang.annotation.Documented; import java.lang.annotation.ElementType; +import java.lang.annotation.Repeatable; import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; import java.lang.annotation.Target; /** + * The annotation that specify a method that provide an SQL for retrieving record(s). + * + *+ * How to use: + * + *
+ * public interface UserMapper {
+ *
+ * @SelectProvider(type = SqlProvider.class, method = "selectById")
+ * User selectById(int id);
+ *
+ * public static class SqlProvider {
+ * public static String selectById() {
+ * return "SELECT id, name FROM users WHERE id = #{id}";
+ * }
+ * }
+ *
+ * }
+ *
+ *
* @author Clinton Begin
*/
+@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
+@Repeatable(SelectProvider.List.class)
public @interface SelectProvider {
- Class type();
- String method();
+ /**
+ * Specify a type that implements an SQL provider method.
+ *
+ * @return a type that implements an SQL provider method
+ * @since 3.5.2
+ * @see #type()
+ */
+ Class value() default void.class;
+
+ /**
+ * Specify a type that implements an SQL provider method.
+ * + * This attribute is alias of {@link #value()}. + *
+ * + * @return a type that implements an SQL provider method + * @see #value() + */ + Class type() default void.class; + + /** + * 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. + *
+ * How to use: + * + *
+ * public interface UserMapper {
+ * @Select("SELECT id, name, type FROM users ORDER BY id")
+ * @TypeDiscriminator(
+ * column = "type",
+ * javaType = String.class,
+ * cases = {
+ * @Case(value = "1", type = PremiumUser.class),
+ * @Case(value = "2", type = GeneralUser.class),
+ * @Case(value = "3", type = TemporaryUser.class)
+ * }
+ * )
+ * List<User> selectAll();
+ * }
+ *
+ *
* @author Clinton Begin
*/
+@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface TypeDiscriminator {
+
+ /**
+ * Returns the column name(column label) that hold conditional value.
+ *
+ * @return the column name(column label)
+ */
String column();
+ /**
+ * Return the java type for conditional value.
+ *
+ * @return the java type
+ */
Class javaType() default void.class;
+ /**
+ * Return the jdbc type for column that hold conditional value.
+ *
+ * @return the jdbc type
+ */
JdbcType jdbcType() default JdbcType.UNDEFINED;
- Class> typeHandler() default UnknownTypeHandler.class;
+ /**
+ * Returns the {@link TypeHandler} type for retrieving a column value from result set.
+ *
+ * @return the {@link TypeHandler} type
+ */
+ Class typeHandler() default UnknownTypeHandler.class;
+ /**
+ * Returns conditional mapping definitions.
+ *
+ * @return conditional mapping definitions
+ */
Case[] cases();
}
diff --git a/src/main/java/org/apache/ibatis/annotations/Update.java b/src/main/java/org/apache/ibatis/annotations/Update.java
index 0af9c1c4c4c..ff5181c29c0 100644
--- a/src/main/java/org/apache/ibatis/annotations/Update.java
+++ b/src/main/java/org/apache/ibatis/annotations/Update.java
@@ -1,5 +1,5 @@
/**
- * Copyright 2009-2015 the original author or authors.
+ * Copyright 2009-2020 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -15,16 +15,56 @@
*/
package org.apache.ibatis.annotations;
+import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
+import java.lang.annotation.Repeatable;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
+ * The annotation that specify an SQL for updating record(s).
+ *
+ * + * How to use: + * + *
+ * public interface UserMapper {
+ * @Update("UPDATE users SET name = #{name} WHERE id = #{id}")
+ * boolean update(User user);
+ * }
+ *
+ *
* @author Clinton Begin
*/
+@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
+@Repeatable(Update.List.class)
public @interface Update {
+ /**
+ * Returns an SQL for updating record(s).
+ *
+ * @return an SQL for updating record(s)
+ */
String[] value();
+
+ /**
+ * @return A database id that correspond this statement
+ * @since 3.5.5
+ */
+ String databaseId() default "";
+
+ /**
+ * The container annotation for {@link Update}.
+ * @author Kazuki Shimizu
+ * @since 3.5.5
+ */
+ @Documented
+ @Retention(RetentionPolicy.RUNTIME)
+ @Target(ElementType.METHOD)
+ @interface List {
+ Update[] value();
+ }
+
}
diff --git a/src/main/java/org/apache/ibatis/annotations/UpdateProvider.java b/src/main/java/org/apache/ibatis/annotations/UpdateProvider.java
index 0bbdd99ce09..f71d3f9501c 100644
--- a/src/main/java/org/apache/ibatis/annotations/UpdateProvider.java
+++ b/src/main/java/org/apache/ibatis/annotations/UpdateProvider.java
@@ -1,5 +1,5 @@
/**
- * Copyright 2009-2015 the original author or authors.
+ * Copyright 2009-2020 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -15,18 +15,100 @@
*/
package org.apache.ibatis.annotations;
+import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
+import java.lang.annotation.Repeatable;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
+ * The annotation that specify a method that provide an SQL for updating record(s).
+ *
+ * + * How to use: + * + *
+ * public interface UserMapper {
+ *
+ * @UpdateProvider(type = SqlProvider.class, method = "update")
+ * boolean update(User user);
+ *
+ * public static class SqlProvider {
+ * public static String update() {
+ * return "UPDATE users SET name = #{name} WHERE id = #{id}";
+ * }
+ * }
+ *
+ * }
+ *
+ *
* @author Clinton Begin
*/
+@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
+@Repeatable(UpdateProvider.List.class)
public @interface UpdateProvider {
- Class type();
- String method();
+ /**
+ * Specify a type that implements an SQL provider method.
+ *
+ * @return a type that implements an SQL provider method
+ * @since 3.5.2
+ * @see #type()
+ */
+ Class value() default void.class;
+
+ /**
+ * Specify a type that implements an SQL provider method.
+ * + * This attribute is alias of {@link #value()}. + *
+ * + * @return a type that implements an SQL provider method + * @see #value() + */ + Class type() default void.class; + + /** + * 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. + *