src/share/classes/javax/lang/model/element/ExecutableElement.java

Mon, 18 Mar 2013 18:33:13 -0700

author
jjg
date
Mon, 18 Mar 2013 18:33:13 -0700
changeset 1645
97f6839673d6
parent 1459
bc74006c2d8d
child 2525
2eb010b6cb22
permissions
-rw-r--r--

8007803: Implement javax.lang.model API for Type Annotations
Reviewed-by: darcy

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

mercurial