Interface ResultProvider

public interface ResultProvider

This interface marks a ToolAgent as provider of a result during invoke.

$Revision: 2933 $
Michael Lipp
See Also:

Nested Class Summary
static class ResultProvider.ExceptionResult
          A special kind of result that may be returned by result.
Method Summary
 java.lang.Object result()
          Return the result evaluated during invoke.

Method Detail


public java.lang.Object result()
Return the result evaluated during invoke. The method will only be called once after each invoke, i.e. the attribute holding the result may be cleared in this method to allow early garbage collection.

Note that since a tool agent implementation must be thread safe, the result evaluated during invoke must be kept in a ThreadLocal attribute.

the result data as a Map of formal parameter names and values or null if the invocation does not return any data. As special case, an instance of ExceptionResult may be returned if the activity is to be abandoned.