1 /* 2 * Copyright (c) 2005, 2013, 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 javax.lang.model.element; 27 28 import java.util.List; 29 import javax.lang.model.type.*; 30 31 /** 32 * Represents a method, constructor, or initializer (static or 33 * instance) of a class or interface, including annotation type 34 * elements. 35 * 36 * @author Joseph D. Darcy 37 * @author Scott Seligman 38 * @author Peter von der Ahé 39 * @see ExecutableType 40 * @since 1.6 41 */ 42 public interface ExecutableElement extends Element, Parameterizable { 43 /** 44 * Returns the formal type parameters of this executable 45 * in declaration order. 46 * 47 * @return the formal type parameters, or an empty list 48 * if there are none 49 */ 50 List<? extends TypeParameterElement> getTypeParameters(); 51 52 /** 53 * Returns the return type of this executable. 54 * Returns a {@link NoType} with kind {@link TypeKind#VOID VOID} 55 * if this executable is not a method, or is a method that does not 56 * return a value. 57 * 58 * @return the return type of this executable 59 */ 60 TypeMirror getReturnType(); 61 62 /** 63 * Returns the formal parameters of this executable. 64 * They are returned in declaration order. 65 * 66 * @return the formal parameters, 67 * or an empty list if there are none 68 */ 69 List<? extends VariableElement> getParameters(); 70 71 /** 72 * Returns the receiver type of this executable, 73 * or {@link javax.lang.model.type.NoType NoType} with 74 * kind {@link javax.lang.model.type.TypeKind#NONE NONE} 75 * if the executable has no receiver type. 76 * 77 * An executable which is an instance method, or a constructor of an 78 * inner class, has a receiver type derived from the {@linkplain 79 * #getEnclosingElement declaring type}. 80 * 81 * An executable which is a static method, or a constructor of a 82 * non-inner class, or an initializer (static or instance), has no 83 * receiver type. 84 * 85 * @return the receiver type of this executable 86 * @since 1.8 87 */ 88 TypeMirror getReceiverType(); 89 90 /** 91 * Returns {@code true} if this method or constructor accepts a variable 92 * number of arguments and returns {@code false} otherwise. 93 * 94 * @return {@code true} if this method or constructor accepts a variable 95 * number of arguments and {@code false} otherwise 96 */ 97 boolean isVarArgs(); 98 99 /** 100 * Returns {@code true} if this method is a default method and 101 * returns {@code false} otherwise. 102 * 103 * @return {@code true} if this method is a default method and 104 * {@code false} otherwise 105 * @since 1.8 106 */ 107 boolean isDefault(); 108 109 /** 110 * Returns the exceptions and other throwables listed in this 111 * method or constructor's {@code throws} clause in declaration 112 * order. 113 * 114 * @return the exceptions and other throwables listed in the 115 * {@code throws} clause, or an empty list if there are none 116 */ 117 List<? extends TypeMirror> getThrownTypes(); 118 119 /** 120 * Returns the default value if this executable is an annotation 121 * type element. Returns {@code null} if this method is not an 122 * annotation type element, or if it is an annotation type element 123 * with no default value. 124 * 125 * @return the default value, or {@code null} if none 126 */ 127 AnnotationValue getDefaultValue(); 128 129 /** 130 * Returns the simple name of a constructor, method, or 131 * initializer. For a constructor, the name {@code "<init>"} is 132 * returned, for a static initializer, the name {@code "<clinit>"} 133 * is returned, and for an anonymous class or instance 134 * initializer, an empty name is returned. 135 * 136 * @return the simple name of a constructor, method, or 137 * initializer 138 */ 139 @Override 140 Name getSimpleName(); 141 }