de.cau.cs.kieler.sim.kiem
Class KiemExecutionException

java.lang.Object
  extended by java.lang.Throwable
      extended by java.lang.Exception
          extended by de.cau.cs.kieler.sim.kiem.KiemExecutionException

public class KiemExecutionException
extends Exception

The Class KiemExecutionException. This exception is used by DataComponents to flag errors within their step() method during the execution. If the mustStop flag is set to true, then this means the execution *MUST* stop, and will be immediately stopped by the execution manager. Note that the execution manager tries to stop all threads but cannot guarantee that they really terminate (e.g., when a deadlock occurred). In the latter case there will be zombie threads but the execution manager and the eclipse instance is not affected as long as the left memory is still enough.

Rating yellow
(2009-01-15)

Constructor Summary
KiemExecutionException(String message, boolean mustStopParam, boolean mustPauseParam, boolean silentParam, Exception causeParam)
          Instantiates a new KiemExecutionException.
KiemExecutionException(String message, boolean mustStopParam, Exception causeParam)
          Instantiates a new KiemExecutionException.
 
Method Summary
 Exception getCause()
          Gets the cause of this Exception.
 boolean isMustPause()
          Checks if the execution must pause when this Exception occurs.
 boolean isMustStop()
          Checks if the execution must stop when this Exception occurs.
 boolean isSilent()
          Checks if KIEM should omit an error or warning message dialog when this Exception occurs.
 
Methods inherited from class java.lang.Throwable
getMessage, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

KiemExecutionException

public KiemExecutionException(String message,
                              boolean mustStopParam,
                              boolean mustPauseParam,
                              boolean silentParam,
                              Exception causeParam)
Instantiates a new KiemExecutionException.

Parameters:
message - the message of this Exception to display to the user
mustStopParam - the must stop flag indicating if the execution must stop
causeParam - the cause of this Exception if any, or null otherwise
mustPauseParam - the must pause flag indicating if the execution must pause
silentParam - the silent param flags that KIEM omits any message dialog

KiemExecutionException

public KiemExecutionException(String message,
                              boolean mustStopParam,
                              Exception causeParam)
Instantiates a new KiemExecutionException.

Parameters:
message - the message of this Exception to display to the user
mustStopParam - the must stop flag indicating if the execution must stop
causeParam - the cause of this Exception if any, or null otherwise
Method Detail

isMustStop

public boolean isMustStop()
Checks if the execution must stop when this Exception occurs.

Returns:
true, if execution must stop

getCause

public Exception getCause()
Gets the cause of this Exception.

Returns:
the cause of this Exception, if any

isMustPause

public boolean isMustPause()
Checks if the execution must pause when this Exception occurs.

Returns:
true, if execution must stop

isSilent

public boolean isSilent()
Checks if KIEM should omit an error or warning message dialog when this Exception occurs.

Returns:
true, if KIEM should omit any message dialog