langtools/src/share/classes/javax/lang/model/type/ExecutableType.java
author jjg
Wed, 23 Jan 2013 13:27:24 -0800
changeset 15385 ee1eebe7e210
parent 5520 86e4b9a9da40
child 16556 f4adc5bb4652
permissions -rw-r--r--
8006775: JSR 308: Compiler changes in JDK8 Reviewed-by: jjg Contributed-by: mernst@cs.washington.edu, wmdietl@cs.washington.edu, mpapi@csail.mit.edu, mahmood@notnoop.com
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
10
06bc494ca11e Initial load
duke
parents:
diff changeset
     1
/*
15385
ee1eebe7e210 8006775: JSR 308: Compiler changes in JDK8
jjg
parents: 5520
diff changeset
     2
 * Copyright (c) 2005, 2013, Oracle and/or its affiliates. All rights reserved.
10
06bc494ca11e Initial load
duke
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
06bc494ca11e Initial load
duke
parents:
diff changeset
     4
 *
06bc494ca11e Initial load
duke
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
06bc494ca11e Initial load
duke
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
5520
86e4b9a9da40 6943119: Rebrand source copyright notices
ohair
parents: 10
diff changeset
     7
 * published by the Free Software Foundation.  Oracle designates this
10
06bc494ca11e Initial load
duke
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
5520
86e4b9a9da40 6943119: Rebrand source copyright notices
ohair
parents: 10
diff changeset
     9
 * by Oracle in the LICENSE file that accompanied this code.
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    10
 *
06bc494ca11e Initial load
duke
parents:
diff changeset
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
06bc494ca11e Initial load
duke
parents:
diff changeset
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
06bc494ca11e Initial load
duke
parents:
diff changeset
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
06bc494ca11e Initial load
duke
parents:
diff changeset
    14
 * version 2 for more details (a copy is included in the LICENSE file that
06bc494ca11e Initial load
duke
parents:
diff changeset
    15
 * accompanied this code).
06bc494ca11e Initial load
duke
parents:
diff changeset
    16
 *
06bc494ca11e Initial load
duke
parents:
diff changeset
    17
 * You should have received a copy of the GNU General Public License version
06bc494ca11e Initial load
duke
parents:
diff changeset
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
06bc494ca11e Initial load
duke
parents:
diff changeset
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
06bc494ca11e Initial load
duke
parents:
diff changeset
    20
 *
5520
86e4b9a9da40 6943119: Rebrand source copyright notices
ohair
parents: 10
diff changeset
    21
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
86e4b9a9da40 6943119: Rebrand source copyright notices
ohair
parents: 10
diff changeset
    22
 * or visit www.oracle.com if you need additional information or have any
86e4b9a9da40 6943119: Rebrand source copyright notices
ohair
parents: 10
diff changeset
    23
 * questions.
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    24
 */
06bc494ca11e Initial load
duke
parents:
diff changeset
    25
06bc494ca11e Initial load
duke
parents:
diff changeset
    26
package javax.lang.model.type;
06bc494ca11e Initial load
duke
parents:
diff changeset
    27
06bc494ca11e Initial load
duke
parents:
diff changeset
    28
06bc494ca11e Initial load
duke
parents:
diff changeset
    29
import java.util.List;
06bc494ca11e Initial load
duke
parents:
diff changeset
    30
06bc494ca11e Initial load
duke
parents:
diff changeset
    31
import javax.lang.model.element.ExecutableElement;
06bc494ca11e Initial load
duke
parents:
diff changeset
    32
06bc494ca11e Initial load
duke
parents:
diff changeset
    33
06bc494ca11e Initial load
duke
parents:
diff changeset
    34
/**
06bc494ca11e Initial load
duke
parents:
diff changeset
    35
 * Represents the type of an executable.  An <i>executable</i>
06bc494ca11e Initial load
duke
parents:
diff changeset
    36
 * is a method, constructor, or initializer.
06bc494ca11e Initial load
duke
parents:
diff changeset
    37
 *
06bc494ca11e Initial load
duke
parents:
diff changeset
    38
 * <p> The executable is
06bc494ca11e Initial load
duke
parents:
diff changeset
    39
 * represented as when viewed as a method (or constructor or
06bc494ca11e Initial load
duke
parents:
diff changeset
    40
 * initializer) of some reference type.
06bc494ca11e Initial load
duke
parents:
diff changeset
    41
 * If that reference type is parameterized, then its actual
06bc494ca11e Initial load
duke
parents:
diff changeset
    42
 * type arguments are substituted into any types returned by the methods of
06bc494ca11e Initial load
duke
parents:
diff changeset
    43
 * this interface.
06bc494ca11e Initial load
duke
parents:
diff changeset
    44
 *
06bc494ca11e Initial load
duke
parents:
diff changeset
    45
 * @author Joseph D. Darcy
06bc494ca11e Initial load
duke
parents:
diff changeset
    46
 * @author Scott Seligman
06bc494ca11e Initial load
duke
parents:
diff changeset
    47
 * @author Peter von der Ah&eacute;
06bc494ca11e Initial load
duke
parents:
diff changeset
    48
 * @see ExecutableElement
06bc494ca11e Initial load
duke
parents:
diff changeset
    49
 * @since 1.6
06bc494ca11e Initial load
duke
parents:
diff changeset
    50
 */
06bc494ca11e Initial load
duke
parents:
diff changeset
    51
public interface ExecutableType extends TypeMirror {
06bc494ca11e Initial load
duke
parents:
diff changeset
    52
06bc494ca11e Initial load
duke
parents:
diff changeset
    53
    /**
06bc494ca11e Initial load
duke
parents:
diff changeset
    54
     * Returns the type variables declared by the formal type parameters
06bc494ca11e Initial load
duke
parents:
diff changeset
    55
     * of this executable.
06bc494ca11e Initial load
duke
parents:
diff changeset
    56
     *
06bc494ca11e Initial load
duke
parents:
diff changeset
    57
     * @return the type variables declared by the formal type parameters,
06bc494ca11e Initial load
duke
parents:
diff changeset
    58
     *          or an empty list if there are none
06bc494ca11e Initial load
duke
parents:
diff changeset
    59
     */
06bc494ca11e Initial load
duke
parents:
diff changeset
    60
    List<? extends TypeVariable> getTypeVariables();
06bc494ca11e Initial load
duke
parents:
diff changeset
    61
06bc494ca11e Initial load
duke
parents:
diff changeset
    62
    /**
06bc494ca11e Initial load
duke
parents:
diff changeset
    63
     * Returns the return type of this executable.
06bc494ca11e Initial load
duke
parents:
diff changeset
    64
     * Returns a {@link NoType} with kind {@link TypeKind#VOID VOID}
06bc494ca11e Initial load
duke
parents:
diff changeset
    65
     * if this executable is not a method, or is a method that does not
06bc494ca11e Initial load
duke
parents:
diff changeset
    66
     * return a value.
06bc494ca11e Initial load
duke
parents:
diff changeset
    67
     *
06bc494ca11e Initial load
duke
parents:
diff changeset
    68
     * @return the return type of this executable
06bc494ca11e Initial load
duke
parents:
diff changeset
    69
     */
06bc494ca11e Initial load
duke
parents:
diff changeset
    70
    TypeMirror getReturnType();
06bc494ca11e Initial load
duke
parents:
diff changeset
    71
06bc494ca11e Initial load
duke
parents:
diff changeset
    72
    /**
06bc494ca11e Initial load
duke
parents:
diff changeset
    73
     * Returns the types of this executable's formal parameters.
06bc494ca11e Initial load
duke
parents:
diff changeset
    74
     *
06bc494ca11e Initial load
duke
parents:
diff changeset
    75
     * @return the types of this executable's formal parameters,
06bc494ca11e Initial load
duke
parents:
diff changeset
    76
     *          or an empty list if there are none
06bc494ca11e Initial load
duke
parents:
diff changeset
    77
     */
06bc494ca11e Initial load
duke
parents:
diff changeset
    78
    List<? extends TypeMirror> getParameterTypes();
06bc494ca11e Initial load
duke
parents:
diff changeset
    79
06bc494ca11e Initial load
duke
parents:
diff changeset
    80
    /**
15385
ee1eebe7e210 8006775: JSR 308: Compiler changes in JDK8
jjg
parents: 5520
diff changeset
    81
     * Returns the type of this executable's receiver parameter.
ee1eebe7e210 8006775: JSR 308: Compiler changes in JDK8
jjg
parents: 5520
diff changeset
    82
     *
ee1eebe7e210 8006775: JSR 308: Compiler changes in JDK8
jjg
parents: 5520
diff changeset
    83
     * @return the type of this executable's receiver parameter
ee1eebe7e210 8006775: JSR 308: Compiler changes in JDK8
jjg
parents: 5520
diff changeset
    84
     * TODO: null if none specified or always a valid value?
ee1eebe7e210 8006775: JSR 308: Compiler changes in JDK8
jjg
parents: 5520
diff changeset
    85
     */
ee1eebe7e210 8006775: JSR 308: Compiler changes in JDK8
jjg
parents: 5520
diff changeset
    86
    TypeMirror getReceiverType();
ee1eebe7e210 8006775: JSR 308: Compiler changes in JDK8
jjg
parents: 5520
diff changeset
    87
ee1eebe7e210 8006775: JSR 308: Compiler changes in JDK8
jjg
parents: 5520
diff changeset
    88
    /**
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    89
     * Returns the exceptions and other throwables listed in this
06bc494ca11e Initial load
duke
parents:
diff changeset
    90
     * executable's {@code throws} clause.
06bc494ca11e Initial load
duke
parents:
diff changeset
    91
     *
06bc494ca11e Initial load
duke
parents:
diff changeset
    92
     * @return the exceptions and other throwables listed in this
06bc494ca11e Initial load
duke
parents:
diff changeset
    93
     *          executable's {@code throws} clause,
06bc494ca11e Initial load
duke
parents:
diff changeset
    94
     *          or an empty list if there are none.
06bc494ca11e Initial load
duke
parents:
diff changeset
    95
     */
06bc494ca11e Initial load
duke
parents:
diff changeset
    96
    List<? extends TypeMirror> getThrownTypes();
06bc494ca11e Initial load
duke
parents:
diff changeset
    97
}