Scope.java revision 2571:10fc81ac75b4 
1/*
2 * Copyright (c) 2006, 2014, 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 */
25
26package com.sun.source.tree;
27
28import javax.lang.model.element.Element;
29import javax.lang.model.element.ExecutableElement;
30import javax.lang.model.element.TypeElement;
31
32/**
33 * Interface for determining locally available program elements, such as
34 * local variables and imports.
35 * Upon creation, a Scope is associated with a given program position;
36 * for example, a {@linkplain Tree tree node}. This position may be used to
37 * infer an enclosing method and/or class.
38 *
39 * <p>A Scope does not itself contain the details of the elements corresponding
40 * to the parameters, methods and fields of the methods and classes containing
41 * its position. However, these elements can be determined from the enclosing
42 * elements.
43 *
44 * <p>Scopes may be contained in an enclosing scope. The outermost scope contains
45 * those elements available via "star import" declarations; the scope within that
46 * contains the top level elements of the compilation unit, including any named
47 * imports.
48 *
49 * @since 1.6
50 */
51@jdk.Exported
52public interface Scope {
53    /**
54     * Returns the enclosing scope.
55     * @return the enclosing scope
56     */
57    public Scope getEnclosingScope();
58
59    /**
60     * Returns the innermost type element containing the position of this scope.
61     * @return the innermost enclosing type element
62     */
63    public TypeElement getEnclosingClass();
64
65    /**
66     * Returns the innermost executable element containing the position of this scope.
67     * @return the innermost enclosing method declaration
68     */
69    public ExecutableElement getEnclosingMethod();
70
71    /**
72     * Returns the elements directly contained in this scope.
73     * @return the elements contained in this scope
74     */
75    public Iterable<? extends Element> getLocalElements();
76}
77