com.xinapse.util
Class CancelledException

java.lang.Object
  java.lang.Throwable
      java.lang.Exception
          com.xinapse.util.CancelledException

All Implemented Interfaces:

java.io.Serializable

public class CancelledException
extends java.lang.Exception

Thrown when an action is cancelled by the user.

See Also:

Serialized Form

Constructor Summary

CancelledException()
Constructs a CancelledException with "cancelled" as its error detail message.

CancelledException(java.lang.String s)
Constructs a CancelledException with the specified detail message.

CancelledException(java.lang.String s, java.util.List<ROI> userObject)
Constructs a CancelledException with the specified detail message, and an associated User Object.

Method Summary

java.util.List<ROI>

getUserObject() Retrieves the User Object associated with this CancelledException.

Methods inherited from class java.lang.Throwable

fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

CancelledException

public CancelledException()

Constructs a CancelledException with "cancelled" as its error detail message.

CancelledException

public CancelledException(java.lang.String s)

Constructs a CancelledException with the specified detail message. The error message string s can later be retrieved by the java.lang.Throwable#getMessage() method of class java.lang.Throwable.

Parameters:

s - the detail message.

CancelledException

public CancelledException(java.lang.String s,
                          java.util.List<ROI> userObject)

Constructs a CancelledException with the specified detail message, and an associated User Object. The error message string s can later be retrieved by the java.lang.Throwable#getMessage() method of class java.lang.Throwable. The User Object can later be retrieved by the CancelledException#getUserObject() method.

Parameters:

s - the detail message.

userObject - the User Object to associate with this CancelledException.

Method Detail

getUserObject

public java.util.List<ROI> getUserObject()

Retrieves the User Object associated with this CancelledException.