de.torstennahm.integrate
Interface StopCondition

All Known Implementing Classes:

StopConditions.MultiStopCondition, StopConditions.UntilAbsTol, StopConditions.UntilCallsReached, StopConditions.UntilRelTol, StopConditions.UntilTimeOut

public interface StopCondition

This inteface provides a mechanism for deciding when integration should stop.

Author:

Torsten Nahm

Method Summary

java.lang.String	getConditionString() Returns a string describing the fulfillment of the condition.
boolean	stop(IntegrationResult result) Returns true if the integration should be stopped because of this condition.

Method Detail

stop

boolean stop(IntegrationResult result)

Returns true if the integration should be stopped because of this condition.

Parameters:

result - integration result

Returns:

true if condition is fulfilled

getConditionString

java.lang.String getConditionString()

Returns a string describing the fulfillment of the condition. For example, if stopping when the error tolerance is below the requirement, the string might be "Error tolerance reached".

Returns:

string describing condition when it is fulfilled