Package com.xinapse.util

Class CancelledException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.xinapse.util.CancelledException

All Implemented Interfaces:

Serializable

public class CancelledException
extends Exception

Thrown when an action is cancelled by the user.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
CancelledException()	Constructs a CancelledException without a detail message, and without a user object.
CancelledException(String s)	Constructs a CancelledException with the specified detail message.
CancelledException(String s, List<ROI> userObject)	Constructs a CancelledException with the specified detail message, and an associated User Object.

Method Summary

Modifier and Type	Method	Description
List<ROI>	getUserObject()	Retrieves the User Object associated with this CancelledException.

Methods inherited from class java.lang.Throwable

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

Methods inherited from class java.lang.Object

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

Constructor Details

CancelledException

public CancelledException()

Constructs a CancelledException without a detail message, and without a user object.

CancelledException

public CancelledException(String s)

Constructs a CancelledException with the specified detail message. The error message string s can later be retrieved by the Throwable.getMessage() method of class Throwable. There is no user object.

Parameters:

s - the detail message.

CancelledException

public CancelledException(String s,
 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 Throwable.getMessage() method of class Throwable. The User Object can later be retrieved by the getUserObject() method.

Parameters:

s - the detail message.

userObject - the User Object to associate with this CancelledException, which is a List of ROIs.

Method Details

getUserObject

public List<ROI> getUserObject()

Retrieves the User Object associated with this CancelledException.

Returns:

the User Object, which is a List of ROIs.