aoqi@0: /*
aoqi@0:  * Copyright (c) 2006, 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 com.sun.source.tree;
aoqi@0: 
aoqi@0: import javax.lang.model.element.Element;
aoqi@0: import javax.lang.model.element.ExecutableElement;
aoqi@0: import javax.lang.model.element.TypeElement;
aoqi@0: 
aoqi@0: /**
aoqi@0:  * Interface for determining locally available program elements, such as
aoqi@0:  * local variables and imports.
aoqi@0:  * Upon creation, a Scope is associated with a given program position;
aoqi@0:  * for example, a {@linkplain Tree tree node}. This position may be used to
aoqi@0:  * infer an enclosing method and/or class.
aoqi@0:  *
aoqi@0:  * <p>A Scope does not itself contain the details of the elements corresponding
aoqi@0:  * to the parameters, methods and fields of the methods and classes containing
aoqi@0:  * its position. However, these elements can be determined from the enclosing
aoqi@0:  * elements.
aoqi@0:  *
aoqi@0:  * <p>Scopes may be contained in an enclosing scope. The outermost scope contains
aoqi@0:  * those elements available via "star import" declarations; the scope within that
aoqi@0:  * contains the top level elements of the compilation unit, including any named
aoqi@0:  * imports.
aoqi@0:  *
aoqi@0:  * @since 1.6
aoqi@0:  */
aoqi@0: @jdk.Exported
aoqi@0: public interface Scope {
aoqi@0:     /**
aoqi@0:      * Returns the enclosing scope.
aoqi@0:      */
aoqi@0:     public Scope getEnclosingScope();
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Returns the innermost type element containing the position of this scope
aoqi@0:      */
aoqi@0:     public TypeElement getEnclosingClass();
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Returns the innermost executable element containing the position of this scope.
aoqi@0:      */
aoqi@0:     public ExecutableElement getEnclosingMethod();
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Returns the elements directly contained in this scope.
aoqi@0:      */
aoqi@0:     public Iterable<? extends Element> getLocalElements();
aoqi@0: }