1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
|
# Copyright 2011-2013 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.
module AWS
class S3
class Tree
# Common methods for tree nodes that are parents to other nodes
# ({Tree} and {BranchNode}).
module Parent
include Core::Model
# @api private
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
# @return [ObjectCollection, BucketVersionCollection,
# MultipartUploadCollection] The collection whose members
# will be explored using the tree.
attr_reader :collection
# 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]
attr_reader :prefix
# 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]
attr_reader :delimiter
# @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.
def append?
@append
end
# @return [Tree::ChildCollection] A collection representing all
# the child nodes of this node. These may be either
# {Tree::BranchNode} objects or {Tree::LeafNode} objects.
def children
Tree::ChildCollection.new(self, collection,
:delimiter => delimiter,
:prefix => prefix,
:append => append?)
end
def inspect
"<#{self.class}:#{collection.bucket.name}:#{prefix}>"
end
end
end
end
end
|
