org.jets3t.service.multi.event

Class DownloadObjectsEvent

java.lang.Object

org.jets3t.service.multi.event.ServiceEvent

org.jets3t.service.multi.event.DownloadObjectsEvent

public final class DownloadObjectsEvent
extends ServiceEvent

Multi-threaded service event fired by ThreadedStorageService.downloadObjects(String, org.jets3t.service.multi.DownloadPackage[]).

EVENT_IN_PROGRESS events include an array of the StorageObjects that have finished downloading since the last progress event was fired. These objects are available via getDownloadedObjects().

EVENT_CANCELLED events include an array of the StorageObjects that were not downloaded before the operation was cancelled. These objects are available via getCancelledObjects().

Field Summary

Fields inherited from class org.jets3t.service.multi.event.ServiceEvent

EVENT_CANCELLED, EVENT_COMPLETED, EVENT_ERROR, EVENT_IGNORED_ERRORS, EVENT_IN_PROGRESS, EVENT_STARTED

Method Summary

Modifier and Type	Method and Description
StorageObject[]	getCancelledObjects()
StorageObject[]	getDownloadedObjects()
static DownloadObjectsEvent	newCancelledEvent(StorageObject[] incompletedObjects, java.lang.Object uniqueOperationId)
static DownloadObjectsEvent	newCompletedEvent(java.lang.Object uniqueOperationId)
static DownloadObjectsEvent	newErrorEvent(java.lang.Throwable t, java.lang.Object uniqueOperationId)
static DownloadObjectsEvent	newIgnoredErrorsEvent(ThreadWatcher threadWatcher, java.lang.Throwable[] ignoredErrors, java.lang.Object uniqueOperationId)
static DownloadObjectsEvent	newInProgressEvent(ThreadWatcher threadWatcher, StorageObject[] completedObjects, java.lang.Object uniqueOperationId)
static DownloadObjectsEvent	newStartedEvent(ThreadWatcher threadWatcher, java.lang.Object uniqueOperationId)

Methods inherited from class org.jets3t.service.multi.event.ServiceEvent

getErrorCause, getEventCode, getIgnoredErrors, getThreadWatcher, getUniqueOperationId, setErrorCause, setIgnoredErrors, setThreadWatcher, toString

Methods inherited from class java.lang.Object

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

Method Detail

newErrorEvent

public static DownloadObjectsEvent newErrorEvent(java.lang.Throwable t,
                                                 java.lang.Object uniqueOperationId)

newStartedEvent

public static DownloadObjectsEvent newStartedEvent(ThreadWatcher threadWatcher,
                                                   java.lang.Object uniqueOperationId)

newInProgressEvent

public static DownloadObjectsEvent newInProgressEvent(ThreadWatcher threadWatcher,
                                                      StorageObject[] completedObjects,
                                                      java.lang.Object uniqueOperationId)

newCompletedEvent

public static DownloadObjectsEvent newCompletedEvent(java.lang.Object uniqueOperationId)

newCancelledEvent

public static DownloadObjectsEvent newCancelledEvent(StorageObject[] incompletedObjects,
                                                     java.lang.Object uniqueOperationId)

newIgnoredErrorsEvent

public static DownloadObjectsEvent newIgnoredErrorsEvent(ThreadWatcher threadWatcher,
                                                         java.lang.Throwable[] ignoredErrors,
                                                         java.lang.Object uniqueOperationId)

getDownloadedObjects

public StorageObject[] getDownloadedObjects()
                                     throws java.lang.IllegalStateException

Returns:

the StorageObjects that have finished downloading since the last progress event was fired.

Throws:

java.lang.IllegalStateException - downloaded objects are only available from EVENT_IN_PROGRESS events.

getCancelledObjects

public StorageObject[] getCancelledObjects()
                                    throws java.lang.IllegalStateException

Returns:

the StorageObjects that were not downloaded before the operation was cancelled.

Throws:

java.lang.IllegalStateException - cancelled objects are only available from EVENT_CANCELLED events.