1 /* |
|
2 * Copyright (c) 1998, 2018, Oracle and/or its affiliates. All rights reserved. |
|
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
|
4 * |
|
5 * This code is free software; you can redistribute it and/or modify it |
|
6 * under the terms of the GNU General Public License version 2 only, as |
|
7 * published by the Free Software Foundation. Oracle designates this |
|
8 * particular file as subject to the "Classpath" exception as provided |
|
9 * by Oracle in the LICENSE file that accompanied this code. |
|
10 * |
|
11 * This code is distributed in the hope that it will be useful, but WITHOUT |
|
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
|
13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
|
14 * version 2 for more details (a copy is included in the LICENSE file that |
|
15 * accompanied this code). |
|
16 * |
|
17 * You should have received a copy of the GNU General Public License version |
|
18 * 2 along with this work; if not, write to the Free Software Foundation, |
|
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
|
20 * |
|
21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
|
22 * or visit www.oracle.com if you need additional information or have any |
|
23 * questions. |
|
24 */ |
|
25 |
|
26 package com.sun.javadoc; |
|
27 |
|
28 /** |
|
29 * Represents a method or constructor of a java class. |
|
30 * |
|
31 * @since 1.2 |
|
32 * @author Robert Field |
|
33 * |
|
34 * @deprecated |
|
35 * The declarations in this package have been superseded by those |
|
36 * in the package {@code jdk.javadoc.doclet}. |
|
37 * For more information, see the <i>Migration Guide</i> in the documentation for that package. |
|
38 */ |
|
39 @Deprecated(since="9", forRemoval=true) |
|
40 @SuppressWarnings("removal") |
|
41 public interface ExecutableMemberDoc extends MemberDoc { |
|
42 |
|
43 /** |
|
44 * Return exceptions this method or constructor throws. |
|
45 * If the type of the exception is a type variable, return the |
|
46 * {@code ClassDoc} of its erasure. |
|
47 * |
|
48 * <p> <i>The {@code thrownExceptions} method cannot |
|
49 * accommodate certain generic type constructs. The |
|
50 * {@code thrownExceptionTypes} method should be used |
|
51 * instead.</i> |
|
52 * |
|
53 * @return an array of ClassDoc[] representing the exceptions |
|
54 * thrown by this method. |
|
55 * @see #thrownExceptionTypes |
|
56 */ |
|
57 ClassDoc[] thrownExceptions(); |
|
58 |
|
59 /** |
|
60 * Return exceptions this method or constructor throws. |
|
61 * |
|
62 * @return an array representing the exceptions thrown by this method. |
|
63 * Each array element is either a {@code ClassDoc} or a |
|
64 * {@code TypeVariable}. |
|
65 * @since 1.5 |
|
66 */ |
|
67 Type[] thrownExceptionTypes(); |
|
68 |
|
69 /** |
|
70 * Return true if this method is native |
|
71 * |
|
72 * @return true if this method is native |
|
73 */ |
|
74 boolean isNative(); |
|
75 |
|
76 /** |
|
77 * Return true if this method is synchronized |
|
78 * |
|
79 * @return true if this method is synchronized |
|
80 */ |
|
81 boolean isSynchronized(); |
|
82 |
|
83 /** |
|
84 * Return true if this method was declared to take a variable number |
|
85 * of arguments. |
|
86 * |
|
87 * @since 1.5 |
|
88 * @return true if this method was declared to take a variable number of arguments. |
|
89 */ |
|
90 public boolean isVarArgs(); |
|
91 |
|
92 /** |
|
93 * Get argument information. |
|
94 * |
|
95 * @see Parameter |
|
96 * |
|
97 * @return an array of Parameter, one element per argument |
|
98 * in the order the arguments are present. |
|
99 */ |
|
100 Parameter[] parameters(); |
|
101 |
|
102 /** |
|
103 * Get the receiver type of this executable element. |
|
104 * |
|
105 * @return the receiver type of this executable element. |
|
106 * @since 1.8 |
|
107 */ |
|
108 Type receiverType(); |
|
109 |
|
110 /** |
|
111 * Return the throws tags in this method. |
|
112 * |
|
113 * @return an array of ThrowTag containing all {@code @exception} |
|
114 * and {@code @throws} tags. |
|
115 */ |
|
116 ThrowsTag[] throwsTags(); |
|
117 |
|
118 /** |
|
119 * Return the param tags in this method, excluding the type |
|
120 * parameter tags. |
|
121 * |
|
122 * @return an array of ParamTag containing all {@code @param} tags |
|
123 * corresponding to the parameters of this method. |
|
124 */ |
|
125 ParamTag[] paramTags(); |
|
126 |
|
127 /** |
|
128 * Return the type parameter tags in this method. |
|
129 * |
|
130 * @return an array of ParamTag containing all {@code @param} tags |
|
131 * corresponding to the type parameters of this method. |
|
132 * @since 1.5 |
|
133 */ |
|
134 ParamTag[] typeParamTags(); |
|
135 |
|
136 /** |
|
137 * Get the signature. It is the parameter list, type is qualified. |
|
138 * For instance, for a method {@code mymethod(String x, int y)}, |
|
139 * it will return {@code (java.lang.String,int)}. |
|
140 * |
|
141 * @return the parameter list where type is qualified. |
|
142 */ |
|
143 String signature(); |
|
144 |
|
145 /** |
|
146 * get flat signature. all types are not qualified. |
|
147 * return a String, which is the flat signiture of this member. |
|
148 * It is the parameter list, type is not qualified. |
|
149 * For instance, for a method {@code mymethod(String x, int y)}, |
|
150 * it will return {@code (String, int)}. |
|
151 * |
|
152 * @return a String, which is the flat signiture of this member. |
|
153 */ |
|
154 String flatSignature(); |
|
155 |
|
156 /** |
|
157 * Return the formal type parameters of this method or constructor. |
|
158 * Return an empty array if this method or constructor is not generic. |
|
159 * |
|
160 * @return the formal type parameters of this method or constructor. |
|
161 * @since 1.5 |
|
162 */ |
|
163 TypeVariable[] typeParameters(); |
|
164 } |
|