mcs/class/corlib/System.Collections/CollectionBase.cs

   1 //
   2 // System.Collections.CollectionBase.cs
   3 //
   4 // Author:
   5 //   Nick Drochak II (ndrochak@gol.com)
   6 //
   7 // (C) 2001 Nick Drochak II
   8 //
   9
  10 //
  11 // Copyright (C) 2004 Novell, Inc (http://www.novell.com)
  12 //
  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:
  20 //
  21 // The above copyright notice and this permission notice shall be
  22 // included in all copies or substantial portions of the Software.
  23 //
  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.
  31 //
  32
  33 using System;
  34 using System.Runtime.InteropServices;
  35
  36 namespace System.Collections {
  37
  38 #if NET_2_0
  39         [ComVisible(true)]
  40 #endif
  41         [Serializable]
  42 #if INSIDE_CORLIB
  43         public
  44 #else
  45         internal
  46 #endif
  47         abstract class CollectionBase : IList, ICollection, IEnumerable {
  48
  49                 // private instance properties
  50                 private ArrayList list;
  51
  52                 // public instance properties
  53                 public int Count { get { return InnerList.Count; } }
  54
  55                 // Public Instance Methods
  56                 public IEnumerator GetEnumerator() { return InnerList.GetEnumerator(); }
  57                 public void Clear() {
  58                         OnClear();
  59                         InnerList.Clear();
  60                         OnClearComplete();
  61                 }
  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);
  69                 }
  70
  71                 // Protected Instance Constructors
  72                 protected CollectionBase()
  73                 {
  74                 }
  75
  76 #if NET_2_0
  77                 protected CollectionBase (int capacity)
  78                 {
  79                         list = new ArrayList (capacity);
  80                 }
  81
  82                 [ComVisible (false)]
  83                 public int Capacity {
  84                         get {
  85                                 if (list == null)
  86                                         list = new ArrayList ();
  87
  88                                 return list.Capacity;
  89                         }
  90
  91                         set {
  92                                 if (list == null)
  93                                         list = new ArrayList ();
  94
  95                                 list.Capacity = value;
  96                         }
  97                 }
  98
  99 #endif
 100
 101                 // Protected Instance Properties
 102                 protected ArrayList InnerList {
 103                         get {
 104                                 if (list == null)
 105                                         list = new ArrayList ();
 106                                 return list;
 107                         }
 108                 }
 109
 110                 protected IList List {get { return this; } }
 111
 112                 // Protected Instance Methods
 113                 protected virtual void OnClear() { }
 114                 protected virtual void OnClearComplete() { }
 115
 116                 protected virtual void OnInsert(int index, object value) { }
 117                 protected virtual void OnInsertComplete(int index, object value) { }
 118
 119                 protected virtual void OnRemove(int index, object value) { }
 120                 protected virtual void OnRemoveComplete(int index, object value) { }
 121
 122                 protected virtual void OnSet(int index, object oldValue, object newValue) { }
 123                 protected virtual void OnSetComplete(int index, object oldValue, object newValue) { }
 124
 125                 protected virtual void OnValidate(object value) {
 126                         if (null == value) {
 127                                 throw new System.ArgumentNullException("CollectionBase.OnValidate: Invalid parameter value passed to method: null");
 128                         }
 129                 }
 130
 131                 // ICollection methods
 132                 void ICollection.CopyTo(Array array, int index) {
 133                         InnerList.CopyTo(array, index);
 134                 }
 135                 object ICollection.SyncRoot {
 136                         get { return InnerList.SyncRoot; }
 137                 }
 138                 bool ICollection.IsSynchronized {
 139                         get { return InnerList.IsSynchronized; }
 140                 }
 141
 142                 // IList methods
 143                 int IList.Add (object value) {
 144                         int newPosition;
 145                         OnValidate(value);
 146                         newPosition = InnerList.Count;
 147                         OnInsert(newPosition, value);
 148                         InnerList.Add(value);
 149                         try {
 150                                 OnInsertComplete(newPosition, value);
 151                         } catch {
 152                                 InnerList.RemoveAt (newPosition);
 153                                 throw;
 154                         }
 155
 156                         return newPosition;
 157                 }
 158
 159                 bool IList.Contains (object value) {
 160                         return InnerList.Contains(value);
 161                 }
 162
 163                 int IList.IndexOf (object value) {
 164                         return InnerList.IndexOf(value);
 165                 }
 166
 167                 void IList.Insert (int index, object value) {
 168                         OnValidate(value);
 169                         OnInsert(index, value);
 170                         InnerList.Insert(index, value);
 171                         try {
 172                                 OnInsertComplete(index, value);
 173                         } catch {
 174                                 InnerList.RemoveAt (index);
 175                                 throw;
 176                         }
 177                 }
 178
 179                 void IList.Remove (object value) {
 180                         int removeIndex;
 181                         OnValidate(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);
 188                 }
 189
 190                 // IList properties
 191                 bool IList.IsFixedSize {
 192                         get { return InnerList.IsFixedSize; }
 193                 }
 194
 195                 bool IList.IsReadOnly {
 196                         get { return InnerList.IsReadOnly; }
 197                 }
 198
 199                 object IList.this[int index] {
 200                         get { return InnerList[index]; }
 201                         set {
 202                                 if (index < 0 || index >= InnerList.Count)
 203                                         throw new ArgumentOutOfRangeException ("index");
 204
 205                                 object oldValue;
 206                                 // make sure we have been given a valid value
 207                                 OnValidate(value);
 208                                 // save a reference to the object that is in the list now
 209                                 oldValue = InnerList[index];
 210
 211                                 OnSet(index, oldValue, value);
 212                                 InnerList[index] = value;
 213                                 try {
 214                                         OnSetComplete(index, oldValue, value);
 215                                 } catch {
 216                                         InnerList[index] = oldValue;
 217                                         throw;
 218                                 }
 219                         }
 220                 }
 221         }
 222 }