1 /*
2 * Copyright 2009-2021 the original author or authors.
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16 package org.apache.ibatis.annotations;
17
18 import java.lang.annotation.Documented;
19 import java.lang.annotation.ElementType;
20 import java.lang.annotation.Repeatable;
21 import java.lang.annotation.Retention;
22 import java.lang.annotation.RetentionPolicy;
23 import java.lang.annotation.Target;
24
25 /**
26 * The annotation that specify an SQL for updating record(s).
27 *
28 * <p>
29 * <b>How to use:</b>
30 *
31 * <pre>
32 * public interface UserMapper {
33 * @Update("UPDATE users SET name = #{name} WHERE id = #{id}")
34 * boolean update(User user);
35 * }
36 * </pre>
37 *
38 * @author Clinton Begin
39 */
40 @Documented
41 @Retention(RetentionPolicy.RUNTIME)
42 @Target(ElementType.METHOD)
43 @Repeatable(Update.List.class)
44 public @interface Update {
45 /**
46 * Returns an SQL for updating record(s).
47 *
48 * @return an SQL for updating record(s)
49 */
50 String[] value();
51
52 /**
53 * @return A database id that correspond this statement
54 * @since 3.5.5
55 */
56 String databaseId() default "";
57
58 /**
59 * The container annotation for {@link Update}.
60 * @author Kazuki Shimizu
61 * @since 3.5.5
62 */
63 @Documented
64 @Retention(RetentionPolicy.RUNTIME)
65 @Target(ElementType.METHOD)
66 @interface List {
67 Update[] value();
68 }
69
70 }