com.codemesh.terp.eval.executors
Class HelpExecutor

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

All Implemented Interfaces:

Executor<Rvalue>

public class HelpExecutor
extends Executor.AbstractExecutor<Rvalue>

An executor that displays context-sensitive help.

Nested Class Summary

static class

HelpExecutor.MemberHelp

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

Executor.AbstractExecutor<T>, Executor.ForMethod

Field Summary

static java.lang.String	HTML
static java.lang.String	PLAIN

Constructor Summary

HelpExecutor()

Method Summary

Rvalue	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

Field Detail

PLAIN

public static final java.lang.String PLAIN

See Also:

Constant Field Values

HTML

public static final java.lang.String HTML

See Also:

Constant Field Values

Constructor Detail

HelpExecutor

public HelpExecutor()

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 Rvalue 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.