2 // System.Collections.CollectionBase.cs
5 // Nick Drochak II (ndrochak@gol.com)
7 // (C) 2001 Nick Drochak II
11 // Copyright (C) 2004 Novell, Inc (http://www.novell.com)
13 // Permission is hereby granted, free of charge, to any person obtaining
14 // a copy of this software and associated documentation files (the
15 // "Software"), to deal in the Software without restriction, including
16 // without limitation the rights to use, copy, modify, merge, publish,
17 // distribute, sublicense, and/or sell copies of the Software, and to
18 // permit persons to whom the Software is furnished to do so, subject to
19 // the following conditions:
21 // The above copyright notice and this permission notice shall be
22 // included in all copies or substantial portions of the Software.
24 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
25 // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
26 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
27 // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
28 // LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
29 // OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
30 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
34 using System.Runtime.InteropServices;
36 namespace System.Collections {
47 abstract class CollectionBase : IList, ICollection, IEnumerable {
49 // private instance properties
50 private ArrayList list;
52 // public instance properties
53 public int Count { get { return InnerList.Count; } }
55 // Public Instance Methods
56 public IEnumerator GetEnumerator() { return InnerList.GetEnumerator(); }
62 public void RemoveAt (int index) {
63 object objectToRemove;
64 objectToRemove = InnerList[index];
65 OnValidate(objectToRemove);
66 OnRemove(index, objectToRemove);
67 InnerList.RemoveAt(index);
68 OnRemoveComplete(index, objectToRemove);
71 // Protected Instance Constructors
72 protected CollectionBase()
77 protected CollectionBase (int capacity)
79 list = new ArrayList (capacity);
86 list = new ArrayList ();
93 list = new ArrayList ();
95 list.Capacity = value;
101 // Protected Instance Properties
102 protected ArrayList InnerList {
105 list = new ArrayList ();
110 protected IList List {get { return this; } }
112 // Protected Instance Methods
113 protected virtual void OnClear() { }
114 protected virtual void OnClearComplete() { }
116 protected virtual void OnInsert(int index, object value) { }
117 protected virtual void OnInsertComplete(int index, object value) { }
119 protected virtual void OnRemove(int index, object value) { }
120 protected virtual void OnRemoveComplete(int index, object value) { }
122 protected virtual void OnSet(int index, object oldValue, object newValue) { }
123 protected virtual void OnSetComplete(int index, object oldValue, object newValue) { }
125 protected virtual void OnValidate(object value) {
127 throw new System.ArgumentNullException("CollectionBase.OnValidate: Invalid parameter value passed to method: null");
131 // ICollection methods
132 void ICollection.CopyTo(Array array, int index) {
133 InnerList.CopyTo(array, index);
135 object ICollection.SyncRoot {
136 get { return InnerList.SyncRoot; }
138 bool ICollection.IsSynchronized {
139 get { return InnerList.IsSynchronized; }
143 int IList.Add (object value) {
146 newPosition = InnerList.Count;
147 OnInsert(newPosition, value);
148 InnerList.Add(value);
150 OnInsertComplete(newPosition, value);
152 InnerList.RemoveAt (newPosition);
159 bool IList.Contains (object value) {
160 return InnerList.Contains(value);
163 int IList.IndexOf (object value) {
164 return InnerList.IndexOf(value);
167 void IList.Insert (int index, object value) {
169 OnInsert(index, value);
170 InnerList.Insert(index, value);
172 OnInsertComplete(index, value);
174 InnerList.RemoveAt (index);
179 void IList.Remove (object value) {
182 removeIndex = InnerList.IndexOf(value);
183 if (removeIndex == -1)
184 throw new ArgumentException ("The element cannot be found.", "value");
185 OnRemove(removeIndex, value);
186 InnerList.Remove(value);
187 OnRemoveComplete(removeIndex, value);
191 bool IList.IsFixedSize {
192 get { return InnerList.IsFixedSize; }
195 bool IList.IsReadOnly {
196 get { return InnerList.IsReadOnly; }
199 object IList.this[int index] {
200 get { return InnerList[index]; }
202 if (index < 0 || index >= InnerList.Count)
203 throw new ArgumentOutOfRangeException ("index");
206 // make sure we have been given a valid value
208 // save a reference to the object that is in the list now
209 oldValue = InnerList[index];
211 OnSet(index, oldValue, value);
212 InnerList[index] = value;
214 OnSetComplete(index, oldValue, value);
216 InnerList[index] = oldValue;