module AWS::S3::Tree::Parent - RDoc Documentation

Attributes

collection[R]

@return [ObjectCollection, BucketVersionCollection,

MultipartUploadCollection] The collection whose members
will be explored using the tree.

delimiter[R]

When looking at S3 keys as a tree, the delimiter defines what string pattern seperates each level of the tree. The delimiter defaults to ‘/’ (like in a file system).

@return [String]

prefix[R]

A tree may have a prefix of where in the bucket to be based from. A value of nil means that the tree will include all objects in the collection.

@return [String,nil]

Public Class Methods

new(collection, options = {}) click to toggle source

@private

# File lib/aws/s3/tree/parent.rb, line 26
def initialize collection, options = {}

  options = {
    :prefix => nil,
    :delimiter => '/',
    :append => true,
  }.merge(options)

  @collection = collection
  @prefix = options[:prefix]
  @delimiter = options[:delimiter]
  @append = options[:append]

  super

end

Public Instance Methods

append?() click to toggle source

@return [Boolean] Returns true if the tree is set to auto-append

the delimiter to the prefix when the prefix does not end with
the delimiter.

# File lib/aws/s3/tree/parent.rb, line 65
def append?
  @append
end

children() click to toggle source

@return [Tree::ChildCollection] A collection representing all

the child nodes of this node.  These may be either
{Tree::BranchNode} objects or {Tree::LeafNode} objects.

# File lib/aws/s3/tree/parent.rb, line 72
def children
  Tree::ChildCollection.new(self, collection,
                            :delimiter => delimiter,
                            :prefix => prefix,
                            :append => append?)
end

inspect() click to toggle source

# File lib/aws/s3/tree/parent.rb, line 79
def inspect
  "<#{self.class}:#{collection.bucket.name}:#{prefix}>"
end