-
Notifications
You must be signed in to change notification settings - Fork 126
/
IMutableArray.cs
377 lines (332 loc) · 14.2 KB
/
IMutableArray.cs
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
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
//
// IMutableArray.cs
//
// Copyright (c) 2017 Couchbase, Inc 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.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License 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.
//
using System;
using System.Collections;
using JetBrains.Annotations;
namespace Couchbase.Lite
{
/// <summary>
/// An interface representing a writable collection of objects
/// </summary>
public interface IMutableArray : IArray, IMutableArrayFragment
{
#region Properties
/// <summary>
/// Gets the value of the given index, or lack thereof,
/// wrapped inside of a <see cref="IMutableFragment"/>
/// </summary>
/// <param name="index">The index to check</param>
/// <returns>The value of the given index, or lack thereof</returns>
[NotNull]
new IMutableFragment this[int index] { get; }
#endregion
#region Public Methods
/// <summary>
/// Adds an entry to this collection
/// </summary>
/// <param name="value">The value to add</param>
/// <returns>The array for further processing</returns>
[NotNull]
IMutableArray AddValue(object value);
/// <summary>
/// Adds an entry to this collection
/// </summary>
/// <param name="value">The value to add</param>
/// <returns>The array for further processing</returns>
[NotNull]
IMutableArray AddString(string value);
/// <summary>
/// Adds an entry to this collection
/// </summary>
/// <param name="value">The value to add</param>
/// <returns>The array for further processing</returns>
[NotNull]
IMutableArray AddInt(int value);
/// <summary>
/// Adds an entry to this collection
/// </summary>
/// <param name="value">The value to add</param>
/// <returns>The array for further processing</returns>
[NotNull]
IMutableArray AddLong(long value);
/// <summary>
/// Adds an entry to this collection
/// </summary>
/// <param name="value">The value to add</param>
/// <returns>The array for further processing</returns>
[NotNull]
IMutableArray AddFloat(float value);
/// <summary>
/// Adds an entry to this collection
/// </summary>
/// <param name="value">The value to add</param>
/// <returns>The array for further processing</returns>
[NotNull]
IMutableArray AddDouble(double value);
/// <summary>
/// Adds an entry to this collection
/// </summary>
/// <param name="value">The value to add</param>
/// <returns>The array for further processing</returns>
[NotNull]
IMutableArray AddBoolean(bool value);
/// <summary>
/// Adds an entry to this collection
/// </summary>
/// <param name="value">The value to add</param>
/// <returns>The array for further processing</returns>
[NotNull]
IMutableArray AddBlob(Blob value);
/// <summary>
/// Adds an entry to this collection
/// </summary>
/// <param name="value">The value to add</param>
/// <returns>The array for further processing</returns>
[NotNull]
IMutableArray AddDate(DateTimeOffset value);
/// <summary>
/// Adds an entry to this collection
/// </summary>
/// <param name="value">The value to add</param>
/// <returns>The array for further processing</returns>
[NotNull]
IMutableArray AddArray(ArrayObject value);
/// <summary>
/// Adds an entry to this collection
/// </summary>
/// <param name="value">The value to add</param>
/// <returns>The array for further processing</returns>
[NotNull]
IMutableArray AddDictionary(DictionaryObject value);
/// <summary>
/// Gets the value at the given index as an array
/// </summary>
/// <param name="index">The index to lookup</param>
/// <returns>The value at the index, or <c>null</c></returns>
[CanBeNull]
new MutableArrayObject GetArray(int index);
/// <summary>
/// Gets the value at the given index as a dictionary
/// </summary>
/// <param name="index">The index to lookup</param>
/// <returns>The value at the index, or <c>null</c></returns>
[CanBeNull]
new MutableDictionaryObject GetDictionary(int index);
/// <summary>
/// Inserts a given value at the given index
/// </summary>
/// <param name="index">The index to insert the item at</param>
/// <param name="value">The item to insert</param>
/// <returns>The array for further processing</returns>
[NotNull]
IMutableArray InsertValue(int index, object value);
/// <summary>
/// Inserts a given value at the given index
/// </summary>
/// <param name="index">The index to insert the item at</param>
/// <param name="value">The item to insert</param>
/// <returns>The array for further processing</returns>
[NotNull]
IMutableArray InsertString(int index, string value);
/// <summary>
/// Inserts a given value at the given index
/// </summary>
/// <param name="index">The index to insert the item at</param>
/// <param name="value">The item to insert</param>
/// <returns>The array for further processing</returns>
[NotNull]
IMutableArray InsertInt(int index, int value);
/// <summary>
/// Inserts a given value at the given index
/// </summary>
/// <param name="index">The index to insert the item at</param>
/// <param name="value">The item to insert</param>
/// <returns>The array for further processing</returns>
[NotNull]
IMutableArray InsertLong(int index, long value);
/// <summary>
/// Inserts a given value at the given index
/// </summary>
/// <param name="index">The index to insert the item at</param>
/// <param name="value">The item to insert</param>
/// <returns>The array for further processing</returns>
[NotNull]
IMutableArray InsertFloat(int index, float value);
/// <summary>
/// Inserts a given value at the given index
/// </summary>
/// <param name="index">The index to insert the item at</param>
/// <param name="value">The item to insert</param>
/// <returns>The array for further processing</returns>
[NotNull]
IMutableArray InsertDouble(int index, double value);
/// <summary>
/// Inserts a given value at the given index
/// </summary>
/// <param name="index">The index to insert the item at</param>
/// <param name="value">The item to insert</param>
/// <returns>The array for further processing</returns>
[NotNull]
IMutableArray InsertBoolean(int index, bool value);
/// <summary>
/// Inserts a given value at the given index
/// </summary>
/// <param name="index">The index to insert the item at</param>
/// <param name="value">The item to insert</param>
/// <returns>The array for further processing</returns>
[NotNull]
IMutableArray InsertBlob(int index, Blob value);
/// <summary>
/// Inserts a given value at the given index
/// </summary>
/// <param name="index">The index to insert the item at</param>
/// <param name="value">The item to insert</param>
/// <returns>The array for further processing</returns>
[NotNull]
IMutableArray InsertDate(int index, DateTimeOffset value);
/// <summary>
/// Inserts a given value at the given index
/// </summary>
/// <param name="index">The index to insert the item at</param>
/// <param name="value">The item to insert</param>
/// <returns>The array for further processing</returns>
[NotNull]
IMutableArray InsertArray(int index, ArrayObject value);
/// <summary>
/// Inserts a given value at the given index
/// </summary>
/// <param name="index">The index to insert the item at</param>
/// <param name="value">The item to insert</param>
/// <returns>The array for further processing</returns>
[NotNull]
IMutableArray InsertDictionary(int index, DictionaryObject value);
/// <summary>
/// Removes the item at the given index
/// </summary>
/// <param name="index">The index at which to remove the item</param>
/// <returns>The array for further processing</returns>
[NotNull]
IMutableArray RemoveAt(int index);
/// <summary>
/// Replaces the contents of this collection with the contents of the given one
/// </summary>
/// <param name="array">The contents to replace the current contents</param>
/// <returns>The array for further processing</returns>
[NotNull]
IMutableArray SetData(IList array);
/// <summary>
/// Overwrites the value at the given index with the given value
/// </summary>
/// <param name="index">The index to overwrite</param>
/// <param name="value">The value to insert</param>
/// <returns>The array for further processing</returns>
[NotNull]
IMutableArray SetValue(int index, object value);
/// <summary>
/// Overwrites the value at the given index with the given value
/// </summary>
/// <param name="index">The index to overwrite</param>
/// <param name="value">The value to insert</param>
/// <returns>The array for further processing</returns>
[NotNull]
IMutableArray SetString(int index, string value);
/// <summary>
/// Overwrites the value at the given index with the given value
/// </summary>
/// <param name="index">The index to overwrite</param>
/// <param name="value">The value to insert</param>
/// <returns>The array for further processing</returns>
[NotNull]
IMutableArray SetInt(int index, int value);
/// <summary>
/// Overwrites the value at the given index with the given value
/// </summary>
/// <param name="index">The index to overwrite</param>
/// <param name="value">The value to insert</param>
/// <returns>The array for further processing</returns>
[NotNull]
IMutableArray SetLong(int index, long value);
/// <summary>
/// Overwrites the value at the given index with the given value
/// </summary>
/// <param name="index">The index to overwrite</param>
/// <param name="value">The value to insert</param>
/// <returns>The array for further processing</returns>
[NotNull]
IMutableArray SetFloat(int index, float value);
/// <summary>
/// Overwrites the value at the given index with the given value
/// </summary>
/// <param name="index">The index to overwrite</param>
/// <param name="value">The value to insert</param>
/// <returns>The array for further processing</returns>
[NotNull]
IMutableArray SetDouble(int index, double value);
/// <summary>
/// Overwrites the value at the given index with the given value
/// </summary>
/// <param name="index">The index to overwrite</param>
/// <param name="value">The value to insert</param>
/// <returns>The array for further processing</returns>
[NotNull]
IMutableArray SetBoolean(int index, bool value);
/// <summary>
/// Overwrites the value at the given index with the given value
/// </summary>
/// <param name="index">The index to overwrite</param>
/// <param name="value">The value to insert</param>
/// <returns>The array for further processing</returns>
[NotNull]
IMutableArray SetBlob(int index, Blob value);
/// <summary>
/// Overwrites the value at the given index with the given value
/// </summary>
/// <param name="index">The index to overwrite</param>
/// <param name="value">The value to insert</param>
/// <returns>The array for further processing</returns>
[NotNull]
IMutableArray SetDate(int index, DateTimeOffset value);
/// <summary>
/// Overwrites the value at the given index with the given value
/// </summary>
/// <param name="index">The index to overwrite</param>
/// <param name="value">The value to insert</param>
/// <returns>The array for further processing</returns>
[NotNull]
IMutableArray SetArray(int index, ArrayObject value);
/// <summary>
/// Overwrites the value at the given index with the given value
/// </summary>
/// <param name="index">The index to overwrite</param>
/// <param name="value">The value to insert</param>
/// <returns>The array for further processing</returns>
[NotNull]
IMutableArray SetDictionary(int index, DictionaryObject value);
/// <summary>
/// Replaces the contents of this collection with the contents of the
/// given json string
/// </summary>
/// <remarks>
/// json string must be constructed from <see cref="IJSON.ToJSON">ToJSON</see>
/// </remarks>
/// <param name="json">The json string to replace the current contents with</param>
/// <returns>The array for further processing</returns>
IMutableArray SetJSON([NotNull]string json);
#endregion
}
}