TerminationCommand (future API)

java.lang.Object

jadex.future.TerminationCommand

All Implemented Interfaces:: ITerminationCommand

public abstract class TerminationCommand extends Object implements ITerminationCommand

Base implementation of termination command to be used for sub-classing.

Constructor Summary

Constructors

Constructor

Description

TerminationCommand()
Method Summary

Modifier and Type

Method

Description

boolean

checkTermination(Exception reason)

Check if termination is allowed.

abstract void

terminated(Exception reason)

Called after termination was performed.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details
- TerminationCommand
  
  public TerminationCommand()
Method Details
- checkTermination
  
  public boolean checkTermination(Exception reason)
  
  Check if termination is allowed. Called before termination is performed. Note that due to race conditions, the future may already be finished when this method executes. If false is returned, the termination request is ignored.
  
  Specified by:
  
  checkTermination in interface ITerminationCommand
  
  Parameters:
  
  reason - The reason supplied for termination.
  
  Returns:
  
  True, if termination should proceed.
- terminated
  
  public abstract void terminated(Exception reason)
  
  Called after termination was performed. Guaranteed to be called only once for each future and only if the termination finished the future (i.e. is not called when the future was already finished).
  
  Specified by:
  
  terminated in interface ITerminationCommand
  
  Parameters:
  
  reason - The reason supplied for termination.