001package org.apache.commons.digester3.annotations.rules;
002
003/*
004 * Licensed to the Apache Software Foundation (ASF) under one
005 * or more contributor license agreements.  See the NOTICE file
006 * distributed with this work for additional information
007 * regarding copyright ownership.  The ASF licenses this file
008 * to you under the Apache License, Version 2.0 (the
009 * "License"); you may not use this file except in compliance
010 * with the License.  You may obtain a copy of the License at
011 *
012 *   http://www.apache.org/licenses/LICENSE-2.0
013 *
014 * Unless required by applicable law or agreed to in writing,
015 * software distributed under the License is distributed on an
016 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
017 * KIND, either express or implied.  See the License for the
018 * specific language governing permissions and limitations
019 * under the License.
020 */
021
022import java.lang.annotation.Documented;
023import java.lang.annotation.ElementType;
024import java.lang.annotation.Retention;
025import java.lang.annotation.RetentionPolicy;
026import java.lang.annotation.Target;
027
028import org.apache.commons.digester3.CallParamRule;
029import org.apache.commons.digester3.annotations.DigesterRule;
030import org.apache.commons.digester3.annotations.DigesterRuleList;
031import org.apache.commons.digester3.annotations.handlers.CallParamHandler;
032
033/**
034 * Methods arguments annotated with {@code CallParam} will be bound with {@code CallParamRule} digester rule.
035 *
036 * @see org.apache.commons.digester3.Digester#addCallParam(String,int)
037 * @since 2.1
038 */
039@Documented
040@Retention( RetentionPolicy.RUNTIME )
041@Target( ElementType.PARAMETER )
042@DigesterRule( reflectsRule = CallParamRule.class, handledBy = CallParamHandler.class )
043public @interface CallParam
044{
045
046    /**
047     * The element matching pattern.
048     */
049    String pattern();
050
051    /**
052     * The namespace URI for which this Rule is relevant, if any.
053     *
054     * @since 3.0
055     */
056    String namespaceURI() default "";
057
058    /**
059     * The attribute from which to save the parameter value.
060     *
061     * @since 3.0
062     */
063    String attributeName() default "";
064
065    /**
066     * Flags the parameter to be set from the stack.
067     *
068     * @since 3.0
069     */
070    boolean fromStack() default false;
071
072    /**
073     * Sets the position of the object from the top of the stack.
074     *
075     * @since 3.0
076     */
077    int stackIndex() default 0;
078
079    /**
080     * Defines several {@code @CallParam} annotations on the same element.
081     *
082     * @see CallParam
083     */
084    @Documented
085    @Retention( RetentionPolicy.RUNTIME )
086    @Target( ElementType.PARAMETER )
087    @DigesterRuleList
088    @interface List
089    {
090        CallParam[] value();
091    }
092
093}