001package org.apache.commons.digester3.annotations;
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.Annotation;
023import java.lang.annotation.Documented;
024import java.lang.annotation.ElementType;
025import java.lang.annotation.Retention;
026import java.lang.annotation.RetentionPolicy;
027import java.lang.annotation.Target;
028import java.lang.reflect.AnnotatedElement;
029
030import org.apache.commons.digester3.Rule;
031
032/**
033 * Meta-annotation that marks an annotation as part of commons-digester.
034 * 
035 * @since 2.1
036 */
037@Documented
038@Target( ElementType.ANNOTATION_TYPE )
039@Retention( RetentionPolicy.RUNTIME )
040public @interface DigesterRule
041{
042
043    /**
044     * The reflected commons-digester rule.
045     */
046    Class<? extends Rule> reflectsRule();
047
048    /**
049     * The handler that takes care on converting this annotation in the related
050     * {@link AnnotationHandler} and adds it to the {@link FromAnnotationsRuleModule}
051     */
052    Class<? extends AnnotationHandler<? extends Annotation, ? extends AnnotatedElement>> handledBy();
053
054}