Package org.jets3t.service.multi.event
Class DownloadObjectsEvent
- java.lang.Object
-
- org.jets3t.service.multi.event.ServiceEvent
-
- org.jets3t.service.multi.event.DownloadObjectsEvent
-
public class DownloadObjectsEvent extends ServiceEvent
Multi-threaded service event fired byThreadedStorageService.downloadObjects(String, org.jets3t.service.multi.DownloadPackage[])
.EVENT_IN_PROGRESS events include an array of the
StorageObject
s that have finished downloading since the last progress event was fired. These objects are available viagetDownloadedObjects()
.EVENT_CANCELLED events include an array of the
StorageObject
s that were not downloaded before the operation was cancelled. These objects are available viagetCancelledObjects()
.- Author:
- James Murty
-
-
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
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description StorageObject[]
getCancelledObjects()
StorageObject[]
getDownloadedObjects()
static DownloadObjectsEvent
newCancelledEvent(StorageObject[] incompletedObjects, Object uniqueOperationId)
static DownloadObjectsEvent
newCompletedEvent(Object uniqueOperationId)
static DownloadObjectsEvent
newErrorEvent(Throwable t, Object uniqueOperationId)
static DownloadObjectsEvent
newIgnoredErrorsEvent(ThreadWatcher threadWatcher, Throwable[] ignoredErrors, Object uniqueOperationId)
static DownloadObjectsEvent
newInProgressEvent(ThreadWatcher threadWatcher, StorageObject[] completedObjects, Object uniqueOperationId)
static DownloadObjectsEvent
newStartedEvent(ThreadWatcher threadWatcher, Object uniqueOperationId)
-
Methods inherited from class org.jets3t.service.multi.event.ServiceEvent
getErrorCause, getEventCode, getIgnoredErrors, getThreadWatcher, getUniqueOperationId, toString
-
-
-
-
Method Detail
-
newErrorEvent
public static DownloadObjectsEvent newErrorEvent(Throwable t, Object uniqueOperationId)
-
newStartedEvent
public static DownloadObjectsEvent newStartedEvent(ThreadWatcher threadWatcher, Object uniqueOperationId)
-
newInProgressEvent
public static DownloadObjectsEvent newInProgressEvent(ThreadWatcher threadWatcher, StorageObject[] completedObjects, Object uniqueOperationId)
-
newCompletedEvent
public static DownloadObjectsEvent newCompletedEvent(Object uniqueOperationId)
-
newCancelledEvent
public static DownloadObjectsEvent newCancelledEvent(StorageObject[] incompletedObjects, Object uniqueOperationId)
-
newIgnoredErrorsEvent
public static DownloadObjectsEvent newIgnoredErrorsEvent(ThreadWatcher threadWatcher, Throwable[] ignoredErrors, Object uniqueOperationId)
-
getDownloadedObjects
public StorageObject[] getDownloadedObjects() throws IllegalStateException
- Returns:
- the
StorageObject
s that have finished downloading since the last progress event was fired. - Throws:
IllegalStateException
- downloaded objects are only available from EVENT_IN_PROGRESS events.
-
getCancelledObjects
public StorageObject[] getCancelledObjects() throws IllegalStateException
- Returns:
- the
StorageObject
s that were not downloaded before the operation was cancelled. - Throws:
IllegalStateException
- cancelled objects are only available from EVENT_CANCELLED events.
-
-