1 /*
2 * Copyright 2009-2023 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 * https://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 reference a cache.
26 * <p>
27 * If you use this annotation, should be specified either {@link #value()} or {@link #name()} attribute.
28 * <p>
29 * <b>How to use:</b>
30 *
31 * <pre>
32 * @CacheNamespaceRef(UserMapper.class)
33 * public interface AdminUserMapper {
34 * // ...
35 * }
36 * </pre>
37 *
38 * @author Clinton Begin
39 * @author Kazuki Shimizu
40 */
41 @Documented
42 @Retention(RetentionPolicy.RUNTIME)
43 @Target(ElementType.TYPE)
44 public @interface CacheNamespaceRef {
45
46 /**
47 * Returns the namespace type to reference a cache (the namespace name become a FQCN of specified type).
48 *
49 * @return the namespace type to reference a cache
50 */
51 Class<?> value() default void.class;
52
53 /**
54 * Returns the namespace name to reference a cache.
55 *
56 * @return the namespace name
57 *
58 * @since 3.4.2
59 */
60 String name() default "";
61 }