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

Tue, 19 Mar 2013 15:13:44 -0700

author
jjg
date
Tue, 19 Mar 2013 15:13:44 -0700
changeset 1647
578eb3dd111d
parent 1645
97f6839673d6
child 1651
972474640b7d
permissions
-rw-r--r--

8010315: doclint errors in javac public API
Reviewed-by: darcy

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

mercurial