Merge pull request #248 from servicetitan/upstream/EnsureNotLocked2

Optimizing refactoring: convert EnsureNotLocked() from extension to Method.
The extension is marked obsolete

Author: alex-kulakov

Orm/Xtensive.Orm/Collections/CollectionBaseSlim.cs

@@ -77,7 +77,7 @@ IEnumerator IEnumerable.GetEnumerator()
     /// <inheritdoc/>
     public virtual void Add(TItem item)
     {
-      this.EnsureNotLocked();
+      EnsureNotLocked();
       items.Add(item);
     }
 
@@ -88,21 +88,21 @@ public virtual void Add(TItem item)
     /// <exception cref="T:System.ArgumentNullException">collection is null.</exception>
     public virtual void AddRange(IEnumerable<TItem> collection)
     {
-      this.EnsureNotLocked();
+      EnsureNotLocked();
       items.AddRange(collection);
     }
 
     /// <inheritdoc/>
     public virtual bool Remove(TItem item)
     {
-      this.EnsureNotLocked();
+      EnsureNotLocked();
       return items.Remove(item);
     }
 
     /// <inheritdoc/>
     public virtual void Clear()
     {
-      this.EnsureNotLocked();
+      EnsureNotLocked();
       items.Clear();
     }
 

Orm/Xtensive.Orm/Collections/ExtensionCollection.cs

@@ -67,7 +67,7 @@ public void Set<T>(T value)
     /// <exception cref="ArgumentException">Wrong arguments.</exception>
     public void Set(Type extensionType, object value)
     {
-      this.EnsureNotLocked();
+      EnsureNotLocked();
       ArgumentValidator.EnsureArgumentNotNull(extensionType, "extensionType");
       if (extensionType.IsValueType)
         throw new ArgumentException(string.Format(
@@ -87,7 +87,7 @@ public void Set(Type extensionType, object value)
     /// <inheritdoc/>
     public void Clear()
     {
-      this.EnsureNotLocked();
+      EnsureNotLocked();
       extensions = null;
     }
 

Orm/Xtensive.Orm/Collections/FlagCollection.cs

@@ -72,7 +72,7 @@ public bool ContainsKey(TKey key)
     /// <inheritdoc/>
     public void Add(TKey key, TFlag flag)
     {
-      this.EnsureNotLocked();
+      EnsureNotLocked();
       if (keys.Contains(key))
         throw new ArgumentException("key", Strings.ExCollectionAlreadyContainsSpecifiedItem);
       if (keys.Count >= MaxItemCount)
@@ -91,7 +91,7 @@ public virtual void Add(TKey key)
     public bool Remove(TKey key)
     {
       ArgumentValidator.EnsureArgumentIsNotDefault(key, "key");
-      this.EnsureNotLocked();
+      EnsureNotLocked();
       int index = keys.IndexOf(key);
       if (index < 0)
         return false;
@@ -130,7 +130,7 @@ public TFlag this[TKey key]
       set
       {
         ArgumentValidator.EnsureArgumentIsNotDefault(key, "key");
-        this.EnsureNotLocked();
+        EnsureNotLocked();
         int index = keys.IndexOf(key);
         if (index < 0)
           Add(key, value);
@@ -191,7 +191,7 @@ public void Add(KeyValuePair<TKey, TFlag> item)
     /// <inheritdoc/>
     public void Clear()
     {
-      this.EnsureNotLocked();
+      EnsureNotLocked();
       keys.Clear();
       flags = new BitVector32(0);
     }

Orm/Xtensive.Orm/Collections/TypeRegistry.cs

@@ -57,7 +57,7 @@ public bool Contains(Type type)
     /// <param name="type">The type to register.</param>
     public void Register(Type type)
     {
-      this.EnsureNotLocked();
+      EnsureNotLocked();
       ArgumentValidator.EnsureArgumentNotNull(type, "type");
       if (!isProcessingPendingActions)
         Register(new TypeRegistration(type));
@@ -78,7 +78,7 @@ public void Register(Type type)
     /// <exception cref="ArgumentNullException">When <paramref name="assembly"/> is null.</exception>
     public void Register(Assembly assembly)
     {
-      this.EnsureNotLocked();
+      EnsureNotLocked();
       ArgumentValidator.EnsureArgumentNotNull(assembly, "assembly");
       Register(new TypeRegistration(assembly));
     }
@@ -95,7 +95,7 @@ public void Register(Assembly assembly)
     /// or <paramref name="namespace"/> is empty string.</exception>
     public void Register(Assembly assembly, string @namespace)
     {
-      this.EnsureNotLocked();
+      EnsureNotLocked();
       ArgumentValidator.EnsureArgumentNotNull(assembly, "assembly");
       ArgumentValidator.EnsureArgumentNotNullOrEmpty(@namespace, "@namespace");
       Register(new TypeRegistration(assembly, @namespace));
@@ -109,7 +109,7 @@ public void Register(Assembly assembly, string @namespace)
     /// otherwise, <see langword="false" />.</returns>
     public bool Register(TypeRegistration action)
     {
-      this.EnsureNotLocked();
+      EnsureNotLocked();
       ArgumentValidator.EnsureArgumentNotNull(action, "action");
       if (actionSet.Contains(action))
         return false;
@@ -143,7 +143,7 @@ private void ProcessPendingActions()
     /// <inheritdoc/>
     public override void Lock(bool recursive)
     {
-      this.EnsureNotLocked();
+      EnsureNotLocked();
       ProcessPendingActions();
       assemblies = new ReadOnlyHashSet<Assembly>((HashSet<Assembly>)assemblies);
       base.Lock(recursive);

Orm/Xtensive.Orm/Core/Extensions/LockableExtensions.cs

@@ -4,6 +4,8 @@
 // Created by: Alex Yakunin
 // Created:    2008.07.04
 
+using System;
+
 namespace Xtensive.Core
 {
   /// <summary>
@@ -16,6 +18,7 @@ public static class LockableExtensions
     /// </summary>
     /// <param name="lockable">Lockable object to check.</param>
     /// <exception cref="InstanceIsLockedException">Specified instance is locked.</exception>
+    [Obsolete("Use LockableBase.EnsureNotLocked method instead.")]
     public static void EnsureNotLocked(this ILockable lockable)
     {
       ArgumentValidator.EnsureArgumentNotNull(lockable, "lockable");

Orm/Xtensive.Orm/Core/Interfaces/ILockable.cs

@@ -1,6 +1,6 @@
-// Copyright (C) 2003-2010 Xtensive LLC.
-// All rights reserved.
-// For conditions of distribution and use, see license.
+// Copyright (C) 2003-2022 Xtensive LLC.
+// This code is distributed under MIT license terms.
+// See the License.txt file in the project root for more information.
 
 namespace Xtensive.Core
 {
@@ -23,7 +23,7 @@ public interface ILockable
     bool IsLocked { get; }
 
     /// <summary>
-    /// Locks the instance (non-recursively).
+    /// Locks the instance recursively.
     /// </summary>
     void Lock();
 

Orm/Xtensive.Orm/Core/LockableBase.cs

@@ -1,6 +1,6 @@
-// Copyright (C) 2003-2010 Xtensive LLC.
-// All rights reserved.
-// For conditions of distribution and use, see license.
+// Copyright (C) 2003-2022 Xtensive LLC.
+// This code is distributed under MIT license terms.
+// See the License.txt file in the project root for more information.
 // Created by: Alex Yakunin
 // Created:    2007.11.22
 
@@ -16,36 +16,28 @@ namespace Xtensive.Core
   [Serializable]
   public abstract class LockableBase: ILockable
   {
-    private bool isLocked;
 
     /// <inheritdoc/>
-    public bool IsLocked
+    public bool IsLocked { [DebuggerStepThrough] get; private set; }
+
+    /// <summary>
+    /// Ensures the object is not locked (see <see cref="ILockable.Lock()"/>) yet.
+    /// </summary>
+    /// <exception cref="InstanceIsLockedException">The instance is locked.</exception>
+    public void EnsureNotLocked()
     {
-      [DebuggerStepThrough]
-      get { return isLocked; }
+      if (IsLocked) {
+        throw new InstanceIsLockedException(Strings.ExInstanceIsLocked);
+      }
     }
 
     /// <inheritdoc/>
-    public void Lock()
-    {
-      Lock(true);
-    }
+    public void Lock() => Lock(true);
 
     /// <inheritdoc/>
-    public virtual void Lock(bool recursive)
-    {
-      isLocked = true;
-    }
+    public virtual void Lock(bool recursive) => IsLocked = true;
+
 
-    /// <summary>
-    /// Unlocks the object.
-    /// Sets <see cref="IsLocked"/> to <see langword="false"/>.
-    /// </summary>
-    protected void Unlock()
-    {
-      isLocked = false;
-    }
-    
 
     // Constructors
 
@@ -63,7 +55,7 @@ protected LockableBase()
     /// <param name="isLocked">Initial <see cref="IsLocked"/> property value.</param>
     protected LockableBase(bool isLocked)
     {
-      this.isLocked = isLocked;
+      IsLocked = isLocked;
     }
   }
 }

Orm/Xtensive.Orm/Modelling/Actions/ActionSequence.cs

@@ -42,7 +42,7 @@ public ActionScope LogAction()
     public void Add(NodeAction action)
     {
       ArgumentValidator.EnsureArgumentNotNull(action, "action");
-      this.EnsureNotLocked();
+      EnsureNotLocked();
       // Only locked actions can be added
       var ca = action as PropertyChangeAction;
       if (ca!=null && actions.Count!=0) {
@@ -56,7 +56,7 @@ public void Add(NodeAction action)
           actions.RemoveAt(lastIndex);
         }
       }
-      action.Lock(true); 
+      action.Lock(true);
       actions.Add(action);
     }
 

Orm/Xtensive.Orm/Modelling/Actions/CreateNodeAction.cs

@@ -32,7 +32,7 @@ public Type Type {
       get { return type; }
       set {
         ArgumentValidator.EnsureArgumentNotNull(value, "value");
-        this.EnsureNotLocked();
+        EnsureNotLocked();
         type = value;
       }
     }
@@ -44,7 +44,7 @@ public string Name {
       get { return name; }
       set {
         ArgumentValidator.EnsureArgumentNotNullOrEmpty(value, "value");
-        this.EnsureNotLocked();
+        EnsureNotLocked();
         name = value;
       }
     }
@@ -56,7 +56,7 @@ public string Name {
     public int? Index {
       get { return index; }
       set {
-        this.EnsureNotLocked();
+        EnsureNotLocked();
         index = value;
       }
     }
@@ -71,7 +71,7 @@ public object[] Parameters {
         return parameters==null ? null : (object[]) parameters.Clone();
       }
       set {
-        this.EnsureNotLocked();
+        EnsureNotLocked();
         parameters = value;
       }
     }

Orm/Xtensive.Orm/Modelling/Actions/DataAction.cs

@@ -26,7 +26,7 @@ public DataHint DataHint
       get { return dataHint; }
       set
       {
-        this.EnsureNotLocked();
+        EnsureNotLocked();
         dataHint = value;
         Path = dataHint.SourceTablePath;
       }