net.noderunner.amazon.s3
Class ListResponse

java.lang.Object
  net.noderunner.amazon.s3.Response
      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

java.util.List<ListResponse.CommonPrefixEntry>	getCommonPrefixEntries() A List of CommonPrefixEntry objects representing the common prefixes of the keys that matched up to the delimiter.
java.lang.String	getDelimiter() Returns delimiter.
java.util.List<Entry>	getEntries() A List of ListEntry objects representing the objects in the given bucket.
boolean	getIsTruncated() The delimiter echoed back from the request.
java.lang.String	getMarker() The marker echoed back from the request.
int	getMaxKeys() The maxKeys echoed back from the request if specified.
java.lang.String	getName() The name of the bucket being listed.
java.lang.String	getNextMarker() Indicates what to use as a marker for subsequent list requests in the event that the results are truncated.
java.lang.String	getPrefix() The prefix echoed back from the request.
boolean	isTruncated() Indicates if there are more results to the list.
java.lang.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 java.util.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 java.lang.String getDelimiter()

Returns delimiter.

getEntries

public java.util.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 java.lang.String getName()

The name of the bucket being listed. Null if request fails.

getPrefix

public java.lang.String getPrefix()

The prefix echoed back from the request. Null if request fails.

getMarker

public java.lang.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 java.lang.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 java.lang.String toString()

Description copied from class: Response

Returns a string representation.

Overrides:

toString in class Response