Open Source Repository

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


org/springframework/core/type/MethodMetadata.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;

import java.util.Map;

/**
 * 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 Pollack
 @author Chris Beams
 @since 3.0
 @see StandardMethodMetadata
 @see AnnotationMetadata#getAnnotatedMethods
 */
public interface MethodMetadata {

  /**
   * Return the name of the method.
   */
  String getMethodName();

  /**
   * Return the fully-qualified name of the class that declares this method.
   */
  public String getDeclaringClassName();

  /**
   * Return whether the underlying method is declared as 'static'.
   */
  boolean isStatic();

  /**
   * Return whether the underlying method is marked as 'final'.
   */
  boolean isFinal();

  /**
   * Return whether the underlying method is overridable,
   * i.e. not marked as static, final or private.
   */
  boolean isOverridable();

  /**
   * Determine whether the underlying method has an annotation or
   * meta-annotation of the given type defined.
   @param annotationType the annotation type to look for
   @return whether a matching annotation is defined
   */
  boolean isAnnotated(String annotationType);

  /**
   * Retrieve the attributes of the annotation of the given type,
   * if any (i.e. if defined on the underlying method, as direct
   * annotation or as meta-annotation).
   @param annotationType the annotation type to look for
   @return a Map of attributes, with the attribute name as key (e.g. "value")
   * and the defined attribute value as Map value. This return value will be
   <code>null</code> if no matching annotation is defined.
   */
  Map<String, Object> getAnnotationAttributes(String annotationType);

}