001    /* $Id: DigesterLoaderHandler.java 992060 2010-09-02 19:09:47Z 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;
019    
020    import java.lang.annotation.Annotation;
021    import java.lang.reflect.AnnotatedElement;
022    
023    /**
024     * A {@code DigesterLoaderHandler} intercept a {@code Class} visit performed by
025     * the {@link DigesterLoader} and performs the
026     * {@link DigesterLoaderHandler#handle(Annotation, AnnotatedElement, FromAnnotationsRuleSet)}
027     * method.
028     *
029     * @since 2.1
030     */
031    public interface DigesterLoaderHandler<A extends Annotation, E extends AnnotatedElement> {
032    
033        /**
034         * Handles the current visited element with the related current annotation.
035         *
036         * @param annotation the current visited annotation.
037         * @param element the current visited element.
038         * @param ruleSet the annotations {@code RuleSet} where providers have to be
039         *        added.
040         */
041        void handle(A annotation, E element, FromAnnotationsRuleSet ruleSet);
042    
043    }