1 /* ExecutableMemberDoc.java -- Document methods and constructors
2 Copyright (C) 1999 Free Software Foundation, Inc.
3
4 This file is part of GNU Classpath.
5
6 GNU Classpath is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2, or (at your option)
9 any later version.
10
11 GNU Classpath is distributed in the hope that it will be useful, but
12 WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 General Public License for more details.
15
16 You should have received a copy of the GNU General Public License
17 along with GNU Classpath; see the file COPYING. If not, write to the
18 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
19 02110-1301 USA.
20
21 Linking this library statically or dynamically with other modules is
22 making a combined work based on this library. Thus, the terms and
23 conditions of the GNU General Public License cover the whole
24 combination.
25
26 As a special exception, the copyright holders of this library give you
27 permission to link this library with independent modules to produce an
28 executable, regardless of the license terms of these independent
29 modules, and to copy and distribute the resulting executable under
30 terms of your choice, provided that you also meet, for each linked
31 independent module, the terms and conditions of the license of that
32 module. An independent module is a module which is not derived from
33 or based on this library. If you modify this library, you may extend
34 this exception to your version of the library, but you are not
35 obligated to do so. If you do not wish to do so, delete this
36 exception statement from your version. */
37
38
39 package com.sun.javadoc;
40
41 /**
42 * This is the super-interface for interfaces describing constructors and
43 * methods.
44 */
45 public interface ExecutableMemberDoc extends MemberDoc
46 {
47
48 /**
49 * This method returns a list of all the execeptions that are declared
50 * to be thrown in this method or constructor.
51 *
52 * @return The list of exceptions for this method.
53 */
54 public abstract ClassDoc[]
thrownExceptions()55 thrownExceptions();
56
57 /*************************************************************************/
58
59 /**
60 * This method tests whether or not this method/constructor is native.
61 *
62 * @return <code>true</code> if the method is native, <code>false</code>
63 * otherwise.
64 */
65 public abstract boolean
isNative()66 isNative();
67
68 /*************************************************************************/
69
70 /**
71 * This method tests whether or not this method/constructor is
72 * synchronized.
73 *
74 * @return <code>true</code> if the method is synchronized,
75 * <code>false</code> otherwise.
76 */
77 public abstract boolean
isSynchronized()78 isSynchronized();
79
80 /*************************************************************************/
81
82 /**
83 * This method returns the list of parameters for this method/constructor.
84 *
85 * @return The list of parameters for this method.
86 */
87 public abstract Parameter[]
parameters()88 parameters();
89
90 /*************************************************************************/
91
92 /**
93 * This method returns the list of "@throws" and "@exception" tags in this
94 * method/constructor.
95 *
96 * @return The list of exception doc tags.
97 */
98 public abstract ThrowsTag[]
throwsTags()99 throwsTags();
100
101 /*************************************************************************/
102
103 /**
104 * This method return the list of "@param" tags in this method/constructor.
105 *
106 * @return The list of parameter doc tags for this method.
107 */
108 public abstract ParamTag[]
paramTags()109 paramTags();
110
111 /*************************************************************************/
112
113 /**
114 * This method returns the signature of this method in pseudo-code format,
115 * with fully qualified class references. For example, the method
116 * <code>read(String str, boolean bool)</code> would have the signature
117 * <code>(java.lang.String, boolean)</code> returned by this method.
118 *
119 * @return The signature for this method.
120 */
121 public abstract String
signature()122 signature();
123
124 /*************************************************************************/
125
126 /**
127 * This method returns the signature of this method in pseudo-code format,
128 * with uqualified class references. For example, the method
129 * <code>read(String str, boolean bool)</code> would have the signature
130 * <code>(String, boolean)</code> returned by this method.
131 *
132 * @return The signature for this method.
133 */
134 public abstract String
flatSignature()135 flatSignature();
136
137 } // interface ExecutableMemberDoc
138