src/share/classes/javax/lang/model/element/ExecutableElement.java

Tue, 09 Oct 2012 19:10:00 -0700

author
jjg
date
Tue, 09 Oct 2012 19:10:00 -0700
changeset 1357
c75be5bc5283
parent 849
7a75a1803c7a
child 1459
bc74006c2d8d
permissions
-rw-r--r--

8000663: clean up langtools imports
Reviewed-by: darcy

     1 /*
     2  * Copyright (c) 2005, 2012, Oracle and/or its affiliates. All rights reserved.
     3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
     4  *
     5  * This code is free software; you can redistribute it and/or modify it
     6  * under the terms of the GNU General Public License version 2 only, as
     7  * published by the Free Software Foundation.  Oracle designates this
     8  * particular file as subject to the "Classpath" exception as provided
     9  * by Oracle in the LICENSE file that accompanied this code.
    10  *
    11  * This code is distributed in the hope that it will be useful, but WITHOUT
    12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
    13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
    14  * version 2 for more details (a copy is included in the LICENSE file that
    15  * accompanied this code).
    16  *
    17  * You should have received a copy of the GNU General Public License version
    18  * 2 along with this work; if not, write to the Free Software Foundation,
    19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
    20  *
    21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
    22  * or visit www.oracle.com if you need additional information or have any
    23  * questions.
    24  */
    26 package javax.lang.model.element;
    28 import java.util.List;
    29 import javax.lang.model.type.*;
    31 /**
    32  * Represents a method, constructor, or initializer (static or
    33  * instance) of a class or interface, including annotation type
    34  * elements.
    35  *
    36  * @author Joseph D. Darcy
    37  * @author Scott Seligman
    38  * @author Peter von der Ahé
    39  * @see ExecutableType
    40  * @since 1.6
    41  */
    42 public interface ExecutableElement extends Element, Parameterizable {
    43     /**
    44      * Returns the formal type parameters of this executable
    45      * in declaration order.
    46      *
    47      * @return the formal type parameters, or an empty list
    48      * if there are none
    49      */
    50     List<? extends TypeParameterElement> getTypeParameters();
    52     /**
    53      * Returns the return type of this executable.
    54      * Returns a {@link NoType} with kind {@link TypeKind#VOID VOID}
    55      * if this executable is not a method, or is a method that does not
    56      * return a value.
    57      *
    58      * @return the return type of this executable
    59      */
    60     TypeMirror getReturnType();
    62     /**
    63      * Returns the formal parameters of this executable.
    64      * They are returned in declaration order.
    65      *
    66      * @return the formal parameters,
    67      * or an empty list if there are none
    68      */
    69     List<? extends VariableElement> getParameters();
    71     /**
    72      * Returns {@code true} if this method or constructor accepts a variable
    73      * number of arguments and returns {@code false} otherwise.
    74      *
    75      * @return {@code true} if this method or constructor accepts a variable
    76      * number of arguments and {@code false} otherwise
    77      */
    78     boolean isVarArgs();
    80     /**
    81      * Returns the exceptions and other throwables listed in this
    82      * method or constructor's {@code throws} clause in declaration
    83      * order.
    84      *
    85      * @return the exceptions and other throwables listed in the
    86      * {@code throws} clause, or an empty list if there are none
    87      */
    88     List<? extends TypeMirror> getThrownTypes();
    90     /**
    91      * Returns the default value if this executable is an annotation
    92      * type element.  Returns {@code null} if this method is not an
    93      * annotation type element, or if it is an annotation type element
    94      * with no default value.
    95      *
    96      * @return the default value, or {@code null} if none
    97      */
    98     AnnotationValue getDefaultValue();
   100     /**
   101      * Returns the simple name of a constructor, method, or
   102      * initializer.  For a constructor, the name {@code "<init>"} is
   103      * returned, for a static initializer, the name {@code "<clinit>"}
   104      * is returned, and for an anonymous class or instance
   105      * initializer, an empty name is returned.
   106      *
   107      * @return the simple name of a constructor, method, or
   108      * initializer
   109      */
   110     @Override
   111     Name getSimpleName();
   112 }

mercurial