org.jets3t.service.multi.event
Class GetObjectsEvent

java.lang.Object
  org.jets3t.service.multi.event.ServiceEvent
      org.jets3t.service.multi.event.GetObjectsEvent

public class GetObjectsEvent
extends ServiceEvent

Multi-threaded service event fired by ThreadedStorageService.getObjects(String, String[]).

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

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

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

StorageObject[]	getCancelledObjects()
StorageObject[]	getCompletedObjects()
static GetObjectsEvent	newCancelledEvent(StorageObject[] 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, StorageObject[] completedObjects, Object uniqueOperationId)
static GetObjectsEvent	newStartedEvent(ThreadWatcher threadWatcher, Object uniqueOperationId)

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

getErrorCause, getEventCode, getIgnoredErrors, getThreadWatcher, getUniqueOperationId, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

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,
                                                 StorageObject[] completedObjects,
                                                 Object uniqueOperationId)

newCompletedEvent

public static GetObjectsEvent newCompletedEvent(Object uniqueOperationId)

newCancelledEvent

public static GetObjectsEvent newCancelledEvent(StorageObject[] incompletedObjects,
                                                Object uniqueOperationId)

newIgnoredErrorsEvent

public static GetObjectsEvent newIgnoredErrorsEvent(ThreadWatcher threadWatcher,
                                                    Throwable[] ignoredErrors,
                                                    Object uniqueOperationId)

getCompletedObjects

public StorageObject[] getCompletedObjects()
                                    throws IllegalStateException

Returns:

the StorageObjects 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 StorageObject[] getCancelledObjects()
                                    throws IllegalStateException

Returns:

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

Throws:

IllegalStateException - cancelled objects are only available from EVENT_CANCELLED events.