com.cloudbees.groovy.cps

Interface Env

All Superinterfaces:

Serializable

All Known Implementing Classes:

BlockScopeEnv, CaseEnv, FunctionCallEnv, ProxyEnv, TryBlockEnv

public interface Env
extends Serializable

For variable lookup. This is local variables.

Author:

Kohsuke Kawaguchi

Method Summary

Methods

Modifier and Type	Method and Description
void	buildStackTraceElements(List<StackTraceElement> stack, int depth) Builds the current call stack information for Throwable.getStackTrace().
Object	closureOwner() Closure or 'this' object that surrounds the currently executing code.
void	declareVariable(Class type, String name)
Continuation	getBreakAddress(String label) If we see a break statement, where should we go?
Continuation	getContinueAddress(String label) If we see a continue statement, where should we go?
Continuation	getExceptionHandler(Class<? extends Throwable> type) Finds the exception handler that catches a Throwable instance of this type.
Invoker	getInvoker() Invoker is typically scoped at the whole execution.
Object	getLocalVariable(String name)
Continuation	getReturnAddress() Where should the return statement return to?
void	setLocalVariable(String name, Object value)

Method Detail

declareVariable

void declareVariable(Class type,
                   String name)

getLocalVariable

Object getLocalVariable(String name)

setLocalVariable

void setLocalVariable(String name,
                    Object value)

closureOwner

Object closureOwner()

Closure or 'this' object that surrounds the currently executing code. If a new closure instantiation is encountered, this is th object that becomes the owner of that closure.

getReturnAddress

Continuation getReturnAddress()

Where should the return statement return to?

getBreakAddress

Continuation getBreakAddress(String label)

If we see a break statement, where should we go?

Parameters:

label - Specifies the loop to break from. null for nearest loop.

Returns:

For semantically correct Groovy code, the return value is never null, because not having the matching label is a compile-time error.

getContinueAddress

Continuation getContinueAddress(String label)

If we see a continue statement, where should we go?

Parameters:

label - Specifies the loop to repeat. null for nearest loop.

Returns:

For semantically correct Groovy code, the return value is never null, because not having the matching label is a compile-time error.

getExceptionHandler

Continuation getExceptionHandler(Class<? extends Throwable> type)

Finds the exception handler that catches a Throwable instance of this type.

Returns:

never null. Even if there's no user-specified exception handler, the default 'unhandled exception handler' must be returned.

buildStackTraceElements

void buildStackTraceElements(List<StackTraceElement> stack,
                           int depth)

Builds the current call stack information for Throwable.getStackTrace().

Parameters:

depth - Maximum depth of stack trace to obtain.

getInvoker

Invoker getInvoker()

Invoker is typically scoped at the whole execution.

Returns:

never null