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.Retention;
21 import java.lang.annotation.RetentionPolicy;
22 import java.lang.annotation.Target;
23
24 /**
25 * The annotation that specify the parameter name.
26 *
27 * <p>
28 * <b>How to use:</b>
29 *
30 * <pre>
31 * public interface UserMapper {
32 * @Select("SELECT id, name FROM users WHERE name = #{name}")
33 * User selectById(@Param("name") String value);
34 * }
35 * </pre>
36 *
37 * @author Clinton Begin
38 */
39 @Documented
40 @Retention(RetentionPolicy.RUNTIME)
41 @Target(ElementType.PARAMETER)
42 public @interface Param {
43 /**
44 * Returns the parameter name.
45 *
46 * @return the parameter name
47 */
48 String value();
49 }