View Javadoc

1   /*
2    * Copyright 2011-2013 smartics, Kronseder & Reiner GmbH
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  package de.smartics.util.source;
17  
18  /**
19   * Provides access to method information.
20   */
21  public interface MethodInfo
22  {
23    // ********************************* Fields *********************************
24  
25    // --- constants ------------------------------------------------------------
26  
27    // ****************************** Initializer *******************************
28  
29    // ****************************** Inner Classes *****************************
30  
31    // ********************************* Methods ********************************
32  
33    // --- get&set --------------------------------------------------------------
34  
35    // --- business -------------------------------------------------------------
36  
37    /**
38     * Returns the signature of the test method. This includes the test name and
39     * the parameter types list (with brackets).
40     *
41     * @return the signature of the test method.
42     * @todo Currently assumes that the test method has no arguments.
43     */
44    String getMethodSignature();
45  
46    /**
47     * Returns the location of the test. This is the location of the test method.
48     *
49     * @return the location of the test.
50     */
51    SourceCodeLocation getLocation();
52  
53    // --- object basics --------------------------------------------------------
54  
55  }