Commons Digester example source code file (StackCallParam.java)

This example Commons Digester source code file (StackCallParam.java) is included in the DevDaily.com "Java Source Code Warehouse" project. The intent of this project is to help you "Learn Java by Example" ^TM.

Java - Commons Digester tags/keywords

annotation, digesterrule, digesterrule, digesterrulelist, digesterrulelist, documented, documented, list, stackcallparam, stackcallparam, string

The Commons Digester StackCallParam.java source code

/* $Id: StackCallParam.java 992750 2010-09-05 09:54:37Z simonetripodi $
 *
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.commons.digester.annotations.rules;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

import org.apache.commons.digester.CallParamRule;
import org.apache.commons.digester.annotations.DigesterRule;
import org.apache.commons.digester.annotations.DigesterRuleList;
import org.apache.commons.digester.annotations.providers.StackCallParamRuleProvider;

/**
 * Methods arguments annotated with {@code StackCallParam} will be bound
 * with {@code CallParamRule} digester rule.
 *
 * @see org.apache.commons.digester.Digester#addCallParam(String,int,int)
 * @since 2.1
 */
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.PARAMETER)
@DigesterRule(
        reflectsRule = CallParamRule.class,
        providedBy = StackCallParamRuleProvider.class
)
public @interface StackCallParam {

    /**
     * The element matching pattern.
     *
     * @return the element matching pattern.
     */
    String pattern();

    /**
     * The call parameter to the stackIndex'th object down the stack, where 0 is
     * the top of the stack, 1 the next element down and so on.
     *
     * @return the stackIndex'th object down the stack.
     */
    int stackIndex() default 0;

    /**
     * Defines several {@code StackCallParam} annotations on the same element.
     *
     * @see StackCallParam
     */
    @Documented
    @Retention(RetentionPolicy.RUNTIME)
    @Target(ElementType.TYPE)
    @DigesterRuleList
    @interface List {
        StackCallParam[] value();
    }

}