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

Tue, 25 May 2010 15:54:51 -0700

author
ohair
date
Tue, 25 May 2010 15:54:51 -0700
changeset 554
9d9f26857129
parent 224
dab918a1c907
child 849
7a75a1803c7a
permissions
-rw-r--r--

6943119: Rebrand source copyright notices
Reviewed-by: darcy

     1 /*
     2  * Copyright (c) 2005, 2009, 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.util.Types;
    30 import javax.lang.model.type.*;
    32 /**
    33  * Represents a method, constructor, or initializer (static or
    34  * instance) of a class or interface, including annotation type
    35  * elements.
    36  *
    37  * @author Joseph D. Darcy
    38  * @author Scott Seligman
    39  * @author Peter von der Ahé
    40  * @see ExecutableType
    41  * @since 1.6
    42  */
    43 public interface ExecutableElement extends Element, Parameterizable {
    44     /**
    45      * Returns the formal type parameters of this executable
    46      * in declaration order.
    47      *
    48      * @return the formal type parameters, or an empty list
    49      * if there are none
    50      */
    51     List<? extends TypeParameterElement> getTypeParameters();
    53     /**
    54      * Returns the return type of this executable.
    55      * Returns a {@link NoType} with kind {@link TypeKind#VOID VOID}
    56      * if this executable is not a method, or is a method that does not
    57      * return a value.
    58      *
    59      * @return the return type of this executable
    60      */
    61     TypeMirror getReturnType();
    63     /**
    64      * Returns the formal parameters of this executable.
    65      * They are returned in declaration order.
    66      *
    67      * @return the formal parameters,
    68      * or an empty list if there are none
    69      */
    70     List<? extends VariableElement> getParameters();
    72     /**
    73      * Returns {@code true} if this method or constructor accepts a variable
    74      * number of arguments and returns {@code false} otherwise.
    75      *
    76      * @return {@code true} if this method or constructor accepts a variable
    77      * number of arguments and {@code false} otherwise
    78      */
    79     boolean isVarArgs();
    81     /**
    82      * Returns the exceptions and other throwables listed in this
    83      * method or constructor's {@code throws} clause in declaration
    84      * order.
    85      *
    86      * @return the exceptions and other throwables listed in the
    87      * {@code throws} clause, or an empty list if there are none
    88      */
    89     List<? extends TypeMirror> getThrownTypes();
    91     /**
    92      * Returns the default value if this executable is an annotation
    93      * type element.  Returns {@code null} if this method is not an
    94      * annotation type element, or if it is an annotation type element
    95      * with no default value.
    96      *
    97      * @return the default value, or {@code null} if none
    98      */
    99     AnnotationValue getDefaultValue();
   100 }

mercurial