Simplified optimized implementation of GetHashCode and ToString for classes that can be frozen.

Author: rstam

Driver/Core/MongoCollectionSettings.cs

@@ -208,8 +208,8 @@ public MongoCollectionSettings Freeze()
             if (!_isFrozen)
             {
                 _safeMode = _safeMode.FrozenCopy();
-                _frozenHashCode = GetHashCodeHelper();
-                _frozenStringRepresentation = ToStringHelper();
+                _frozenHashCode = GetHashCode();
+                _frozenStringRepresentation = ToString();
                 _isFrozen = true;
             }
             return this;
@@ -241,31 +241,7 @@ public override int GetHashCode()
             {
                 return _frozenHashCode;
             }
-            else
-            {
-                return GetHashCodeHelper();
-            }
-        }
-
-        /// <summary>
-        /// Returns a string representation of the settings.
-        /// </summary>
-        /// <returns>A string representation of the settings.</returns>
-        public override string ToString()
-        {
-            if (_isFrozen)
-            {
-                return _frozenStringRepresentation;
-            }
-            else
-            {
-                return ToStringHelper();
-            }
-        }
 
-        // private methods
-        private int GetHashCodeHelper()
-        {
             // see Effective Java by Joshua Bloch
             int hash = 17;
             hash = 37 * hash + ((_collectionName == null) ? 0 : _collectionName.GetHashCode());
@@ -277,8 +253,17 @@ private int GetHashCodeHelper()
             return hash;
         }
 
-        private string ToStringHelper()
+        /// <summary>
+        /// Returns a string representation of the settings.
+        /// </summary>
+        /// <returns>A string representation of the settings.</returns>
+        public override string ToString()
         {
+            if (_isFrozen)
+            {
+                return _frozenStringRepresentation;
+            }
+
             return string.Format(
                 "CollectionName={0};AssignIdOnInsert={1};DefaultDocumentType={2};GuidRepresentation={3};SafeMode={4};SlaveOk={5}",
                 _collectionName, _assignIdOnInsert, _defaultDocumentType, _guidRepresentation, _safeMode, _slaveOk);

Driver/Core/MongoCredentialsStore.cs

@@ -28,6 +28,7 @@ public class MongoCredentialsStore
         // private fields
         private Dictionary<string, MongoCredentials> _credentialsStore = new Dictionary<string,MongoCredentials>();
         private int _frozenHashCode;
+        private string _frozenStringRepresentation;
         private bool _isFrozen;
 
         // constructors
@@ -126,6 +127,7 @@ public MongoCredentialsStore Freeze()
             if (!_isFrozen)
             {
                 _frozenHashCode = GetHashCode();
+                _frozenStringRepresentation = ToString();
                 _isFrozen = true;
             }
             return this;
@@ -160,6 +162,11 @@ public override int GetHashCode()
         /// <returns>A string representation of the credentials store.</returns>
         public override string ToString()
         {
+            if (_isFrozen)
+            {
+                return _frozenStringRepresentation;
+            }
+
             var sb = new StringBuilder();
             sb.Append("{");
             var separator = "";

Driver/Core/MongoDatabaseSettings.cs

@@ -198,8 +198,8 @@ public MongoDatabaseSettings Freeze()
             if (!_isFrozen)
             {
                 _safeMode = _safeMode.FrozenCopy();
-                _frozenHashCode = GetHashCodeHelper();
-                _frozenStringRepresentation = ToStringHelper();
+                _frozenHashCode = GetHashCode();
+                _frozenStringRepresentation = ToString();
                 _isFrozen = true;
             }
             return this;
@@ -231,10 +231,15 @@ public override int GetHashCode()
             {
                 return _frozenHashCode;
             }
-            else
-            {
-                return GetHashCodeHelper();
-            }
+
+            // see Effective Java by Joshua Bloch
+            int hash = 17;
+            hash = 37 * hash + ((_databaseName == null) ? 0 : _databaseName.GetHashCode());
+            hash = 37 * hash + ((_credentials == null) ? 0 : _credentials.GetHashCode());
+            hash = 37 * hash + _guidRepresentation.GetHashCode();
+            hash = 37 * hash + ((_safeMode == null) ? 0 : _safeMode.GetHashCode());
+            hash = 37 * hash + _slaveOk.GetHashCode();
+            return hash;
         }
 
         /// <summary>
@@ -247,27 +252,7 @@ public override string ToString()
             {
                 return _frozenStringRepresentation;
             }
-            else
-            {
-                return ToStringHelper();
-            }
-        }
-
-        // private methods
-        private int GetHashCodeHelper()
-        {
-            // see Effective Java by Joshua Bloch
-            int hash = 17;
-            hash = 37 * hash + ((_databaseName == null) ? 0 : _databaseName.GetHashCode());
-            hash = 37 * hash + ((_credentials == null) ? 0 : _credentials.GetHashCode());
-            hash = 37 * hash + _guidRepresentation.GetHashCode();
-            hash = 37 * hash + ((_safeMode == null) ? 0 : _safeMode.GetHashCode());
-            hash = 37 * hash + _slaveOk.GetHashCode();
-            return hash;
-        }
 
-        private string ToStringHelper()
-        {
             return string.Format(
                 "DatabaseName={0};Credentials={1};GuidRepresentation={2};SafeMode={3};SlaveOk={4}",
                 _databaseName, _credentials, _guidRepresentation, _safeMode, _slaveOk);

Driver/Core/MongoServerSettings.cs

@@ -451,8 +451,8 @@ public MongoServerSettings Freeze()
             {
                 _credentialsStore.Freeze();
                 _safeMode = _safeMode.FrozenCopy();
-                _frozenHashCode = GetHashCodeHelper();
-                _frozenStringRepresentation = ToStringHelper();
+                _frozenHashCode = GetHashCode();
+                _frozenStringRepresentation = ToString();
                 _isFrozen = true;
             }
             return this;
@@ -514,31 +514,7 @@ public override int GetHashCode()
             {
                 return _frozenHashCode;
             }
-            else
-            {
-                return GetHashCodeHelper();
-            }
-        }
-
-        /// <summary>
-        /// Returns a string representation of the settings.
-        /// </summary>
-        /// <returns>A string representation of the settings.</returns>
-        public override string ToString()
-        {
-            if (_isFrozen)
-            {
-                return _frozenStringRepresentation;
-            }
-            else
-            {
-                return ToStringHelper();
-            }
-        }
 
-        // private methods
-        private int GetHashCodeHelper()
-        {
             // see Effective Java by Joshua Bloch
             int hash = 17;
             hash = 37 * hash + _connectionMode.GetHashCode();
@@ -567,8 +543,17 @@ private int GetHashCodeHelper()
             return hash;
         }
 
-        private string ToStringHelper()
+        /// <summary>
+        /// Returns a string representation of the settings.
+        /// </summary>
+        /// <returns>A string representation of the settings.</returns>
+        public override string ToString()
         {
+            if (_isFrozen)
+            {
+                return _frozenStringRepresentation;
+            }
+
             var sb = new StringBuilder();
             string serversString = null;
             if (_servers != null)

Driver/Core/SafeMode.cs

@@ -427,7 +427,7 @@ public SafeMode Freeze()
         {
             if (!_isFrozen)
             {
-                _frozenHashCode = GetHashCodeHelper();
+                _frozenHashCode = GetHashCode();
                 _isFrozen = true;
             }
             return this;
@@ -459,10 +459,16 @@ public override int GetHashCode()
             {
                 return _frozenHashCode;
             }
-            else
-            {
-                return GetHashCodeHelper();
-            }
+
+            // see Effective Java by Joshua Bloch
+            int hash = 17;
+            hash = 37 * hash + _enabled.GetHashCode();
+            hash = 37 * hash + _fsync.GetHashCode();
+            hash = 37 * hash + _j.GetHashCode();
+            hash = 37 * hash + _w.GetHashCode();
+            hash = 37 * hash + ((_wmode == null) ? 0 : _wmode.GetHashCode());
+            hash = 37 * hash + _wtimeout.GetHashCode();
+            return hash;
         }
 
         /// <summary>
@@ -506,19 +512,6 @@ public override string ToString()
         }
 
         // private methods
-        private int GetHashCodeHelper()
-        {
-            // see Effective Java by Joshua Bloch
-            int hash = 17;
-            hash = 37 * hash + _enabled.GetHashCode();
-            hash = 37 * hash + _fsync.GetHashCode();
-            hash = 37 * hash + _j.GetHashCode();
-            hash = 37 * hash + _w.GetHashCode();
-            hash = 37 * hash + ((_wmode == null) ? 0 : _wmode.GetHashCode());
-            hash = 37 * hash + _wtimeout.GetHashCode();
-            return hash;
-        }
-
         private void ThrowFrozenException()
         {
             throw new InvalidOperationException("SafeMode has been frozen and no further changes are allowed.");

Driver/GridFS/MongoGridFSSettings.cs

@@ -30,12 +30,13 @@ public class MongoGridFSSettings : IEquatable<MongoGridFSSettings>
         private static MongoGridFSSettings __defaults = new MongoGridFSSettings();
 
         // private fields
-        private bool _isFrozen;
         private string _chunksCollectionName = "fs.chunks";
         private int _chunkSize = 256 * 1024; // 256KiB
         private string _filesCollectionName = "fs.files";
         private string _root = "fs";
         private SafeMode _safeMode = SafeMode.False;
+        private bool _isFrozen;
+        private int _frozenHashCode;
 
         // constructors
         /// <summary>
@@ -211,6 +212,7 @@ public MongoGridFSSettings Freeze()
             if (!_isFrozen)
             {
                 _safeMode = _safeMode.FrozenCopy();
+                _frozenHashCode = GetHashCode();
                 _isFrozen = true;
             }
             return this;
@@ -238,6 +240,11 @@ public MongoGridFSSettings FrozenCopy()
         /// <returns>The hash code.</returns>
         public override int GetHashCode()
         {
+            if (_isFrozen)
+            {
+                return _frozenHashCode;
+            }
+
             // see Effective Java by Joshua Bloch
             int hash = 17;
             hash = 37 * hash + _chunkSize.GetHashCode();