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