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