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

Tue, 09 Oct 2012 19:10:00 -0700

author
jjg
date
Tue, 09 Oct 2012 19:10:00 -0700
changeset 1357
c75be5bc5283
parent 554
9d9f26857129
child 1590
011cf7e0a148
permissions
-rw-r--r--

8000663: clean up langtools imports
Reviewed-by: darcy

duke@1 1 /*
jjg@1357 2 * Copyright (c) 2006, 2012, Oracle and/or its affiliates. All rights reserved.
duke@1 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
duke@1 4 *
duke@1 5 * This code is free software; you can redistribute it and/or modify it
duke@1 6 * under the terms of the GNU General Public License version 2 only, as
ohair@554 7 * published by the Free Software Foundation. Oracle designates this
duke@1 8 * particular file as subject to the "Classpath" exception as provided
ohair@554 9 * by Oracle in the LICENSE file that accompanied this code.
duke@1 10 *
duke@1 11 * This code is distributed in the hope that it will be useful, but WITHOUT
duke@1 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
duke@1 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
duke@1 14 * version 2 for more details (a copy is included in the LICENSE file that
duke@1 15 * accompanied this code).
duke@1 16 *
duke@1 17 * You should have received a copy of the GNU General Public License version
duke@1 18 * 2 along with this work; if not, write to the Free Software Foundation,
duke@1 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
duke@1 20 *
ohair@554 21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
ohair@554 22 * or visit www.oracle.com if you need additional information or have any
ohair@554 23 * questions.
duke@1 24 */
duke@1 25
duke@1 26 package com.sun.source.tree;
duke@1 27
duke@1 28 import javax.lang.model.element.Element;
duke@1 29 import javax.lang.model.element.ExecutableElement;
duke@1 30 import javax.lang.model.element.TypeElement;
duke@1 31
duke@1 32 /**
duke@1 33 * Interface for determining locally available program elements, such as
duke@1 34 * local variables and imports.
duke@1 35 * Upon creation, a Scope is associated with a given program position;
duke@1 36 * for example, a {@linkplain Tree tree node}. This position may be used to
duke@1 37 * infer an enclosing method and/or class.
duke@1 38 *
duke@1 39 * <p>A Scope does not itself contain the details of the elements corresponding
duke@1 40 * to the parameters, methods and fields of the methods and classes containing
duke@1 41 * its position. However, these elements can be determined from the enclosing
duke@1 42 * elements.
duke@1 43 *
duke@1 44 * <p>Scopes may be contained in an enclosing scope. The outermost scope contains
duke@1 45 * those elements available via "star import" declarations; the scope within that
duke@1 46 * contains the top level elements of the compilation unit, including any named
duke@1 47 * imports.
duke@1 48 *
duke@1 49 * @since 1.6
duke@1 50 */
duke@1 51 public interface Scope {
duke@1 52 /**
duke@1 53 * Returns the enclosing scope.
duke@1 54 */
duke@1 55 public Scope getEnclosingScope();
duke@1 56
duke@1 57 /**
duke@1 58 * Returns the innermost type element containing the position of this scope
duke@1 59 */
duke@1 60 public TypeElement getEnclosingClass();
duke@1 61
duke@1 62 /**
duke@1 63 * Returns the innermost executable element containing the position of this scope.
duke@1 64 */
duke@1 65 public ExecutableElement getEnclosingMethod();
duke@1 66
duke@1 67 /**
duke@1 68 * Returns the elements directly contained in this scope.
duke@1 69 */
duke@1 70 public Iterable<? extends Element> getLocalElements();
duke@1 71 }

mercurial