Top Description Fields Constructors Methods
com.sun.tools.javac.api

public Class JavacScope

extends Object
implements Scope
Class Inheritance
All Implemented Interfaces
com.sun.source.tree.Scope
Imports
java.util.function.Predicate, javax.lang.model.element.Element, .ExecutableElement, .TypeElement, com.sun.tools.javac.code.Kinds.Kind, .Scope.CompoundScope, .Symbol, com.sun.tools.javac.comp.AttrContext, .Env, com.sun.tools.javac.util.DefinedBy, .DefinedBy.Api, .Assert
Provides an implementation of Scope.

This is NOT part of any supported API. If you write code that depends on this, you do so at your own risk. This code and its internal interfaces are subject to change or deletion without notice.

Author
Jonathan Gibbons;

Field Summary

Modifier and TypeField and Description
protected final Env<AttrContext>
env

private static final Predicate<Symbol>
VALIDATOR

Constructor Summary

AccessConstructor and Description
private
JavacScope(Env<AttrContext> env)

Method Summary

Modifier and TypeMethod and Description
pack-priv static JavacScope
create(Env<AttrContext> env)

public boolean
equals(Object
the reference object with which to compare.
other)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.
public TypeElement
getEnclosingClass()

Implements com.sun.source.tree.Scope.getEnclosingClass.

Returns the innermost type element containing the position of this scope.
public ExecutableElement
getEnclosingMethod()

Implements com.sun.source.tree.Scope.getEnclosingMethod.

Returns the innermost executable element containing the position of this scope.
public JavacScope
getEnclosingScope()

Implements com.sun.source.tree.Scope.getEnclosingScope.

Returns the enclosing scope.
public Env<AttrContext>
getEnv()

public Iterable<? extends Element>
getLocalElements()

Implements com.sun.source.tree.Scope.getLocalElements.

Returns the elements directly contained in this scope.
public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.
public boolean
isStarImportScope()

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.
Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

envback to summary
protected final Env<AttrContext> env
VALIDATORback to summary
private static final Predicate<Symbol> VALIDATOR

Constructor Detail

JavacScopeback to summary
private JavacScope(Env<AttrContext> env)

Method Detail

createback to summary
pack-priv static JavacScope create(Env<AttrContext> env)
equalsback to summary
public boolean equals(Object other)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
other:Object

the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

getEnclosingClassback to summary
public TypeElement getEnclosingClass()

Implements com.sun.source.tree.Scope.getEnclosingClass.

Doc from com.sun.source.tree.Scope.getEnclosingClass.

Returns the innermost type element containing the position of this scope.

Returns:TypeElement

the innermost enclosing type element

Annotations
@DefinedBy:COMPILER_TREE
getEnclosingMethodback to summary
public ExecutableElement getEnclosingMethod()

Implements com.sun.source.tree.Scope.getEnclosingMethod.

Doc from com.sun.source.tree.Scope.getEnclosingMethod.

Returns the innermost executable element containing the position of this scope.

Returns:ExecutableElement

the innermost enclosing method declaration

Annotations
@DefinedBy:COMPILER_TREE
getEnclosingScopeback to summary
public JavacScope getEnclosingScope()

Implements com.sun.source.tree.Scope.getEnclosingScope.

Doc from com.sun.source.tree.Scope.getEnclosingScope.

Returns the enclosing scope.

Returns:JavacScope

the enclosing scope

Annotations
@DefinedBy:COMPILER_TREE
getEnvback to summary
public Env<AttrContext> getEnv()
getLocalElementsback to summary
public Iterable<? extends Element> getLocalElements()

Implements com.sun.source.tree.Scope.getLocalElements.

Doc from com.sun.source.tree.Scope.getLocalElements.

Returns the elements directly contained in this scope.

Returns:Iterable<? extends Element>

the elements contained in this scope

Annotations
@DefinedBy:COMPILER_TREE
hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Returns:int

a hash code value for this object

isStarImportScopeback to summary
public boolean isStarImportScope()
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object