View Javadoc

1   /*
2    * Copyright 2005 The Apache Software Foundation.
3    * 
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at 
7    * 
8    *     http://www.apache.org/licenses/LICENSE-2.0
9    * 
10   * Unless required by applicable law or agreed to in writing, software 
11   * distributed under the License is distributed on an "AS IS" BASIS, 
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 
13   * See the License for the specific language governing permissions and 
14   * limitations under the License.
15   */
16  
17  package org.apache.jdo.model.java;
18  
19  /***
20   * A JavaMethod instance represents a method declared by a class. It allows
21   * to get detailed information about the method such as name, modifiers,
22   * return type, parameters, and the declaring class.
23   * <p>
24   * Different environments (runtime, enhancer, development) will have
25   * different JavaMethod implementations to provide answers to the various
26   * methods. 
27   * 
28   * @author Michael Bouschen
29   * @version JDO 2.0
30   */
31  public interface JavaMethod extends JavaMember 
32  {
33      /***
34       * Returns the JavaType representation of the method return type.
35       * @return method return type.
36       */
37      public JavaType getReturnType();
38  
39      /***
40       * Returns an array of JavaType instances that represent the formal
41       * parameter types, in declaration order, of the method represented by
42       * this JavaMethod instance.
43       * @return the types of teh formal parameters.
44       */
45      public JavaType[] getParameterTypes();
46  }