src/share/classes/com/sun/source/tree/Scope.java

Sat, 01 Dec 2007 00:00:00 +0000

author
duke
date
Sat, 01 Dec 2007 00:00:00 +0000
changeset 1
9a66ca7c79fa
child 554
9d9f26857129
permissions
-rw-r--r--

Initial load

     1 /*
     2  * Copyright 2006 Sun Microsystems, Inc.  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.  Sun designates this
     8  * particular file as subject to the "Classpath" exception as provided
     9  * by Sun 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 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
    22  * CA 95054 USA or visit www.sun.com if you need additional information or
    23  * have any questions.
    24  */
    26 package com.sun.source.tree;
    28 import com.sun.source.tree.Tree;
    29 import javax.lang.model.element.Element;
    30 import javax.lang.model.element.ExecutableElement;
    31 import javax.lang.model.element.TypeElement;
    32 import javax.lang.model.type.DeclaredType;
    34 /**
    35  * Interface for determining locally available program elements, such as
    36  * local variables and imports.
    37  * Upon creation, a Scope is associated with a given program position;
    38  * for example, a {@linkplain Tree tree node}. This position may be used to
    39  * infer an enclosing method and/or class.
    40  *
    41  * <p>A Scope does not itself contain the details of the elements corresponding
    42  * to the parameters, methods and fields of the methods and classes containing
    43  * its position. However, these elements can be determined from the enclosing
    44  * elements.
    45  *
    46  * <p>Scopes may be contained in an enclosing scope. The outermost scope contains
    47  * those elements available via "star import" declarations; the scope within that
    48  * contains the top level elements of the compilation unit, including any named
    49  * imports.
    50  *
    51  * @since 1.6
    52  */
    53 public interface Scope {
    54     /**
    55      * Returns the enclosing scope.
    56      */
    57     public Scope getEnclosingScope();
    59     /**
    60      * Returns the innermost type element containing the position of this scope
    61      */
    62     public TypeElement getEnclosingClass();
    64     /**
    65      * Returns the innermost executable element containing the position of this scope.
    66      */
    67     public ExecutableElement getEnclosingMethod();
    69     /**
    70      * Returns the elements directly contained in this scope.
    71      */
    72     public Iterable<? extends Element> getLocalElements();
    73 }

mercurial