jakarta.enterprise.inject.spi.Annotated Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jakarta.enterprise.cdi-api Show documentation
APIs for CDI (Contexts and Dependency Injection for Java)
The newest version!
/*
 * Copyright 2010, Red Hat, Inc., and individual contributors
 *
 * Licensed 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 jakarta.enterprise.inject.spi;

import java.lang.annotation.Annotation;
import java.lang.reflect.AnnotatedElement;
import java.lang.reflect.Type;
import java.util.Set;

/**
 * 
 * Represents a Java program element that can be annotated.
 * 
 *
 * @see java.lang.reflect.AnnotatedElement
 *
 * @author Gavin King
 * @author Pete Muir
 * @author Clint Popetz
 * @author John D. Ament
 *
 */
public interface Annotated {

    /**
     * 
     * Get the type of the annotated program element.
     * 
     *
     * @return the type of the annotated program element
     */
    Type getBaseType();

    /**
     * 
     * Get all types to which the base type should be considered assignable.
     * 
     *
     * @return a set of all types to which the base type should be considered assignable
     */
    Set getTypeClosure();

    /**
     * 
     * Get program element annotation of a certain annotation type.
     *
     * The behavior of this method is intended to be the same behavior as {@link AnnotatedElement#getAnnotation(Class)},
     * where repeatable annotations are not supported.
     * 
     *
     * @param  the type of the annotation
     * @param annotationType the class of the annotation type
     * @return the first program element annotation of the given annotation type, or a null value
     */
     T getAnnotation(Class annotationType);

    /**
     * 
     * Get program element annotations of a certain annotation type.
     * 

     * This method returns back all annotations, including repeatable annotations of this type.
     *
     * The behavior of this method is intended to be the same behavior as {@link AnnotatedElement#getAnnotationsByType(Class)},
     * where repeatable annotations are supported.
     * 
     *
     * @param  the type of the annotation
     * @param annotationType the class of the annotation type
     * @return the program element annotations of the given annotation type, or an empty collection
     */
     Set getAnnotations(Class annotationType);

    /**
     * 
     * Get all annotations of the program element.
     * 
     *
     * @return all annotations of the program element, or an empty set if no annotations are present
     */
    Set getAnnotations();

    /**
     * 
     * Determine if the program element has an annotation of a certain annotation type.
     *
     * The behavior of this method is similar to {@link AnnotatedElement#isAnnotationPresent(Class)} for the underlying
     * program element.
     *
     * @param annotationType the annotation type to check for
     * @return true if the program element has an annotation of the given annotation type, or false
     *         otherwise
     */
    boolean isAnnotationPresent(Class annotationType);
}