Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
  /*
   * Copyright 2010-2015 Amazon.com, Inc. or its affiliates. All Rights Reserved.
   *
   * Licensed under the Apache License, Version 2.0 (the "License").
   * You may not use this file except in compliance with the License.
   * A copy of the License is located at
   * 
   *  http://aws.amazon.com/apache2.0
   * 
  * or in the "license" file accompanying this file. This file is distributed
  * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
  * express or implied. See the License for the specific language governing
  * permissions and limitations under the License.
  */
 package com.amazonaws.services.s3.model;
 
 import java.util.List;
 
Contains the results of listing the objects in an Amazon S3 bucket. This includes a list of S3ObjectSummary objects describing the objects stored in the bucket, a list of common prefixes if a delimiter was specified in the request, information describing if this is a complete or partial listing, and the original request parameters.

 
 public class ObjectListing {
    
    
A list of summary information describing the objects stored in the bucket
 
     private List<S3ObjectSummaryobjectSummaries = new ArrayList<S3ObjectSummary>();

    
A list of the common prefixes included in this object listing - common prefixes will only be populated for requests that specified a delimiter
 
     private List<StringcommonPrefixes = new ArrayList<String>();
    
    
The name of the Amazon S3 bucket containing the listed objects
 
     private String bucketName;

    
The marker to use in order to request the next page of results - only populated if the isTruncated member indicates that this object listing is truncated
 
     private String nextMarker;
    
    
Indicates if this is a complete listing, or if the caller needs to make additional requests to Amazon S3 to see the full object listing for an S3 bucket
 
     private boolean isTruncated;
     
     
     /* Original Request Parameters */

    
The prefix parameter originally specified by the caller when this object listing was returned
 
     private String prefix;
    
    
The marker parameter originally specified by the caller when this object listing was returned
 
     private String marker;
    
    
The maxKeys parameter originally specified by the caller when this object listing was returned
 
     private int maxKeys;
    
    
The delimiter parameter originally specified by the caller when this object listing was returned
 
     private String delimiter;
    
    
The encodingType parameter originally specified by the caller when this object listing was returned.
 
     private String encodingType;


    
Gets the list of object summaries describing the objects stored in the S3 bucket. Listings for large buckets can be truncated for performance reasons. Always check the isTruncated() method to see if the returned listing is complete or if additional calls are needed to get more results. Callers might need to make additional calls to com.amazonaws.services.s3.AmazonS3.listNextBatchOfObjects(com.amazonaws.services.s3.model.ObjectListing) to get additional results.

Returns:
A list of the object summaries describing the objects stored in the S3 bucket.
        return ;
    }

    

Gets the common prefixes included in this object listing. Common prefixes are only present if a delimiter was specified in the original request.

Each common prefix represents a set of keys in the S3 bucket that have been condensed and omitted from the object summary results. This allows applications to organize and browse their keys hierarchically, similar to how a file system organizes files into directories.

For example, consider a bucket that contains the following keys:

  • "foo/bar/baz"
  • "foo/bar/bash"
  • "foo/bar/bang"
  • "foo/boo"
If calling listObjects with the prefix="foo/" and the delimiter="/" on this bucket, the returned S3ObjectListing will contain one entry in the common prefixes list ("foo/bar/") and none of the keys beginning with that common prefix will be included in the object summaries list.

Returns:
The list of common prefixes included in this object listing, which might be an empty list if no common prefixes were found.
    public List<StringgetCommonPrefixes() {
        return ;
    }

    
For internal use only. Sets the common prefixes for this object listing, representing the key prefixes that were rolled up because of the request's delimiter parameter.

Parameters:
commonPrefixes The common prefixes for this object listing.
    public void setCommonPrefixes(List<StringcommonPrefixes) {
        this. = commonPrefixes;
    }

    
Gets the marker to use in the next listObjects request in order to see the next page of results. If an object listing is not truncated, this method will return null. For truncated requests, this value is equal to the greatest lexicographical value of the object keys and common prefixes included in this listing.

Returns:
The marker to use in the next listObjects request in order to see the next page of results if this object listing is truncated. Returns null if this object listing isn't truncated.
    public String getNextMarker() {
        return ;
    }

    
For internal use only. Sets the marker to use in the next list objects request in order to see the next page of results for a truncated object listing.

Parameters:
nextMarker The marker to use in the next listObjects request in order to see the next page of results for a truncated object listing.
    public void setNextMarker(String nextMarker) {
        this. = nextMarker;
    }

    
Gets the name of the Amazon S3 bucket containing the objects listed in this ObjectListing.

Returns:
The name of the Amazon S3 bucket containing the objects listed in this ObjectListing.
    public String getBucketName() {
        return ;
    }

    
For internal use only. Sets the name of the Amazon S3 bucket containing the objects listed in this S3ObjectListing.

Parameters:
bucketName The name of the Amazon S3 bucket containing the objects listed in this S3ObjectListing.
    public void setBucketName(String bucketName) {
        this. = bucketName;
    }

    
Gets the prefix parameter originally used to request this object listing, or null if no prefix was specified. All objects and common prefixes included in this object listing start with the specified prefix.

Returns:
The prefix parameter originally used to request this object listing. Returns null if no prefix was specified.
    public String getPrefix() {
        return ;
    }

    
For internal use only. Sets the prefix parameter originally used to request this object listing.

Parameters:
prefix The prefix parameter originally used to request this object listing.
    public void setPrefix(String prefix) {
        this. = prefix;
    }

    
Gets the marker parameter originally used to request this object listing, or null if no marker was specified. If specified, all objects and common prefixes included in this object listing will occur alphabetically after the specified marker.

Returns:
The marker parameter originally used to request this object listing. Returns null if no marker was specified.
    public String getMarker() {
        return ;
    }

    
For internal use only. Sets the marker parameter originally used to request this object listing.

Parameters:
marker The marker parameter originally used to request this object listing.
    public void setMarker(String marker) {
        this. = marker;
    }

    
Gets the maxKeys parameter originally used to request this object listing, or the default maxKeys value provided by Amazon S3 if the requester didn't specify a value. The maxKeys parameter limits the combined number of objects and common prefixes included in this object listing. An object listing will never contain more objects plus common prefixes than indicated by the maxKeys, but can of course contain less.

Returns:
The maxKeysmaxKeys value applied by Amazon S3 if no value was specified.
    public int getMaxKeys() {
        return ;
    }

    
For internal use only. Sets the maxKeys parameter originally used to request this object listing, or the default maxKeys applied by Amazon S3 if the requester didn't specify a value.

Parameters:
maxKeys The maxKeys parameter originally used to request this object listing, or the default maxKeys value applied by Amazon S3 if the requester didn't specify a value.
    public void setMaxKeys(int maxKeys) {
        this. = maxKeys;
    }

    
Gets the delimiter parameter originally used to request this object listing, or null if no delimiter specified.

The delimiter value allows callers to condense S3 keys into common prefix listings. For example, if a caller specifies a delimiter of "/" (a common used value for delimiter), any keys that contain a common prefix between the start of the key and the first occurrence of "/" will not be included in the list of object summaries. Instead, the common prefixes list will have one entry for the common prefix.

Returns:
The delimiter parameter originally used to request this object listing. Returns null if no delimiter was specified.
    public String getDelimiter() {
        return ;
    }

    
For internal use only. Sets the delimiter parameter originally used to request this object listing.

Parameters:
delimiter The delimiter parameter originally used to request this object listing.
    public void setDelimiter(String delimiter) {
        this. = delimiter;
    }

    
Gets whether or not this object listing is complete.

Returns:
The value true if the object listing is not complete. Returns the value false if otherwise. When returning true, additional calls to Amazon S3 may be needed in order to obtain more results.
    public boolean isTruncated() {
        return ;
    }

    
For internal use only. Sets the truncated property for this object listing, indicating if this is a complete listing or not and whether the caller needs to make additional calls to S3 to get more object summaries.

Parameters:
isTruncated The value true if the object listing is not complete. The value false if otherwise.
    public void setTruncated(boolean isTruncated) {
        this. = isTruncated;
    }

    
Gets the encoding type used by Amazon S3 to encode object key names in the XML response. If you specify encodingType request parameter, Amazon S3 includes this element in the response, and returns encoded key name values in the following response elements: Delimiter, Marker, Prefix, NextMarker, Key.

Returns:
Null if encodingType is not specified in the request parameter.
    public String getEncodingType() {
        return ;
    }

    
For internal use only. Sets the encoding type used by Amazon S3 to encode object key names in the XML response.

Parameters:
encodingType Null if encodingType is not specified in the request parameter.
    public void setEncodingType(String encodingType) {
        this. = encodingType;
    }
New to GrepCode? Check out our FAQ X