class/System/System.Configuration/SettingsBase.cs

   1 //
   2 // System.Web.UI.WebControls.SettingsBase.cs
   3 //
   4 // Authors:
   5 //      Chris Toshok (toshok@ximian.com)
   6 //
   7 // (C) 2005 Novell, Inc (http://www.novell.com)
   8 //
   9 // Permission is hereby granted, free of charge, to any person obtaining
  10 // a copy of this software and associated documentation files (the
  11 // "Software"), to deal in the Software without restriction, including
  12 // without limitation the rights to use, copy, modify, merge, publish,
  13 // distribute, sublicense, and/or sell copies of the Software, and to
  14 // permit persons to whom the Software is furnished to do so, subject to
  15 // the following conditions:
  16 //
  17 // The above copyright notice and this permission notice shall be
  18 // included in all copies or substantial portions of the Software.
  19 //
  20 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  21 // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  22 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  23 // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  24 // LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  25 // OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  26 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  27 //
  28
  29 #if NET_2_0
  30 using System;
  31 using System.Collections;
  32 using System.ComponentModel;
  33
  34 namespace System.Configuration
  35 {
  36
  37         public abstract class SettingsBase
  38         {
  39                 protected SettingsBase ()
  40                 {
  41                 }
  42
  43                 public void Initialize (SettingsContext context,
  44                                         SettingsPropertyCollection properties,
  45                                         SettingsProviderCollection providers)
  46                 {
  47                         this.context = context;
  48                         this.properties = properties;
  49                         this.providers = providers;
  50                         // values do not seem to be reset here!! (otherwise one of the SettingsBaseTest will fail)
  51                 }
  52
  53                 public virtual void Save ()
  54                 {
  55                         if (sync)
  56                                 lock (this)
  57                                         SaveCore ();
  58                         else
  59                                 SaveCore ();
  60                 }
  61
  62                 void SaveCore ()
  63                 {
  64                         //
  65                         // Copied from ApplicationSettingsBase
  66                         //
  67 #if (CONFIGURATION_DEP)
  68                         /* ew.. this needs to be more efficient */
  69                         foreach (SettingsProvider provider in Providers) {
  70                                 SettingsPropertyValueCollection cache = new SettingsPropertyValueCollection ();
  71
  72                                 foreach (SettingsPropertyValue val in PropertyValues) {
  73                                         if (val.Property.Provider == provider)
  74                                                 cache.Add (val);
  75                                 }
  76
  77                                 if (cache.Count > 0)
  78                                         provider.SetPropertyValues (Context, cache);
  79                         }
  80 #endif
  81                 }
  82
  83                 public static SettingsBase Synchronized (SettingsBase settingsBase)
  84                 {
  85                         settingsBase.sync = true;
  86                         return settingsBase;
  87                 }
  88
  89                 public virtual SettingsContext Context {
  90                         get { return context; }
  91                 }
  92
  93                 [Browsable (false)]
  94                 public bool IsSynchronized {
  95                         get { return sync; }
  96                 }
  97
  98                 public virtual object this [ string propertyName ] {
  99                         get
 100                         {
 101                                 if (sync)
 102                                         lock (this) {
 103                                                 return GetPropertyValue (propertyName);
 104                                         }
 105                                 else
 106                                         return GetPropertyValue (propertyName);
 107                         }
 108                         set
 109                         {
 110                                 if (sync)
 111                                         lock (this) {
 112                                                 SetPropertyValue (propertyName, value);
 113                                         }
 114                                 else
 115                                         SetPropertyValue (propertyName, value);
 116                         }
 117                 }
 118
 119                 public virtual SettingsPropertyCollection Properties {
 120                         get {
 121                                 // It seems that Properties.IsSynchronized is
 122                                 // nothing to do with this.IsSynchronized.
 123                                 return properties;
 124                         }
 125                 }
 126
 127                 public virtual SettingsPropertyValueCollection PropertyValues {
 128                         get {
 129                                 if (sync) {
 130                                         lock (this) {
 131                                                 return values;
 132                                         }
 133                                 } else {
 134                                         return values;
 135                                 }
 136                         }
 137                 }
 138
 139                 public virtual SettingsProviderCollection Providers {
 140                         get {
 141                                 return providers;
 142                         }
 143                 }
 144
 145                 object GetPropertyValue (string propertyName)
 146                 {
 147                         SettingsProperty prop = null;
 148                         if (Properties == null || (prop = Properties [propertyName]) == null)
 149                                 throw new SettingsPropertyNotFoundException (
 150                                         string.Format ("The settings property '{0}' was not found", propertyName));
 151
 152                         if (values [propertyName] == null)
 153                                 foreach (SettingsPropertyValue v in prop.Provider.GetPropertyValues (Context, Properties))
 154                                         values.Add (v);
 155
 156                         return PropertyValues [propertyName].PropertyValue;
 157                 }
 158
 159                 void SetPropertyValue (string propertyName, object value)
 160                 {
 161                         SettingsProperty prop = null;
 162                         if (Properties == null || (prop = Properties [propertyName]) == null)
 163                                 throw new SettingsPropertyNotFoundException (
 164                                         string.Format ("The settings property '{0}' was not found", propertyName));
 165
 166                         if (prop.IsReadOnly)
 167                                 throw new SettingsPropertyIsReadOnlyException (
 168                                         string.Format ("The settings property '{0}' is read only", propertyName));
 169
 170                         if (prop.PropertyType != value.GetType ())
 171                                 throw new SettingsPropertyWrongTypeException (
 172                                         string.Format ("The value supplied is of a type incompatible with the settings property '{0}'", propertyName));
 173
 174                         PropertyValues [propertyName].PropertyValue = value;
 175                 }
 176
 177                 bool sync;
 178                 SettingsContext context;
 179                 SettingsPropertyCollection properties;
 180                 SettingsProviderCollection providers;
 181                 SettingsPropertyValueCollection values = new SettingsPropertyValueCollection ();
 182         }
 183 }
 184
 185 #endif