Package com.sun.tools.javac.comp

Class Env<A>

java.lang.Object

com.sun.tools.javac.comp.Env<A>

All Implemented Interfaces:

Iterable<Env<A>>

Direct Known Subclasses:

AttrContextEnv

public class Env<A>
extends Object
implements Iterable<Env<A>>

A class for environments, instances of which are passed as arguments to tree visitors. Environments refer to important ancestors of the subtree that's currently visited, such as the enclosing method, the enclosing class, or the enclosing toplevel node. They also contain a generic component, represented as a type parameter, to carry further information specific to individual passes.

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.

Field Summary

Fields

Modifier and Type	Field and Description
boolean	baseClause Is this an environment for evaluating a base clause?
JCTree.JCClassDecl	enclClass The next enclosing class definition.
JCTree.JCMethodDecl	enclMethod The next enclosing method definition.
A	info A generic field for further information.
Env<A>	next The next enclosing environment.
Env<A>	outer The environment enclosing the current class.
JCTree.JCCompilationUnit	toplevel The enclosing toplevel tree.
JCTree	tree The tree with which this environment is associated.

Constructor Summary

Constructors

Constructor and Description
Env(JCTree tree, A info) Create an outermost environment for a given (toplevel)tree, with a given info field.

Method Summary

Modifier and Type	Method and Description
Env<A>	dup(JCTree tree) Duplicate this environment, updating with given tree, and copying all other fields.
Env<A>	dup(JCTree tree, A info) Duplicate this environment, updating with given tree and info, and copying all other fields.
Env<A>	dupto(Env<A> that) Duplicate this environment into a given Environment, using its tree and info, and copying all other fields.
Env<A>	enclosing(JCTree.Tag tag) Return closest enclosing environment which points to a tree with given tag.
Iterator<Env<A>>	iterator()
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

next

public Env<A> next

The next enclosing environment.

outer

public Env<A> outer

The environment enclosing the current class.

tree

public JCTree tree

The tree with which this environment is associated.

toplevel

public JCTree.JCCompilationUnit toplevel

The enclosing toplevel tree.

enclClass

public JCTree.JCClassDecl enclClass

The next enclosing class definition.

enclMethod

public JCTree.JCMethodDecl enclMethod

The next enclosing method definition.

info

public A info

A generic field for further information.

baseClause

public boolean baseClause

Is this an environment for evaluating a base clause?

Constructor Detail

Env

public Env(JCTree tree,
           A info)

Create an outermost environment for a given (toplevel)tree, with a given info field.

Method Detail

dup

public Env<A> dup(JCTree tree,
                  A info)

Duplicate this environment, updating with given tree and info, and copying all other fields.

dupto

public Env<A> dupto(Env<A> that)

Duplicate this environment into a given Environment, using its tree and info, and copying all other fields.

dup

public Env<A> dup(JCTree tree)

Duplicate this environment, updating with given tree, and copying all other fields.

enclosing

public Env<A> enclosing(JCTree.Tag tag)

Return closest enclosing environment which points to a tree with given tag.

toString

public String toString()

Overrides:

toString in class Object

iterator

public Iterator<Env<A>> iterator()

Specified by:

iterator in interface Iterable<Env<A>>