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 {
42 public abstract class CollectionBase : IList, ICollection, IEnumerable {
44 // private instance properties
45 private ArrayList list;
47 // public instance properties
48 public int Count { get { return InnerList.Count; } }
50 // Public Instance Methods
51 public IEnumerator GetEnumerator() { return InnerList.GetEnumerator(); }
57 public void RemoveAt (int index) {
58 object objectToRemove;
59 objectToRemove = InnerList[index];
60 OnValidate(objectToRemove);
61 OnRemove(index, objectToRemove);
62 InnerList.RemoveAt(index);
63 OnRemoveComplete(index, objectToRemove);
66 // Protected Instance Constructors
67 protected CollectionBase()
72 protected CollectionBase (int capacity)
74 list = new ArrayList (capacity);
80 list = new ArrayList ();
87 list = new ArrayList ();
89 list.Capacity = value;
95 // Protected Instance Properties
96 protected ArrayList InnerList {
99 list = new ArrayList ();
104 protected IList List {get { return this; } }
106 // Protected Instance Methods
107 protected virtual void OnClear() { }
108 protected virtual void OnClearComplete() { }
110 protected virtual void OnInsert(int index, object value) { }
111 protected virtual void OnInsertComplete(int index, object value) { }
113 protected virtual void OnRemove(int index, object value) { }
114 protected virtual void OnRemoveComplete(int index, object value) { }
116 protected virtual void OnSet(int index, object oldValue, object newValue) { }
117 protected virtual void OnSetComplete(int index, object oldValue, object newValue) { }
119 protected virtual void OnValidate(object value) {
121 throw new System.ArgumentNullException("CollectionBase.OnValidate: Invalid parameter value passed to method: null");
125 // ICollection methods
126 void ICollection.CopyTo(Array array, int index) {
127 InnerList.CopyTo(array, index);
129 object ICollection.SyncRoot {
130 get { return InnerList.SyncRoot; }
132 bool ICollection.IsSynchronized {
133 get { return InnerList.IsSynchronized; }
137 int IList.Add (object value) {
140 newPosition = InnerList.Count;
141 OnInsert(newPosition, value);
142 InnerList.Add(value);
144 OnInsertComplete(newPosition, value);
146 InnerList.RemoveAt (newPosition);
153 bool IList.Contains (object value) {
154 return InnerList.Contains(value);
157 int IList.IndexOf (object value) {
158 return InnerList.IndexOf(value);
161 void IList.Insert (int index, object value) {
163 OnInsert(index, value);
164 InnerList.Insert(index, value);
166 OnInsertComplete(index, value);
168 InnerList.RemoveAt (index);
173 void IList.Remove (object value) {
176 removeIndex = InnerList.IndexOf(value);
177 if (removeIndex == -1)
178 throw new ArgumentException ("The element cannot be found.", "value");
179 OnRemove(removeIndex, value);
180 InnerList.Remove(value);
181 OnRemoveComplete(removeIndex, value);
185 bool IList.IsFixedSize {
186 get { return InnerList.IsFixedSize; }
189 bool IList.IsReadOnly {
190 get { return InnerList.IsReadOnly; }
193 object IList.this[int index] {
194 get { return InnerList[index]; }
196 if (index < 0 || index >= InnerList.Count)
197 throw new ArgumentOutOfRangeException ("index");
200 // make sure we have been given a valid value
202 // save a reference to the object that is in the list now
203 oldValue = InnerList[index];
205 OnSet(index, oldValue, value);
206 InnerList[index] = value;
208 OnSetComplete(index, oldValue, value);
210 InnerList[index] = oldValue;