edu.mit.ai.psg.jeva
Interface IEnv

All Known Implementing Classes:

EnvBase, EnvLocalStore, EnvEnd

public interface IEnv

IEnv: Interface to objects in which names can be looked up. Environments are implemented as a chain, so each can pass the request on to the next if the queryName is not found.

Inner Class Summary

static class

IEnv.ClassResult class used for multiple value return.

Method Summary

IEnv	getNext() get next env in chain; used by lookup methods
int	getOptionBits() get option bits; for options, see JevaES
IEnv.ClassResult	lookupClass(String queryName) find root class with this name; nested classes found from parent.
IClass	lookupEnclosingClass() return enclosing class, or null if not in a class.
IPackage	lookupEnclosingPackage() return enclosing package
IField	lookupField(String queryName) lookup field name in current class, or return null if no such field, or no current class.
IStatementNode	lookupLabel(String queryName, boolean isForContinue) if label found, return node of statement it labels; stops at method or initializer boundary.
IStore	lookupLocal(String queryName) lookup restricted to local variables and parameters, e.g., to check if a local variable name is already in use.
IPackage	lookupPackage(String rootPackageName) find root package with this name; sub-packages found from parent
IClass	lookupReturnType() return type of enclosing method, or void.class (wrapped) if in a constructor, or null if in a static or object initializer
Object	lookupThis() return "this", or null if not in non-static context (method, constructor, non-static initializer)
IClass[]	lookupThrows() find checked exceptions caught in an enclosing try block or declared in throws clause of enclosing method or constructor

Method Detail

lookupLocal

public IStore lookupLocal(String queryName)

lookup restricted to local variables and parameters, e.g., to check if a local variable name is already in use. Local scope may be a method, constructor, field initializer, static initializer, object initializer. [JavaLangSpec1.0sec14.3.2]

lookupField

public IField lookupField(String queryName)
                   throws IllegalAccessException,
                          IllegalArgumentException

lookup field name in current class, or return null if no such field, or no current class.

Throws:

IllegalAccessException - if there is a field with that name but it is inaccessible from the current class

IllegalArgumentException - if different fields with that name are inherited from an interface and either a superclass or another interface. (Fields are different if they are declared in different classes or interfaces.)

lookupLabel

public IStatementNode lookupLabel(String queryName,
                                  boolean isForContinue)

if label found, return node of statement it labels; stops at method or initializer boundary. If label is empty (""), then returns first for, do, while, or switch statement. If isForContinue, then skip unlabeled switch statements.

lookupClass

public IEnv.ClassResult lookupClass(String queryName)
                             throws IllegalArgumentException,
                                    IllegalStateException

find root class with this name; nested classes found from parent. Returns IEnv.ClassResult if found, else null;

Throws:

IllegalArgumentException - if two on-demand-imports import different classes named queryName.

IllegalStateException - if env has conflicting definitions or class imports for queryName.

lookupPackage

public IPackage lookupPackage(String rootPackageName)

find root package with this name; sub-packages found from parent

lookupReturnType

public IClass lookupReturnType()

return type of enclosing method, or void.class (wrapped) if in a constructor, or null if in a static or object initializer

lookupThrows

public IClass[] lookupThrows()

find checked exceptions caught in an enclosing try block or declared in throws clause of enclosing method or constructor

lookupThis

public Object lookupThis()

return "this", or null if not in non-static context (method, constructor, non-static initializer)

lookupEnclosingClass

public IClass lookupEnclosingClass()

return enclosing class, or null if not in a class.

lookupEnclosingPackage

public IPackage lookupEnclosingPackage()

return enclosing package

getOptionBits

public int getOptionBits()

get option bits; for options, see JevaES

getNext

public IEnv getNext()

get next env in chain; used by lookup methods