org.jets3t.service
Class S3ObjectsChunk

java.lang.Object
  extended by org.jets3t.service.S3ObjectsChunk

public class S3ObjectsChunk
extends Object

Stores a "chunk" of S3Objects 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 S3objects and a the last key name returned by a prior call to the method S3Service.listObjectsChunked(String, String, String, long, String).

Author:
James Murty

Constructor Summary
S3ObjectsChunk(String prefix, String delimiter, S3Object[] objects, String[] commonPrefixes, String priorLastKey)
           
 
Method Summary
 String[] getCommonPrefixes()
           
 String getDelimiter()
           
 S3Object[] getObjects()
           
 String getPrefix()
           
 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
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

S3ObjectsChunk

public S3ObjectsChunk(String prefix,
                      String delimiter,
                      S3Object[] objects,
                      String[] commonPrefixes,
                      String priorLastKey)
Method Detail

getObjects

public S3Object[] getObjects()
Returns:
the objects in this chunk.

getCommonPrefixes

public String[] getCommonPrefixes()
Returns:
the common prefixes in this chunk.

getPriorLastKey

public String getPriorLastKey()
Returns:
the last key returned by the previous chunk if that chunk was incomplete, null otherwise.

getPrefix

public String getPrefix()
Returns:
the prefix applied when this object chunk was generated. If no prefix was applied, this method will return null.

getDelimiter

public 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 in S3, false if follow-up requests will return more objects.