Package com.luciad.lucy.util

Class TLcyUserCancelledException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

com.luciad.lucy.util.TLcyUserCancelledException

All Implemented Interfaces:

Serializable

public final class TLcyUserCancelledException
extends RuntimeException

An exception to indicate that an operation which needs to return something has been cancelled by the user.

A possible example use-case of this exception is loading data, and showing progress to the user. If the progress dialog contains a cancel button as well, this exception can be thrown when the user presses the cancel button.
In this example, it would be the responsibility of the data loading code to catch this exception and handle it. Typically, this means ignoring the exception or logging a statement that the operation has been cancelled by the user.

Since:

2017.0

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
TLcyUserCancelledException(String aMessage)	Creates a new TLcyUserCancelledException

Method Summary

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

TLcyUserCancelledException

public TLcyUserCancelledException(String aMessage)

Creates a new TLcyUserCancelledException

Parameters:

aMessage - The detail message. The detail message is saved for later retrieval by the Throwable.getMessage() method.