/*

  * 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.apache.commons.classscan.model;

 import java.util.Set;

 import org.apache.commons.classscan.HasName;

 /**

  * Metadata about a class method or constructor

  */

 public interface MetaMethod extends HasName {

     /**

      * Get the name of the method or constructor

      */

     String getName();

     /**

      * Get metadata about the annotations on the method or constructor.

      * 

      * @return A read-only set of annotations

      */

     Set<? extends MetaAnnotation> getAnnotations();

     /**

      * Get metadata about a particular annotation on the corresponding method.

      * 

      * @param annotationName

      *            The name of the annotation desired

      * 

      * @return The annotation information, or null if not specified on the

      *         corresponding method

      */

     MetaAnnotation getAnnotation(String annotationName);

     /**

      * Get whether the corresponding method or constructor is a static method or

      * static class initializer

      */

     boolean isStatic();

     /**

      * Get metadata about the return type of the method or constructor

      * 

      * @return null, if the type is void return; otherwise, metadata about the

      *         type

      */

     MetaType getType();

     /**

      * Get metadata about the parameters of the method or constructor

      * 

      * @return A read-only set of parameter information

      */

     Set<? extends MetaParameter> getParameters();

 }