Package org.jets3t.service.multithread
Class GetObjectsEvent
- java.lang.Object
-
- org.jets3t.service.multi.event.ServiceEvent
-
- org.jets3t.service.multithread.ServiceEvent
-
- org.jets3t.service.multithread.GetObjectsEvent
-
public class GetObjectsEvent extends ServiceEvent
Multi-threaded service event fired byS3ServiceMulti.getObjects(org.jets3t.service.model.S3Bucket, org.jets3t.service.model.S3Object[])
.EVENT_IN_PROGRESS events include an array of the
S3Object
s that have been retrieved since the last progress event was fired. These objects are available viagetCompletedObjects()
.EVENT_CANCELLED events include an array of the
S3Object
s that had not been retrieved 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 S3Object[]
getCancelledObjects()
S3Object[]
getCompletedObjects()
static GetObjectsEvent
newCancelledEvent(S3Object[] incompletedObjects, Object uniqueOperationId)
static GetObjectsEvent
newCompletedEvent(Object uniqueOperationId)
static GetObjectsEvent
newErrorEvent(Throwable t, Object uniqueOperationId)
static GetObjectsEvent
newIgnoredErrorsEvent(ThreadWatcher threadWatcher, Throwable[] ignoredErrors, Object uniqueOperationId)
static GetObjectsEvent
newInProgressEvent(ThreadWatcher threadWatcher, S3Object[] completedObjects, Object uniqueOperationId)
static GetObjectsEvent
newStartedEvent(ThreadWatcher threadWatcher, Object uniqueOperationId)
-
Methods inherited from class org.jets3t.service.multithread.ServiceEvent
getThreadWatcher
-
Methods inherited from class org.jets3t.service.multi.event.ServiceEvent
getErrorCause, getEventCode, getIgnoredErrors, getUniqueOperationId, toString
-
-
-
-
Method Detail
-
newErrorEvent
public static GetObjectsEvent newErrorEvent(Throwable t, Object uniqueOperationId)
-
newStartedEvent
public static GetObjectsEvent newStartedEvent(ThreadWatcher threadWatcher, Object uniqueOperationId)
-
newInProgressEvent
public static GetObjectsEvent newInProgressEvent(ThreadWatcher threadWatcher, S3Object[] completedObjects, Object uniqueOperationId)
-
newCompletedEvent
public static GetObjectsEvent newCompletedEvent(Object uniqueOperationId)
-
newCancelledEvent
public static GetObjectsEvent newCancelledEvent(S3Object[] incompletedObjects, Object uniqueOperationId)
-
newIgnoredErrorsEvent
public static GetObjectsEvent newIgnoredErrorsEvent(ThreadWatcher threadWatcher, Throwable[] ignoredErrors, Object uniqueOperationId)
-
getCompletedObjects
public S3Object[] getCompletedObjects() throws IllegalStateException
- Returns:
- the S3Objects that have been retrieved since the last progress event was fired.
- Throws:
IllegalStateException
- completed objects are only available from EVENT_IN_PROGRESS events.
-
getCancelledObjects
public S3Object[] getCancelledObjects() throws IllegalStateException
- Returns:
- the S3Objects that were not retrieved before the operation was cancelled.
- Throws:
IllegalStateException
- cancelled objects are only available from EVENT_CANCELLED events.
-
-