org.trimou.engine.context

Interface ExecutionContext

@Internal
public interface ExecutionContext

A new execution context is created for each template rendering. Execution context is not considered to be thread-safe.

Author:

Martin Kouba

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ExecutionContext.TargetStack

Method Summary

Modifier and Type	Method and Description
void	addDefiningSection(String name, ExtendSectionSegment segment) Associate the specified defining section with the context, but only if no defining section with the same name is associated.
void	clearDefiningSections() Remove all defining sections.
ExtendSectionSegment	getDefiningSection(String name)
ValueWrapper	getValue(String key)
Object	peek(ExecutionContext.TargetStack stack) Returns the object at the top of the context stack.
Object	pop(ExecutionContext.TargetStack stack) Remove the object at the top of the specified stack.
void	push(ExecutionContext.TargetStack stack, Object object) Push the object on the specified stack.

Method Detail

getValue

ValueWrapper getValue(String key)

Parameters:

key -

Returns:

the wrapper for the given key

push

void push(ExecutionContext.TargetStack stack,
          Object object)

Push the object on the specified stack.

Parameters:

object -

pop

Object pop(ExecutionContext.TargetStack stack)

Remove the object at the top of the specified stack.

Returns:

the removed object

peek

Object peek(ExecutionContext.TargetStack stack)

Returns the object at the top of the context stack.

Parameters:

stack -

Returns:

the object at the top of the context stack

addDefiningSection

void addDefiningSection(String name,
                        ExtendSectionSegment segment)

Associate the specified defining section with the context, but only if no defining section with the same name is associated.

Parameters:

name -

segment -

See Also:

ExtendSegment

getDefiningSection

ExtendSectionSegment getDefiningSection(String name)

Parameters:

name -

Returns:

the defining section with the specified name or null if no such associated with the context

See Also:

ExtendSegment

clearDefiningSections

void clearDefiningSections()

Remove all defining sections. This method should be always called after an extend segment is executed.