org.jets3t.service.multithread

Class DeleteObjectsEvent

java.lang.Object

org.jets3t.service.multi.event.ServiceEvent

org.jets3t.service.multithread.ServiceEvent

org.jets3t.service.multithread.DeleteObjectsEvent

public class DeleteObjectsEvent
extends ServiceEvent

Multi-threaded service event fired by S3ServiceMulti.deleteObjects(S3Bucket, S3Object[]).

EVENT_IN_PROGRESS events include an array of the S3Objects that have been deleted since the last progress event was fired. These objects are available via getDeletedObjects().

EVENT_CANCELLED events include an array of the S3Objects that had not been deleted 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
S3Object[]	getCancelledObjects()
S3Object[]	getDeletedObjects()
static DeleteObjectsEvent	newCancelledEvent(S3Object[] remainingObjects, java.lang.Object uniqueOperationId)
static DeleteObjectsEvent	newCompletedEvent(java.lang.Object uniqueOperationId)
static DeleteObjectsEvent	newErrorEvent(java.lang.Throwable t, java.lang.Object uniqueOperationId)
static DeleteObjectsEvent	newIgnoredErrorsEvent(ThreadWatcher threadWatcher, java.lang.Throwable[] ignoredErrors, java.lang.Object uniqueOperationId)
static DeleteObjectsEvent	newInProgressEvent(ThreadWatcher threadWatcher, S3Object[] deletedObjects, java.lang.Object uniqueOperationId)
static DeleteObjectsEvent	newStartedEvent(ThreadWatcher threadWatcher, java.lang.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, 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 DeleteObjectsEvent newErrorEvent(java.lang.Throwable t,
                                               java.lang.Object uniqueOperationId)

newStartedEvent

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

newInProgressEvent

public static DeleteObjectsEvent newInProgressEvent(ThreadWatcher threadWatcher,
                                                    S3Object[] deletedObjects,
                                                    java.lang.Object uniqueOperationId)

newCompletedEvent

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

newCancelledEvent

public static DeleteObjectsEvent newCancelledEvent(S3Object[] remainingObjects,
                                                   java.lang.Object uniqueOperationId)

newIgnoredErrorsEvent

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

getDeletedObjects

public S3Object[] getDeletedObjects()
                             throws java.lang.IllegalStateException

Returns:

the S3Objects that have been deleted since the last progress event was fired.

Throws:

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

getCancelledObjects

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

Returns:

the S3Objects that were not deleted before the operation was cancelled.

Throws:

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