View Javadoc

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