com.amazonaws.services.s3.model.transform

Class XmlResponsesSaxParser.ListBucketHandler

java.lang.Object

org.xml.sax.helpers.DefaultHandler

com.amazonaws.services.s3.model.transform.XmlResponsesSaxParser.ListBucketHandler

All Implemented Interfaces:

ContentHandler, DTDHandler, EntityResolver, ErrorHandler

Enclosing class:

XmlResponsesSaxParser

public class XmlResponsesSaxParser.ListBucketHandler
extends org.xml.sax.helpers.DefaultHandler

Handler for ListBucket response XML documents. The document is parsed into S3Objects available via the getObjects() method.

Constructor Summary

Constructors

Constructor and Description
ListBucketHandler()

Method Summary

Modifier and Type	Method and Description
void	characters(char[] ch, int start, int length)
void	endDocument()
void	endElement(String uri, String name, String qName)
String[]	getCommonPrefixes()
String	getMarkerForNextListing() If the listing is truncated this method will return the marker that should be used in subsequent bucket list calls to complete the listing.
String	getNextMarker()
ObjectListing	getObjectListing()
List<S3ObjectSummary>	getObjects()
String	getRequestMarker()
long	getRequestMaxKeys()
String	getRequestPrefix()
boolean	isListingTruncated()
void	startDocument()
void	startElement(String uri, String name, String qName, Attributes attrs)

Methods inherited from class org.xml.sax.helpers.DefaultHandler

endPrefixMapping, error, fatalError, ignorableWhitespace, notationDecl, processingInstruction, resolveEntity, setDocumentLocator, skippedEntity, startPrefixMapping, unparsedEntityDecl, warning

Methods inherited from class java.lang.Object

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

Constructor Detail

ListBucketHandler

public ListBucketHandler()

Method Detail

getObjectListing

public ObjectListing getObjectListing()

getMarkerForNextListing

public String getMarkerForNextListing()

If the listing is truncated this method will return the marker that should be used in subsequent bucket list calls to complete the listing.

Returns:

null if the listing is not truncated, otherwise the next marker if it's available or the last object key seen if the next marker isn't available.

isListingTruncated

public boolean isListingTruncated()

Returns:

true if the listing document was truncated, and therefore only contained a subset of the available S3 objects.

getObjects

public List<S3ObjectSummary> getObjects()

Returns:

the S3 objects contained in the listing.

getCommonPrefixes

public String[] getCommonPrefixes()

getRequestPrefix

public String getRequestPrefix()

getRequestMarker

public String getRequestMarker()

getNextMarker

public String getNextMarker()

getRequestMaxKeys

public long getRequestMaxKeys()

startDocument

public void startDocument()

Specified by:

startDocument in interface ContentHandler

Overrides:

startDocument in class org.xml.sax.helpers.DefaultHandler

endDocument

public void endDocument()

Specified by:

endDocument in interface ContentHandler

Overrides:

endDocument in class org.xml.sax.helpers.DefaultHandler

startElement

public void startElement(String uri,
                         String name,
                         String qName,
                         Attributes attrs)

Specified by:

startElement in interface ContentHandler

Overrides:

startElement in class org.xml.sax.helpers.DefaultHandler

endElement

public void endElement(String uri,
                       String name,
                       String qName)

Specified by:

endElement in interface ContentHandler

Overrides:

endElement in class org.xml.sax.helpers.DefaultHandler

characters

public void characters(char[] ch,
                       int start,
                       int length)

Specified by:

characters in interface ContentHandler

Overrides:

characters in class org.xml.sax.helpers.DefaultHandler