Open Source Repository

Home /spring/spring-core-3.0.5 | Repository Home



org/springframework/core/type/filter/AnnotationTypeFilter.java
/*
 * Copyright 2002-2009 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
 *
 *      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 org.springframework.core.type.filter;

import java.lang.annotation.Annotation;
import java.lang.annotation.Inherited;

import org.springframework.core.type.AnnotationMetadata;
import org.springframework.core.type.classreading.MetadataReader;

/**
 * A simple filter which matches classes with a given annotation,
 * checking inherited annotations as well.
 *
 <p>The matching logic mirrors that of <code>Class.isAnnotationPresent()</code>.
 *
 @author Mark Fisher
 @author Ramnivas Laddad
 @author Juergen Hoeller
 @since 2.5
 */
public class AnnotationTypeFilter extends AbstractTypeHierarchyTraversingFilter {

  private final Class<? extends Annotation> annotationType;

  private final boolean considerMetaAnnotations;


  /**
   * Create a new AnnotationTypeFilter for the given annotation type.
   * This filter will also match meta-annotations. To disable the
   * meta-annotation matching, use the constructor that accepts a
   * '<code>considerMetaAnnotations</code>' argument.
   @param annotationType the annotation type to match
   */
  public AnnotationTypeFilter(Class<? extends Annotation> annotationType) {
    this(annotationType, true);
  }

  /**
   * Create a new AnnotationTypeFilter for the given annotation type.
   @param annotationType the annotation type to match
   @param considerMetaAnnotations whether to also match on meta-annotations
   */
  public AnnotationTypeFilter(Class<? extends Annotation> annotationType, boolean considerMetaAnnotations) {
    super(annotationType.isAnnotationPresent(Inherited.class)false);
    this.annotationType = annotationType;
    this.considerMetaAnnotations = considerMetaAnnotations;
  }


  @Override
  protected boolean matchSelf(MetadataReader metadataReader) {
    AnnotationMetadata metadata = metadataReader.getAnnotationMetadata();
    return metadata.hasAnnotation(this.annotationType.getName()) || 
        (this.considerMetaAnnotations && metadata.hasMetaAnnotation(this.annotationType.getName()));
  }

  @Override
  protected Boolean matchSuperClass(String superClassName) {
    if (Object.class.getName().equals(superClassName)) {
      return Boolean.FALSE;
    }
    else if (superClassName.startsWith("java.")) {
      try {
        Class<?> clazz = getClass().getClassLoader().loadClass(superClassName);
        return (clazz.getAnnotation(this.annotationType!= null);
      }
      catch (ClassNotFoundException ex) {
        // Class not found - can't determine a match that way.
      }
    }
    return null;
  }

}