API Cleanup

Author: Oren (electricessence)

Node.Clone.cs

@@ -17,7 +17,7 @@ public sealed partial class Node<T>
 		/// <param name="onNodeCloned">A function that recieves the old node and its clone.</param>
 		/// <returns>The copy of the tree/branch.</returns>
 		public Node<T> Clone(
-			Node<T> newParentForClone,
+			Node<T> newParentForClone = null,
 			Action<Node<T>, Node<T>> onNodeCloned = null)
 		{
 			if (newParentForClone != null && newParentForClone._factory != _factory)
@@ -33,7 +33,7 @@ public Node<T> Clone(
 			foreach (var child in _children)
 				clone.Add(child.Clone(clone, onNodeCloned));
 
-			clone.UnMapped = UnMapped;
+			clone.Unmapped = Unmapped;
 
 			onNodeCloned?.Invoke(this, clone);
 
@@ -54,12 +54,13 @@ public Node<T> Clone(
 		/// Create's a clone of the entire tree but only returns the clone of this node.
 		/// </summary>
 		/// <returns>A clone of this node as part of a newly cloned tree.</returns>
-		public Node<T> CloneTree(Node<T> target)
+		public Node<T> CloneTree()
 		{
 			Node<T> node = null;
-			target.Root.Clone((n, clone) =>
+			Root.Clone((original, clone) =>
 			{
-				if (n == target) node = clone;
+				if (original == this)
+					node = clone;
 			});
 			return node;
 		}

Node.Factory.cs

@@ -92,7 +92,7 @@ public Node<T> Map<TRoot>(TRoot root)
 
 				// Mapping is deferred and occurs on demand.
 				// If values or children change in the node, mapping is disregarded.
-				current.UnMapped = true;
+				current.Unmapped = true;
 
 
 				return current;

Node.cs

@@ -38,7 +38,7 @@ public T Value
 			set
 			{
 				AssertNotRecycled();
-				UnMapped = false;
+				Unmapped = false;
 				_value = value;
 			}
 		}
@@ -50,23 +50,23 @@ public T Value
 		/// Will be false if not created by calling Factory.Map or if the value has been mapped.
 		/// Since querying the chidren of this node will cause the value to be mapped, it can be useful to query this value before attempting traversal.
 		/// </summary>
-		public bool UnMapped { get; private set; }
+		public bool Unmapped { get; private set; }
 
 		IReadOnlyList<Node<T>> EnsureChildrenMapped()
 		{
-			if (!UnMapped)
+			if (!Unmapped)
 				return _childrenReadOnly;
 
 			// Need to avoid double mapping and this method is primarily called when 'reading' from the node and contention will only occur if mapping is needed.
 			lock (_children)
 			{
-				if (!UnMapped) return _childrenReadOnly;
+				if (!Unmapped) return _childrenReadOnly;
 				if (_value is IParent<T> p)
 				{
 					foreach (var child in p.Children)
 						_children.Add(_factory.Map(child));
 				}
-				UnMapped = false;
+				Unmapped = false;
 			}
 
 			return _childrenReadOnly;
@@ -103,7 +103,7 @@ public bool Remove(Node<T> node)
 			if (!_children.Remove(node)) return false;
 
 			AssertNotRecycled();
-			UnMapped = false;
+			Unmapped = false;
 			node.Parent = null; // Need to be very careful about retaining parent references as it may cause a 'leak' per-se.
 			return true;
 		}
@@ -133,7 +133,7 @@ public void Clear()
 			if (_children.Count == 0) return;
 
 			AssertNotRecycled();
-			UnMapped = false;
+			Unmapped = false;
 			foreach (var c in _children)
 				c.Parent = null;
 			_children.Clear();
@@ -177,7 +177,7 @@ public void Replace(Node<T> node, Node<T> replacement)
 				throw new InvalidOperationException("Node being replaced does not belong to this parent.");
 
 			AssertNotRecycled();
-			UnMapped = false;
+			Unmapped = false;
 			_children[i] = replacement;
 			node.Parent = null;
 			replacement.Parent = this;
@@ -215,7 +215,7 @@ public Node<T> Root
 		/// </summary>
 		public void Teardown()
 		{
-			UnMapped = false;
+			Unmapped = false;
 			Value = default;
 			Detatch(); // If no parent then this does nothing...
 			TeardownChildren();
@@ -229,7 +229,7 @@ public void TeardownChildren()
 			if (_children.Count == 0) return;
 
 			AssertNotRecycled();
-			UnMapped = false;
+			Unmapped = false;
 			foreach (var c in _children)
 			{
 				c.Parent = null; // Don't initiate a 'Detach' (which does a lookup) since we are clearing here;
@@ -245,7 +245,7 @@ public void TeardownChildren()
 		public T Recycle()
 		{
 			AssertNotRecycled(); // Avoid double entry in the pool.
-			UnMapped = false;
+			Unmapped = false;
 			var value = Value;
 			Value = default;
 			Detatch(); // If no parent then this does nothing...
@@ -260,7 +260,7 @@ public void RecycleChildren()
 		{
 			if (_children.Count == 0) return;
 
-			UnMapped = false;
+			Unmapped = false;
 			foreach (var c in _children)
 			{
 				c.Parent = null; // Don't initiate a 'Detach' (which does a lookup) since we are clearing here;

Open.Hierarchy.csproj

@@ -14,10 +14,8 @@ Part of the "Open" set of libraries.</Description>
     <RepositoryUrl>https://github.com/electricessence/Open.Hierarchy/</RepositoryUrl>
     <RepositoryType>git</RepositoryType>
     <PackageTags>dotnet, dotnetcore, cs, tree, node, hierarchy, parent, child, root</PackageTags>
-    <Version>1.4.1</Version>
-    <PackageReleaseNotes>Deferred unidirectional to bidirectional tree mapping.
-Improved assertions and added recycled node validation.
-Simplified factory and recycling usage: nodes now have a referene to their source factory.</PackageReleaseNotes>
+    <Version>1.4.3</Version>
+    <PackageReleaseNotes>API simplification and improvments to deferred mapping.</PackageReleaseNotes>
   </PropertyGroup>
 
   <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release|AnyCPU'">