1 package org.apache.commons.digester3.annotations.rules;
2
3 /*
4 * Licensed to the Apache Software Foundation (ASF) under one
5 * or more contributor license agreements. See the NOTICE file
6 * distributed with this work for additional information
7 * regarding copyright ownership. The ASF licenses this file
8 * to you under the Apache License, Version 2.0 (the
9 * "License"); you may not use this file except in compliance
10 * with the License. You may obtain a copy of the License at
11 *
12 * http://www.apache.org/licenses/LICENSE-2.0
13 *
14 * Unless required by applicable law or agreed to in writing,
15 * software distributed under the License is distributed on an
16 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17 * KIND, either express or implied. See the License for the
18 * specific language governing permissions and limitations
19 * under the License.
20 */
21
22 import java.lang.annotation.Documented;
23 import java.lang.annotation.ElementType;
24 import java.lang.annotation.Retention;
25 import java.lang.annotation.RetentionPolicy;
26 import java.lang.annotation.Target;
27
28 import org.apache.commons.digester3.CallParamRule;
29 import org.apache.commons.digester3.annotations.DigesterRule;
30 import org.apache.commons.digester3.annotations.DigesterRuleList;
31 import org.apache.commons.digester3.annotations.handlers.CallParamHandler;
32
33 /**
34 * Methods arguments annotated with {@code CallParam} will be bound with {@code CallParamRule} digester rule.
35 *
36 * @see org.apache.commons.digester3.Digester#addCallParam(String,int)
37 * @since 2.1
38 */
39 @Documented
40 @Retention( RetentionPolicy.RUNTIME )
41 @Target( ElementType.PARAMETER )
42 @DigesterRule( reflectsRule = CallParamRule.class, handledBy = CallParamHandler.class )
43 public @interface CallParam
44 {
45
46 /**
47 * The element matching pattern.
48 */
49 String pattern();
50
51 /**
52 * The namespace URI for which this Rule is relevant, if any.
53 *
54 * @since 3.0
55 */
56 String namespaceURI() default "";
57
58 /**
59 * The attribute from which to save the parameter value.
60 *
61 * @since 3.0
62 */
63 String attributeName() default "";
64
65 /**
66 * Flags the parameter to be set from the stack.
67 *
68 * @since 3.0
69 */
70 boolean fromStack() default false;
71
72 /**
73 * Sets the position of the object from the top of the stack.
74 *
75 * @since 3.0
76 */
77 int stackIndex() default 0;
78
79 /**
80 * Defines several {@code @CallParam} annotations on the same element.
81 *
82 * @see CallParam
83 */
84 @Documented
85 @Retention( RetentionPolicy.RUNTIME )
86 @Target( ElementType.PARAMETER )
87 @DigesterRuleList
88 @interface List
89 {
90 CallParam[] value();
91 }
92
93 }