org.springframework.core.type.AnnotationMetadata Maven / Gradle / Ivy
/*
* Copyright 2002-2017 the original author or authors.
*
* 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
*
* https://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.springframework.core.type;
import java.util.Set;
/**
* Interface that defines abstract access to the annotations of a specific
* class, in a form that does not require that class to be loaded yet.
*
* @author Juergen Hoeller
* @author Mark Fisher
* @author Phillip Webb
* @author Sam Brannen
* @since 2.5
* @see StandardAnnotationMetadata
* @see org.springframework.core.type.classreading.MetadataReader#getAnnotationMetadata()
* @see AnnotatedTypeMetadata
*/
public interface AnnotationMetadata extends ClassMetadata, AnnotatedTypeMetadata {
/**
* Get the fully qualified class names of all annotation types that
* are present on the underlying class.
* @return the annotation type names
*/
Set getAnnotationTypes();
/**
* Get the fully qualified class names of all meta-annotation types that
* are present on the given annotation type on the underlying class.
* @param annotationName the fully qualified class name of the meta-annotation
* type to look for
* @return the meta-annotation type names, or an empty set if none found
*/
Set getMetaAnnotationTypes(String annotationName);
/**
* Determine whether an annotation of the given type is present on
* the underlying class.
* @param annotationName the fully qualified class name of the annotation
* type to look for
* @return {@code true} if a matching annotation is present
*/
boolean hasAnnotation(String annotationName);
/**
* Determine whether the underlying class has an annotation that is itself
* annotated with the meta-annotation of the given type.
* @param metaAnnotationName the fully qualified class name of the
* meta-annotation type to look for
* @return {@code true} if a matching meta-annotation is present
*/
boolean hasMetaAnnotation(String metaAnnotationName);
/**
* Determine whether the underlying class has any methods that are
* annotated (or meta-annotated) with the given annotation type.
* @param annotationName the fully qualified class name of the annotation
* type to look for
*/
boolean hasAnnotatedMethods(String annotationName);
/**
* Retrieve the method metadata for all methods that are annotated
* (or meta-annotated) with the given annotation type.
* For any returned method, {@link MethodMetadata#isAnnotated} will
* return {@code true} for the given annotation type.
* @param annotationName the fully qualified class name of the annotation
* type to look for
* @return a set of {@link MethodMetadata} for methods that have a matching
* annotation. The return value will be an empty set if no methods match
* the annotation type.
*/
Set getAnnotatedMethods(String annotationName);
}