aoqi@0: /*
aoqi@0:  * Copyright (c) 2005, 2013, Oracle and/or its affiliates. All rights reserved.
aoqi@0:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
aoqi@0:  *
aoqi@0:  * This code is free software; you can redistribute it and/or modify it
aoqi@0:  * under the terms of the GNU General Public License version 2 only, as
aoqi@0:  * published by the Free Software Foundation.  Oracle designates this
aoqi@0:  * particular file as subject to the "Classpath" exception as provided
aoqi@0:  * by Oracle in the LICENSE file that accompanied this code.
aoqi@0:  *
aoqi@0:  * This code is distributed in the hope that it will be useful, but WITHOUT
aoqi@0:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
aoqi@0:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
aoqi@0:  * version 2 for more details (a copy is included in the LICENSE file that
aoqi@0:  * accompanied this code).
aoqi@0:  *
aoqi@0:  * You should have received a copy of the GNU General Public License version
aoqi@0:  * 2 along with this work; if not, write to the Free Software Foundation,
aoqi@0:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
aoqi@0:  *
aoqi@0:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
aoqi@0:  * or visit www.oracle.com if you need additional information or have any
aoqi@0:  * questions.
aoqi@0:  */
aoqi@0: 
aoqi@0: package javax.lang.model.type;
aoqi@0: 
aoqi@0: 
aoqi@0: import java.util.List;
aoqi@0: 
aoqi@0: import javax.lang.model.element.ExecutableElement;
aoqi@0: 
aoqi@0: /**
aoqi@0:  * Represents the type of an executable.  An <i>executable</i>
aoqi@0:  * is a method, constructor, or initializer.
aoqi@0:  *
aoqi@0:  * <p> The executable is
aoqi@0:  * represented as when viewed as a method (or constructor or
aoqi@0:  * initializer) of some reference type.
aoqi@0:  * If that reference type is parameterized, then its actual
aoqi@0:  * type arguments are substituted into any types returned by the methods of
aoqi@0:  * this interface.
aoqi@0:  *
aoqi@0:  * @author Joseph D. Darcy
aoqi@0:  * @author Scott Seligman
aoqi@0:  * @author Peter von der Ah&eacute;
aoqi@0:  * @see ExecutableElement
aoqi@0:  * @since 1.6
aoqi@0:  */
aoqi@0: public interface ExecutableType extends TypeMirror {
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Returns the type variables declared by the formal type parameters
aoqi@0:      * of this executable.
aoqi@0:      *
aoqi@0:      * @return the type variables declared by the formal type parameters,
aoqi@0:      *          or an empty list if there are none
aoqi@0:      */
aoqi@0:     List<? extends TypeVariable> getTypeVariables();
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Returns the return type of this executable.
aoqi@0:      * Returns a {@link NoType} with kind {@link TypeKind#VOID VOID}
aoqi@0:      * if this executable is not a method, or is a method that does not
aoqi@0:      * return a value.
aoqi@0:      *
aoqi@0:      * @return the return type of this executable
aoqi@0:      */
aoqi@0:     TypeMirror getReturnType();
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Returns the types of this executable's formal parameters.
aoqi@0:      *
aoqi@0:      * @return the types of this executable's formal parameters,
aoqi@0:      *          or an empty list if there are none
aoqi@0:      */
aoqi@0:     List<? extends TypeMirror> getParameterTypes();
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Returns the receiver type of this executable,
aoqi@0:      * or {@link javax.lang.model.type.NoType NoType} with
aoqi@0:      * kind {@link javax.lang.model.type.TypeKind#NONE NONE}
aoqi@0:      * if the executable has no receiver type.
aoqi@0:      *
aoqi@0:      * An executable which is an instance method, or a constructor of an
aoqi@0:      * inner class, has a receiver type derived from the {@linkplain
aoqi@0:      * ExecutableElement#getEnclosingElement declaring type}.
aoqi@0:      *
aoqi@0:      * An executable which is a static method, or a constructor of a
aoqi@0:      * non-inner class, or an initializer (static or instance), has no
aoqi@0:      * receiver type.
aoqi@0:      *
aoqi@0:      * @return the receiver type of this executable
aoqi@0:      * @since 1.8
aoqi@0:      */
aoqi@0:     TypeMirror getReceiverType();
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Returns the exceptions and other throwables listed in this
aoqi@0:      * executable's {@code throws} clause.
aoqi@0:      *
aoqi@0:      * @return the exceptions and other throwables listed in this
aoqi@0:      *          executable's {@code throws} clause,
aoqi@0:      *          or an empty list if there are none.
aoqi@0:      */
aoqi@0:     List<? extends TypeMirror> getThrownTypes();
aoqi@0: }