source: branches/2520_PersistenceReintegration/HeuristicLab.Common/3.3/Cloner.cs @ 16453

Last change on this file since 16453 was 16453, checked in by jkarder, 10 months ago

#2520: updated year of copyrights

File size: 3.0 KB
Line 
1#region License Information
2/* HeuristicLab
3 * Copyright (C) 2002-2019 Heuristic and Evolutionary Algorithms Laboratory (HEAL)
4 *
5 * This file is part of HeuristicLab.
6 *
7 * HeuristicLab is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation, either version 3 of the License, or
10 * (at your option) any later version.
11 *
12 * HeuristicLab is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with HeuristicLab. If not, see <http://www.gnu.org/licenses/>.
19 */
20#endregion
21
22using System.Collections.Generic;
23
24namespace HeuristicLab.Common {
25  /// <summary>
26  /// A helper class which is used to create deep clones of object graphs.
27  /// </summary>
28  public sealed class Cloner {
29    private Dictionary<IDeepCloneable, IDeepCloneable> mapping;
30
31    /// <summary>
32    /// Creates a new Cloner instance.
33    /// </summary>
34    public Cloner() {
35      mapping = new Dictionary<IDeepCloneable, IDeepCloneable>(new ReferenceEqualityComparer());
36    }
37
38    /// <summary>
39    /// Creates a deep clone of a given deeply cloneable object.
40    /// </summary>
41    /// <param name="item">The object which should be cloned.</param>
42    /// <returns>A clone of the given object.</returns>
43    public T Clone<T>(T obj) where T : class, IDeepCloneable {
44      if (obj == null) return null;
45      IDeepCloneable clone;
46      if (mapping.TryGetValue(obj, out clone))
47        return (T)clone;
48      else
49        return (T)obj.Clone(this);
50    }
51    /// <summary>
52    /// Registers a new clone for a given deeply cloneable object.
53    /// </summary>
54    /// <param name="item">The original object.</param>
55    /// <param name="clone">The clone of the original object.</param>
56    public void RegisterClonedObject(IDeepCloneable item, IDeepCloneable clone) {
57      mapping.Add(item, clone);
58    }
59
60    /// <summary>
61    /// Checks if a clone is already registered for a given deeply cloneable item.
62    /// </summary>
63    /// <param name="item">The original object.</param>
64    /// <returns>True if a clone is already registered for the given item; false otherwise</returns>
65    public bool ClonedObjectRegistered(IDeepCloneable item) {
66      return mapping.ContainsKey(item);
67    }
68
69    /// <summary>
70    /// Returns the clone of an deeply cloned item, if it was already cloned.
71    /// </summary>
72    /// <param name="original">The original object.</param>
73    /// <returns>The clone of the given object, if it was already cloned; null otherwise</returns>
74    public IDeepCloneable GetClone(IDeepCloneable original) {
75      IDeepCloneable clone = null;
76      mapping.TryGetValue(original, out clone);
77      return clone;
78    }
79
80  }
81}
Note: See TracBrowser for help on using the repository browser.