aboutsummaryrefslogtreecommitdiffhomepage
path: root/csharp/src/ProtocolBuffers/Collections/PopsicleList.cs
blob: 3de97f8914b69b77992c457c6e2f85dbcad24073 (plain)
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
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
// Protocol Buffers - Google's data interchange format
// Copyright 2008 Google Inc.  All rights reserved.
// http://github.com/jskeet/dotnet-protobufs/
// Original C++/Java/Python code:
// http://code.google.com/p/protobuf/
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
//     * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//     * Redistributions in binary form must reproduce the above
// copyright notice, this list of conditions and the following disclaimer
// in the documentation and/or other materials provided with the
// distribution.
//     * Neither the name of Google Inc. nor the names of its
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
using System;
using System.Collections;
using System.Collections.Generic;

namespace Google.ProtocolBuffers.Collections
{
    /// <summary>
    /// Proxies calls to a <see cref="List{T}" />, but allows the list
    /// to be made read-only (with the <see cref="MakeReadOnly" /> method), 
    /// after which any modifying methods throw <see cref="NotSupportedException" />.
    /// </summary>
    public sealed class PopsicleList<T> : IPopsicleList<T>, ICastArray
    {
        private static readonly bool CheckForNull = default(T) == null;
        private static readonly T[] EmptySet = new T[0];

        private List<T> items;
        private bool readOnly;

        /// <summary>
        /// Makes this list read-only ("freezes the popsicle"). From this
        /// point on, mutating methods (Clear, Add etc) will throw a
        /// NotSupportedException. There is no way of "defrosting" the list afterwards.
        /// </summary>
        public void MakeReadOnly()
        {
            readOnly = true;
        }

        public int IndexOf(T item)
        {
            return items == null ? -1 : items.IndexOf(item);
        }

        public void Insert(int index, T item)
        {
            ValidateModification();
            if (CheckForNull)
            {
                ThrowHelper.ThrowIfNull(item);
            }
            items.Insert(index, item);
        }

        public void RemoveAt(int index)
        {
            ValidateModification();
            items.RemoveAt(index);
        }

        public T this[int index]
        {
            get
            {
                if (items == null)
                {
                    throw new ArgumentOutOfRangeException();
                }
                return items[index];
            }
            set
            {
                ValidateModification();
                if (CheckForNull)
                {
                    ThrowHelper.ThrowIfNull(value);
                }
                items[index] = value;
            }
        }

        public void Add(T item)
        {
            ValidateModification();
            if (CheckForNull)
            {
                ThrowHelper.ThrowIfNull(item);
            }
            items.Add(item);
        }

        public void Clear()
        {
            ValidateModification();
            items.Clear();
        }

        public bool Contains(T item)
        {
            return items == null ? false : items.Contains(item);
        }

        public void CopyTo(T[] array, int arrayIndex)
        {
            if (items != null)
            {
                items.CopyTo(array, arrayIndex);
            }
        }

        public int Count
        {
            get { return items == null ? 0 : items.Count; }
        }

        public bool IsReadOnly
        {
            get { return readOnly; }
        }

        public bool Remove(T item)
        {
            ValidateModification();
            return items.Remove(item);
        }

        public IEnumerator<T> GetEnumerator()
        {
            IEnumerable<T> tenum = (IEnumerable<T>)items ?? EmptySet;
            return tenum.GetEnumerator();
        }

        IEnumerator IEnumerable.GetEnumerator()
        {
            return GetEnumerator();
        }

        public void Add(IEnumerable<T> collection)
        {
            ValidateModification();
            ThrowHelper.ThrowIfNull(collection);

            if (!CheckForNull || collection is PopsicleList<T>)
            {
                items.AddRange(collection);
            }
            else
            {
                // Assumption, it's ok to enumerate collections more than once.
                if (collection is ICollection<T>)
                {
                    ThrowHelper.ThrowIfAnyNull(collection);
                    items.AddRange(collection);
                }
                else
                {
                    foreach (T item in collection)
                    {
                        ThrowHelper.ThrowIfNull(item);
                        items.Add(item);
                    }
                }
            }
        }

        private void ValidateModification()
        {
            if (readOnly)
            {
                throw new NotSupportedException("List is read-only");
            }
            if (items == null)
            {
                items = new List<T>();
            }
        }

        IEnumerable<TItemType> ICastArray.CastArray<TItemType>()
        {
            if (items == null)
            {
                return PopsicleList<TItemType>.EmptySet;
            }
            return (TItemType[]) (object) items.ToArray();
        }
    }
}