com.codemesh.terp.eval.executors
Class Importer

java.lang.Object
  com.codemesh.terp.api.Executor.AbstractExecutor<java.lang.Object>
      com.codemesh.terp.eval.executors.Importer

All Implemented Interfaces:

Executor<java.lang.Object>

public class Importer
extends Executor.AbstractExecutor<java.lang.Object>

The executor for the import command. The importer normally assumes that it will be operating in expansion mode, i.e. the contents of the referenced source are expanded and appended to the context buffer. You can pass an optional second argument of false to switch the importer into SCRIPT mode. In that case, it will evaluate the referenced source as terp SCRIPT and return the evaluated object. An optional third argument allows you to pass in a map of name/value pairs that are then put into a local scope that is popped off the stack after execution.

Nested Class Summary

Nested classes/interfaces inherited from interface com.codemesh.terp.api.Executor

Executor.AbstractExecutor<T>, Executor.ForMethod

Constructor Summary

Importer()

Method Summary

java.lang.Object	execute(java.util.List<java.lang.Object> args, TerpEvaluator eval, TerpContext ctx) Performs the executor's action on the given arguments in the given context.
boolean	matches(java.util.List<java.lang.Object> args) Returns true if the executor applies to the given arguments.

Methods inherited from class com.codemesh.terp.api.Executor.AbstractExecutor

execute

Methods inherited from class java.lang.Object

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

Constructor Detail

Importer

public Importer()

Method Detail

matches

public boolean matches(java.util.List<java.lang.Object> args)

Description copied from interface: Executor

Returns true if the executor applies to the given arguments. Typically, your custom executor will implement this method to check for the proper number of arguments and the proper argument types.

Parameters:

args - the arguments passed to the executor.

Returns:

true if the executor knows how to handle the given arguments, false otherwise.

execute

public java.lang.Object execute(java.util.List<java.lang.Object> args,
                                TerpEvaluator eval,
                                TerpContext ctx)

Description copied from interface: Executor

Performs the executor's action on the given arguments in the given context. Typically, your custom executor will implement this method to provide its core functionality.

Parameters:

args - the arguments.

eval - the evaluator to use. Can frequently be null.

ctx - the context in which the execution occurs. Can frequently be null.

Returns:

the execution result.