001 /* $Id: StackCallParam.java 992750 2010-09-05 09:54:37Z simonetripodi $
002 *
003 * Licensed to the Apache Software Foundation (ASF) under one or more
004 * contributor license agreements. See the NOTICE file distributed with
005 * this work for additional information regarding copyright ownership.
006 * The ASF licenses this file to You under the Apache License, Version 2.0
007 * (the "License"); you may not use this file except in compliance with
008 * the License. You may obtain a copy of the License at
009 *
010 * http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing, software
013 * distributed under the License is distributed on an "AS IS" BASIS,
014 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
015 * See the License for the specific language governing permissions and
016 * limitations under the License.
017 */
018 package org.apache.commons.digester.annotations.rules;
019
020 import java.lang.annotation.Documented;
021 import java.lang.annotation.ElementType;
022 import java.lang.annotation.Retention;
023 import java.lang.annotation.RetentionPolicy;
024 import java.lang.annotation.Target;
025
026 import org.apache.commons.digester.CallParamRule;
027 import org.apache.commons.digester.annotations.DigesterRule;
028 import org.apache.commons.digester.annotations.DigesterRuleList;
029 import org.apache.commons.digester.annotations.providers.StackCallParamRuleProvider;
030
031 /**
032 * Methods arguments annotated with {@code StackCallParam} will be bound
033 * with {@code CallParamRule} digester rule.
034 *
035 * @see org.apache.commons.digester.Digester#addCallParam(String,int,int)
036 * @since 2.1
037 */
038 @Documented
039 @Retention(RetentionPolicy.RUNTIME)
040 @Target(ElementType.PARAMETER)
041 @DigesterRule(
042 reflectsRule = CallParamRule.class,
043 providedBy = StackCallParamRuleProvider.class
044 )
045 public @interface StackCallParam {
046
047 /**
048 * The element matching pattern.
049 *
050 * @return the element matching pattern.
051 */
052 String pattern();
053
054 /**
055 * The call parameter to the stackIndex'th object down the stack, where 0 is
056 * the top of the stack, 1 the next element down and so on.
057 *
058 * @return the stackIndex'th object down the stack.
059 */
060 int stackIndex() default 0;
061
062 /**
063 * Defines several {@code StackCallParam} annotations on the same element.
064 *
065 * @see StackCallParam
066 */
067 @Documented
068 @Retention(RetentionPolicy.RUNTIME)
069 @Target(ElementType.TYPE)
070 @DigesterRuleList
071 @interface List {
072 StackCallParam[] value();
073 }
074
075 }