Source code: com/puppycrawl/tools/checkstyle/checks/usage/transmogrify/IMethod.java
1
2 // Transmogrify License
3 //
4 // Copyright (c) 2001, ThoughtWorks, Inc.
5 // All rights reserved.
6 // Redistribution and use in source and binary forms, with or without
7 // modification, are permitted provided that the following conditions
8 // are met:
9 // - Redistributions of source code must retain the above copyright notice,
10 // this list of conditions and the following disclaimer.
11 // - Redistributions in binary form must reproduce the above copyright
12 // notice, this list of conditions and the following disclaimer in the
13 // documentation and/or other materials provided with the distribution.
14 // Neither the name of the ThoughtWorks, Inc. nor the names of its
15 // contributors may be used to endorse or promote products derived from this
16 // software without specific prior written permission.
17 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
19 // TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
20 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
21 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
22 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
23 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
24 // OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
25 // WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
26 // OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
27 // ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28
29 package com.puppycrawl.tools.checkstyle.checks.usage.transmogrify;
30
31
32
33 /**
34 * <code>MethodDef</code> contains all the pertinent information for
35 * a method, including return type, formal parameters, and exceptions
36 * thrown
37 *
38 * @see ClassDef
39 * @see MethodSignature
40 * @see net.sourceforge.transmogrify.symtab.ExternalMethod
41 * @see net.sourceforge.transmogrify.symtab.MethodDef
42 */
43 public interface IMethod extends Typed {
44
45 /**
46 * Returns the signature of this method.
47 *
48 * @return the signature of this method
49 */
50 public ISignature getSignature();
51
52 /**
53 * verifies if the input signature is the same with signatures of this method
54 * @return <code>true</code> if the two set signatures are equal
55 * <code>false</code> otherwise
56 */
57 public boolean hasSameSignature(ISignature signature);
58
59 /**
60 * verifies if the input signature type is compatible with this method signature
61 * @return <code>true</code> if the two set of signatures are compatible
62 * <code>false</code> otherwise
63 */
64 public boolean hasCompatibleSignature(ISignature signature);
65
66 public IClass[] getExceptions();
67 }