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