Mercurial > jdk8-mips64-public > langtools / annotate
src/share/classes/javax/lang/model/element/ExecutableElement.java@2eb010b6cb22 (annotated)
src/share/classes/javax/lang/model/element/ExecutableElement.java
Thu, 31 Aug 2017 15:17:03 +0800
- author
- aoqi
- date
- Thu, 31 Aug 2017 15:17:03 +0800
- changeset 2525
- 2eb010b6cb22
- parent 1645
- 97f6839673d6
- parent 0
- 959103a6100f
- permissions
- -rw-r--r--
merge
| aoqi@0 | 1 | /* |
| aoqi@0 | 2 | * Copyright (c) 2005, 2013, Oracle and/or its affiliates. All rights reserved. |
| aoqi@0 | 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
| aoqi@0 | 4 | * |
| aoqi@0 | 5 | * This code is free software; you can redistribute it and/or modify it |
| aoqi@0 | 6 | * under the terms of the GNU General Public License version 2 only, as |
| aoqi@0 | 7 | * published by the Free Software Foundation. Oracle designates this |
| aoqi@0 | 8 | * particular file as subject to the "Classpath" exception as provided |
| aoqi@0 | 9 | * by Oracle in the LICENSE file that accompanied this code. |
| aoqi@0 | 10 | * |
| aoqi@0 | 11 | * This code is distributed in the hope that it will be useful, but WITHOUT |
| aoqi@0 | 12 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
| aoqi@0 | 13 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
| aoqi@0 | 14 | * version 2 for more details (a copy is included in the LICENSE file that |
| aoqi@0 | 15 | * accompanied this code). |
| aoqi@0 | 16 | * |
| aoqi@0 | 17 | * You should have received a copy of the GNU General Public License version |
| aoqi@0 | 18 | * 2 along with this work; if not, write to the Free Software Foundation, |
| aoqi@0 | 19 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
| aoqi@0 | 20 | * |
| aoqi@0 | 21 | * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
| aoqi@0 | 22 | * or visit www.oracle.com if you need additional information or have any |
| aoqi@0 | 23 | * questions. |
| aoqi@0 | 24 | */ |
| aoqi@0 | 25 | |
| aoqi@0 | 26 | package javax.lang.model.element; |
| aoqi@0 | 27 | |
| aoqi@0 | 28 | import java.util.List; |
| aoqi@0 | 29 | import javax.lang.model.type.*; |
| aoqi@0 | 30 | |
| aoqi@0 | 31 | /** |
| aoqi@0 | 32 | * Represents a method, constructor, or initializer (static or |
| aoqi@0 | 33 | * instance) of a class or interface, including annotation type |
| aoqi@0 | 34 | * elements. |
| aoqi@0 | 35 | * |
| aoqi@0 | 36 | * @author Joseph D. Darcy |
| aoqi@0 | 37 | * @author Scott Seligman |
| aoqi@0 | 38 | * @author Peter von der Ahé |
| aoqi@0 | 39 | * @see ExecutableType |
| aoqi@0 | 40 | * @since 1.6 |
| aoqi@0 | 41 | */ |
| aoqi@0 | 42 | public interface ExecutableElement extends Element, Parameterizable { |
| aoqi@0 | 43 | /** |
| aoqi@0 | 44 | * Returns the formal type parameters of this executable |
| aoqi@0 | 45 | * in declaration order. |
| aoqi@0 | 46 | * |
| aoqi@0 | 47 | * @return the formal type parameters, or an empty list |
| aoqi@0 | 48 | * if there are none |
| aoqi@0 | 49 | */ |
| aoqi@0 | 50 | List<? extends TypeParameterElement> getTypeParameters(); |
| aoqi@0 | 51 | |
| aoqi@0 | 52 | /** |
| aoqi@0 | 53 | * Returns the return type of this executable. |
| aoqi@0 | 54 | * Returns a {@link NoType} with kind {@link TypeKind#VOID VOID} |
| aoqi@0 | 55 | * if this executable is not a method, or is a method that does not |
| aoqi@0 | 56 | * return a value. |
| aoqi@0 | 57 | * |
| aoqi@0 | 58 | * @return the return type of this executable |
| aoqi@0 | 59 | */ |
| aoqi@0 | 60 | TypeMirror getReturnType(); |
| aoqi@0 | 61 | |
| aoqi@0 | 62 | /** |
| aoqi@0 | 63 | * Returns the formal parameters of this executable. |
| aoqi@0 | 64 | * They are returned in declaration order. |
| aoqi@0 | 65 | * |
| aoqi@0 | 66 | * @return the formal parameters, |
| aoqi@0 | 67 | * or an empty list if there are none |
| aoqi@0 | 68 | */ |
| aoqi@0 | 69 | List<? extends VariableElement> getParameters(); |
| aoqi@0 | 70 | |
| aoqi@0 | 71 | /** |
| aoqi@0 | 72 | * Returns the receiver type of this executable, |
| aoqi@0 | 73 | * or {@link javax.lang.model.type.NoType NoType} with |
| aoqi@0 | 74 | * kind {@link javax.lang.model.type.TypeKind#NONE NONE} |
| aoqi@0 | 75 | * if the executable has no receiver type. |
| aoqi@0 | 76 | * |
| aoqi@0 | 77 | * An executable which is an instance method, or a constructor of an |
| aoqi@0 | 78 | * inner class, has a receiver type derived from the {@linkplain |
| aoqi@0 | 79 | * #getEnclosingElement declaring type}. |
| aoqi@0 | 80 | * |
| aoqi@0 | 81 | * An executable which is a static method, or a constructor of a |
| aoqi@0 | 82 | * non-inner class, or an initializer (static or instance), has no |
| aoqi@0 | 83 | * receiver type. |
| aoqi@0 | 84 | * |
| aoqi@0 | 85 | * @return the receiver type of this executable |
| aoqi@0 | 86 | * @since 1.8 |
| aoqi@0 | 87 | */ |
| aoqi@0 | 88 | TypeMirror getReceiverType(); |
| aoqi@0 | 89 | |
| aoqi@0 | 90 | /** |
| aoqi@0 | 91 | * Returns {@code true} if this method or constructor accepts a variable |
| aoqi@0 | 92 | * number of arguments and returns {@code false} otherwise. |
| aoqi@0 | 93 | * |
| aoqi@0 | 94 | * @return {@code true} if this method or constructor accepts a variable |
| aoqi@0 | 95 | * number of arguments and {@code false} otherwise |
| aoqi@0 | 96 | */ |
| aoqi@0 | 97 | boolean isVarArgs(); |
| aoqi@0 | 98 | |
| aoqi@0 | 99 | /** |
| aoqi@0 | 100 | * Returns {@code true} if this method is a default method and |
| aoqi@0 | 101 | * returns {@code false} otherwise. |
| aoqi@0 | 102 | * |
| aoqi@0 | 103 | * @return {@code true} if this method is a default method and |
| aoqi@0 | 104 | * {@code false} otherwise |
| aoqi@0 | 105 | * @since 1.8 |
| aoqi@0 | 106 | */ |
| aoqi@0 | 107 | boolean isDefault(); |
| aoqi@0 | 108 | |
| aoqi@0 | 109 | /** |
| aoqi@0 | 110 | * Returns the exceptions and other throwables listed in this |
| aoqi@0 | 111 | * method or constructor's {@code throws} clause in declaration |
| aoqi@0 | 112 | * order. |
| aoqi@0 | 113 | * |
| aoqi@0 | 114 | * @return the exceptions and other throwables listed in the |
| aoqi@0 | 115 | * {@code throws} clause, or an empty list if there are none |
| aoqi@0 | 116 | */ |
| aoqi@0 | 117 | List<? extends TypeMirror> getThrownTypes(); |
| aoqi@0 | 118 | |
| aoqi@0 | 119 | /** |
| aoqi@0 | 120 | * Returns the default value if this executable is an annotation |
| aoqi@0 | 121 | * type element. Returns {@code null} if this method is not an |
| aoqi@0 | 122 | * annotation type element, or if it is an annotation type element |
| aoqi@0 | 123 | * with no default value. |
| aoqi@0 | 124 | * |
| aoqi@0 | 125 | * @return the default value, or {@code null} if none |
| aoqi@0 | 126 | */ |
| aoqi@0 | 127 | AnnotationValue getDefaultValue(); |
| aoqi@0 | 128 | |
| aoqi@0 | 129 | /** |
| aoqi@0 | 130 | * Returns the simple name of a constructor, method, or |
| aoqi@0 | 131 | * initializer. For a constructor, the name {@code "<init>"} is |
| aoqi@0 | 132 | * returned, for a static initializer, the name {@code "<clinit>"} |
| aoqi@0 | 133 | * is returned, and for an anonymous class or instance |
| aoqi@0 | 134 | * initializer, an empty name is returned. |
| aoqi@0 | 135 | * |
| aoqi@0 | 136 | * @return the simple name of a constructor, method, or |
| aoqi@0 | 137 | * initializer |
| aoqi@0 | 138 | */ |
| aoqi@0 | 139 | @Override |
| aoqi@0 | 140 | Name getSimpleName(); |
| aoqi@0 | 141 | } |
