source: branches/irace/HeuristicLab.Common/3.3/Cloner.cs @ 11700

#region License Information
/* HeuristicLab
 * Copyright (C) 2002-2014 Heuristic and Evolutionary Algorithms Laboratory (HEAL)
 *
 * This file is part of HeuristicLab.
 *
 * HeuristicLab is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * HeuristicLab is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with HeuristicLab. If not, see <http://www.gnu.org/licenses/>.
 */
#endregion

using System.Collections.Generic;

namespace HeuristicLab.Common {
  /// <summary>
  /// A helper class which is used to create deep clones of object graphs.
  /// </summary>
  public sealed class Cloner {
    private Dictionary<IDeepCloneable, IDeepCloneable> mapping;

    /// <summary>
    /// Creates a new Cloner instance.
    /// </summary>
    public Cloner() {
      mapping = new Dictionary<IDeepCloneable, IDeepCloneable>(new ReferenceEqualityComparer());
    }

    /// <summary>
    /// Creates a deep clone of a given deeply cloneable object.
    /// </summary>
    /// <param name="item">The object which should be cloned.</param>
    /// <returns>A clone of the given object.</returns>
    public T Clone<T>(T obj) where T : class, IDeepCloneable {
      if (obj == null) return null;
      IDeepCloneable clone;
      if (mapping.TryGetValue(obj, out clone))
        return (T)clone;
      else
        return (T)obj.Clone(this);
    }
    /// <summary>
    /// Registers a new clone for a given deeply cloneable object.
    /// </summary>
    /// <param name="item">The original object.</param>
    /// <param name="clone">The clone of the original object.</param>
    public void RegisterClonedObject(IDeepCloneable item, IDeepCloneable clone) {
      mapping.Add(item, clone);
    }

    /// <summary>
    /// Checks if a clone is already registered for a given deeply cloneable item.
    /// </summary>
    /// <param name="item">The original object.</param>
    /// <returns>True if a clone is already registered for the given item; false otherwise</returns>
    public bool ClonedObjectRegistered(IDeepCloneable item) {
      return mapping.ContainsKey(item);
    }

    /// <summary>
    /// Returns the clone of an deeply cloned item, if it was already cloned.
    /// </summary>
    /// <param name="original">The original object.</param>
    /// <returns>The clone of the given object, if it was already cloned; null otherwise</returns>
    public IDeepCloneable GetClone(IDeepCloneable original) {
      IDeepCloneable clone = null;
      mapping.TryGetValue(original, out clone);
      return clone;
    }

  }
}