agi.foundation.compatibility

(agi.foundation.core-2024r2.jar)

Class AsyncCompletedEventArgs

java.lang.Object

agi.foundation.compatibility.EventArgs

agi.foundation.compatibility.AsyncCompletedEventArgs

Direct Known Subclasses:

GlobeImageOverlayAddCompleteEventArgs, RunWorkerCompletedEventArgs, TerrainOverlayAddCompleteEventArgs

public class AsyncCompletedEventArgs
extends EventArgs

Provides data for asynchronous method completion event.

Field Summary

Fields inherited from class agi.foundation.compatibility.EventArgs

Empty

Constructor Summary

Constructors

Constructor and Description
AsyncCompletedEventArgs(RuntimeException error, boolean cancelled, Object userState) Initializes a new instance of the AsyncCompletedEventArgs class.

Method Summary

Modifier and Type	Method and Description
boolean	getCancelled() Gets a value indicating whether an asynchronous operation has been canceled.
RuntimeException	getError() Gets a value indicating which error occurred during an asynchronous operation.
Object	getUserState() Gets the unique identifier for the asynchronous task.
protected void	raiseExceptionIfNecessary()

Methods inherited from class java.lang.Object

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

Constructor Detail

AsyncCompletedEventArgs

public AsyncCompletedEventArgs(RuntimeException error,
                               boolean cancelled,
                               Object userState)

Initializes a new instance of the AsyncCompletedEventArgs class.

Parameters:

error - Any error that occurred during the asynchronous operation.

cancelled - A value indicating whether the asynchronous operation was canceled.

userState - An optional user-supplied state object.

Method Detail

raiseExceptionIfNecessary

protected void raiseExceptionIfNecessary()

getCancelled

public boolean getCancelled()

Gets a value indicating whether an asynchronous operation has been canceled.

Returns:

true if the background operation has been canceled; otherwise false. The default is false.

getError

public RuntimeException getError()

Gets a value indicating which error occurred during an asynchronous operation.

Returns:

An exception instance, if an error occurred during an asynchronous operation; otherwise null.

getUserState

public Object getUserState()

Gets the unique identifier for the asynchronous task.

Returns:

An object reference that uniquely identifies the asynchronous task; otherwise, null if no value has been set.