org.jets3t.service

Class StorageObjectsChunk

java.lang.Object

org.jets3t.service.StorageObjectsChunk

Direct Known Subclasses:

S3ObjectsChunk

public class StorageObjectsChunk
extends java.lang.Object

Stores a "chunk" of StorageObjects returned from a list command - this particular chunk may or may not include all the objects available in a bucket. This class contains an array of objects and a the last key name returned by a prior call to the method StorageService.listObjectsChunked(String, String, String, long, String).

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String[]	commonPrefixes
protected java.lang.String	delimiter
protected StorageObject[]	objects
protected java.lang.String	prefix
protected java.lang.String	priorLastKey

Constructor Summary

Constructors

Constructor and Description
StorageObjectsChunk(java.lang.String prefix, java.lang.String delimiter, StorageObject[] objects, java.lang.String[] commonPrefixes, java.lang.String priorLastKey)

Method Summary

Modifier and Type	Method and Description
java.lang.String[]	getCommonPrefixes()
java.lang.String	getDelimiter()
StorageObject[]	getObjects()
java.lang.String	getPrefix()
java.lang.String	getPriorLastKey()
boolean	isListingComplete() A convenience method to check whether a listing of objects is complete (true) or there are more objects available (false).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

prefix

protected java.lang.String prefix

delimiter

protected java.lang.String delimiter

objects

protected StorageObject[] objects

commonPrefixes

protected java.lang.String[] commonPrefixes

priorLastKey

protected java.lang.String priorLastKey

Constructor Detail

StorageObjectsChunk

public StorageObjectsChunk(java.lang.String prefix,
                           java.lang.String delimiter,
                           StorageObject[] objects,
                           java.lang.String[] commonPrefixes,
                           java.lang.String priorLastKey)

Method Detail

getObjects

public StorageObject[] getObjects()

Returns:

the objects in this chunk.

getCommonPrefixes

public java.lang.String[] getCommonPrefixes()

Returns:

the common prefixes in this chunk.

getPriorLastKey

public java.lang.String getPriorLastKey()

Returns:

the last key returned by the previous chunk if that chunk was incomplete, null otherwise.

getPrefix

public java.lang.String getPrefix()

Returns:

the prefix applied when this object chunk was generated. If no prefix was applied, this method will return null.

getDelimiter

public java.lang.String getDelimiter()

Returns:

the delimiter applied when this object chunk was generated. If no delimiter was applied, this method will return null.

isListingComplete

public boolean isListingComplete()

A convenience method to check whether a listing of objects is complete (true) or there are more objects available (false). Just a synonym for getPriorLastKey() == null.

Returns:

true if the listing is complete and there are no more unlisted objects, false if follow-up requests will return more objects.