net.noderunner.amazon.s3
Class ListResponse

java.lang.Object
  extended by net.noderunner.amazon.s3.Response
      extended by net.noderunner.amazon.s3.ListResponse

public class ListResponse
extends Response

Returned by Connection.list(net.noderunner.amazon.s3.Bucket, java.lang.String, java.lang.String, java.lang.Integer, net.noderunner.amazon.s3.Headers).


Nested Class Summary
static class ListResponse.CommonPrefixEntry
          Prefix entry.
 
Method Summary
 List<ListResponse.CommonPrefixEntry> getCommonPrefixEntries()
          A List of CommonPrefixEntry objects representing the common prefixes of the keys that matched up to the delimiter.
 String getDelimiter()
          Returns delimiter.
 List<Entry> getEntries()
          A List of ListEntry objects representing the objects in the given bucket.
 boolean getIsTruncated()
          The delimiter echoed back from the request.
 String getMarker()
          The marker echoed back from the request.
 int getMaxKeys()
          The maxKeys echoed back from the request if specified.
 String getName()
          The name of the bucket being listed.
 String getNextMarker()
          Indicates what to use as a marker for subsequent list requests in the event that the results are truncated.
 String getPrefix()
          The prefix echoed back from the request.
 boolean isTruncated()
          Indicates if there are more results to the list.
 String toString()
          Returns a string representation.
 
Methods inherited from class net.noderunner.amazon.s3.Response
assertOk, getContentLength, getHeaderField, getHeaders, getResponseCode, getResponseMessage, isNotFound, isOk, parse
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Method Detail

getCommonPrefixEntries

public List<ListResponse.CommonPrefixEntry> getCommonPrefixEntries()
A List of CommonPrefixEntry objects representing the common prefixes of the keys that matched up to the delimiter. Null if the request fails.


getDelimiter

public String getDelimiter()
Returns delimiter.


getEntries

public List<Entry> getEntries()
A List of ListEntry objects representing the objects in the given bucket.


isTruncated

public boolean isTruncated()
Indicates if there are more results to the list. True if the current list results have been truncated. false if request fails.


getName

public String getName()
The name of the bucket being listed. Null if request fails.


getPrefix

public String getPrefix()
The prefix echoed back from the request. Null if request fails.


getMarker

public String getMarker()
The marker echoed back from the request. Null if request fails.


getMaxKeys

public int getMaxKeys()
The maxKeys echoed back from the request if specified. 0 if request fails.


getIsTruncated

public boolean getIsTruncated()
The delimiter echoed back from the request. Null if not specified in the request, or if it fails.


getNextMarker

public String getNextMarker()
Indicates what to use as a marker for subsequent list requests in the event that the results are truncated. Present only when a delimiter is specified. Null if request fails.


toString

public String toString()
Description copied from class: Response
Returns a string representation.

Overrides:
toString in class Response


Copyright © 2011. All Rights Reserved.