org.jets3t.service.multithread

Class ListObjectsEvent

java.lang.Object

org.jets3t.service.multi.event.ServiceEvent

org.jets3t.service.multithread.ServiceEvent

org.jets3t.service.multithread.ListObjectsEvent

public class ListObjectsEvent
extends ServiceEvent

Multi-threaded service event fired by S3ServiceMulti.listObjects(String, String[], String, long).

EVENT_IN_PROGRESS events include a List of S3ObjectsChunk objects that contain information about the objects and common-prefixes for the bucket listing operation. Each chunk object will contain a prefix identifying the prefix value used by the listing operation that produced the chunk. These objects are available via getChunkList().

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.List	chunkList

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

EVENT_CANCELLED, EVENT_COMPLETED, EVENT_ERROR, EVENT_IGNORED_ERRORS, EVENT_IN_PROGRESS, EVENT_STARTED

Constructor Summary

Constructors

Modifier	Constructor and Description
private	ListObjectsEvent(int eventCode, java.lang.Object uniqueOperationId)

Method Summary

Modifier and Type	Method and Description
java.util.List	getChunkList()
static ListObjectsEvent	newCancelledEvent(java.lang.Object uniqueOperationId)
static ListObjectsEvent	newCompletedEvent(java.lang.Object uniqueOperationId)
static ListObjectsEvent	newErrorEvent(java.lang.Throwable t, java.lang.Object uniqueOperationId)
static ListObjectsEvent	newIgnoredErrorsEvent(ThreadWatcher threadWatcher, java.lang.Throwable[] ignoredErrors, java.lang.Object uniqueOperationId)
static ListObjectsEvent	newInProgressEvent(ThreadWatcher threadWatcher, java.util.List chunkList, java.lang.Object uniqueOperationId)
static ListObjectsEvent	newStartedEvent(ThreadWatcher threadWatcher, java.lang.Object uniqueOperationId)
private void	setChunkList(java.util.List chunkList)

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

Field Detail

chunkList

private java.util.List chunkList

Constructor Detail

ListObjectsEvent

private ListObjectsEvent(int eventCode,
                         java.lang.Object uniqueOperationId)

Method Detail

newErrorEvent

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

newStartedEvent

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

newInProgressEvent

public static ListObjectsEvent newInProgressEvent(ThreadWatcher threadWatcher,
                                                  java.util.List chunkList,
                                                  java.lang.Object uniqueOperationId)

newCompletedEvent

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

newCancelledEvent

public static ListObjectsEvent newCancelledEvent(java.lang.Object uniqueOperationId)

newIgnoredErrorsEvent

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

setChunkList

private void setChunkList(java.util.List chunkList)

getChunkList

public java.util.List getChunkList()
                            throws java.lang.IllegalStateException

Returns:

a list of the S3ObjectsChunks that have been generated since the last progress event was fired.

Throws:

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