jess
Class Help

java.lang.Object
  jess.Help

All Implemented Interfaces:

java.io.Serializable, Userfunction

public class Help

extends java.lang.Object

implements Userfunction, java.io.Serializable

Help implements the "help" function in Jess. You can use the static method getHelpFor(String) to get help information about various Jess functions and constructs.

(C) 2006 Sandia National Laboratories

See Also:

Serialized Form

Constructor Summary

Help()

Method Summary

Value	call(ValueVector vv, Context context) Call this function with the given argument list.
static java.lang.String	getHelpFor(java.lang.String target)
java.lang.String	getName() Return the name of this function.

Methods inherited from class java.lang.Object

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

Constructor Detail

Help

public Help()

Method Detail

getName

public java.lang.String getName()

Description copied from interface: Userfunction

Return the name of this function. Called once when the function is installed into a Rete engine.

Specified by:

getName in interface Userfunction

Returns:

The name of this function, as seen by the Jess language

call

public Value call(ValueVector vv,
                  Context context)
           throws JessException

Description copied from interface: Userfunction

Call this function with the given argument list. The arguments will be unresolved - do not pass them to other functions or return them as a result without calling resolveValue() on them!

Specified by:

call in interface Userfunction

Parameters:

vv - The argument list. The function name will be the 0th element.

context - The execution context for resolving arguments.

Returns:

The result of executing this function.

Throws:

JessException - If anything goes wrong.

See Also:

Value.resolveValue(jess.Context)

getHelpFor

public static java.lang.String getHelpFor(java.lang.String target)
                                   throws JessException

Throws:

JessException