src/share/classes/javax/lang/model/type/ExecutableType.java

Wed, 20 Mar 2013 17:41:40 -0700

author
darcy
date
Wed, 20 Mar 2013 17:41:40 -0700
changeset 1651
972474640b7d
parent 1647
578eb3dd111d
child 2525
2eb010b6cb22
permissions
-rw-r--r--

8010364: Clarify javax.lang.model API for Type Annotations
Reviewed-by: jjg, abuckley

duke@1 1 /*
jjg@1521 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.type;
duke@1 27
duke@1 28
duke@1 29 import java.util.List;
duke@1 30
duke@1 31 import javax.lang.model.element.ExecutableElement;
duke@1 32
duke@1 33 /**
duke@1 34 * Represents the type of an executable. An <i>executable</i>
duke@1 35 * is a method, constructor, or initializer.
duke@1 36 *
duke@1 37 * <p> The executable is
duke@1 38 * represented as when viewed as a method (or constructor or
duke@1 39 * initializer) of some reference type.
duke@1 40 * If that reference type is parameterized, then its actual
duke@1 41 * type arguments are substituted into any types returned by the methods of
duke@1 42 * this interface.
duke@1 43 *
duke@1 44 * @author Joseph D. Darcy
duke@1 45 * @author Scott Seligman
duke@1 46 * @author Peter von der Ah&eacute;
duke@1 47 * @see ExecutableElement
duke@1 48 * @since 1.6
duke@1 49 */
duke@1 50 public interface ExecutableType extends TypeMirror {
duke@1 51
duke@1 52 /**
duke@1 53 * Returns the type variables declared by the formal type parameters
duke@1 54 * of this executable.
duke@1 55 *
duke@1 56 * @return the type variables declared by the formal type parameters,
duke@1 57 * or an empty list if there are none
duke@1 58 */
duke@1 59 List<? extends TypeVariable> getTypeVariables();
duke@1 60
duke@1 61 /**
duke@1 62 * Returns the return type of this executable.
duke@1 63 * Returns a {@link NoType} with kind {@link TypeKind#VOID VOID}
duke@1 64 * if this executable is not a method, or is a method that does not
duke@1 65 * return a value.
duke@1 66 *
duke@1 67 * @return the return type of this executable
duke@1 68 */
duke@1 69 TypeMirror getReturnType();
duke@1 70
duke@1 71 /**
duke@1 72 * Returns the types of this executable's formal parameters.
duke@1 73 *
duke@1 74 * @return the types of this executable's formal parameters,
duke@1 75 * or an empty list if there are none
duke@1 76 */
duke@1 77 List<? extends TypeMirror> getParameterTypes();
duke@1 78
duke@1 79 /**
jjg@1645 80 * Returns the receiver type of this executable,
jjg@1645 81 * or {@link javax.lang.model.type.NoType NoType} with
jjg@1645 82 * kind {@link javax.lang.model.type.TypeKind#NONE NONE}
jjg@1645 83 * if the executable has no receiver type.
jjg@1645 84 *
jjg@1645 85 * An executable which is an instance method, or a constructor of an
jjg@1645 86 * inner class, has a receiver type derived from the {@linkplain
jjg@1647 87 * ExecutableElement#getEnclosingElement declaring type}.
jjg@1645 88 *
jjg@1645 89 * An executable which is a static method, or a constructor of a
jjg@1645 90 * non-inner class, or an initializer (static or instance), has no
jjg@1645 91 * receiver type.
jjg@1645 92 *
jjg@1645 93 * @return the receiver type of this executable
jjg@1645 94 * @since 1.8
jjg@1645 95 */
jjg@1645 96 TypeMirror getReceiverType();
jjg@1645 97
jjg@1645 98 /**
duke@1 99 * Returns the exceptions and other throwables listed in this
duke@1 100 * executable's {@code throws} clause.
duke@1 101 *
duke@1 102 * @return the exceptions and other throwables listed in this
duke@1 103 * executable's {@code throws} clause,
duke@1 104 * or an empty list if there are none.
duke@1 105 */
duke@1 106 List<? extends TypeMirror> getThrownTypes();
duke@1 107 }

mercurial