Free cookie consent management tool by TermsFeed Policy Generator

source: branches/2877_HiveImprovements/HeuristicLab.Common/3.3/DeepCloneable.cs @ 15775

Last change on this file since 15775 was 15583, checked in by swagner, 7 years ago

#2640: Updated year of copyrights in license headers

File size: 2.0 KB
Line 
1#region License Information
2/* HeuristicLab
3 * Copyright (C) 2002-2018 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
22
23namespace HeuristicLab.Common {
24  /// <summary>
25  /// Represents a base class for all deeply cloneable objects.
26  /// </summary>
27  public abstract class DeepCloneable : IDeepCloneable {
28    protected DeepCloneable(DeepCloneable original, Cloner cloner) {
29      cloner.RegisterClonedObject(original, this);
30    }
31    protected DeepCloneable() { }
32
33    /// <summary>
34    /// Creates a deep clone of this instance.
35    /// </summary>
36    /// <remarks>
37    /// This method is the entry point for creating a deep clone of a whole object graph.
38    /// </remarks>
39    /// <returns>A clone of this instance.</returns>
40    public object Clone() {
41      return Clone(new Cloner());
42    }
43
44    /// <summary>
45    /// Creates a deep clone of this instance.
46    /// </summary>
47    /// <remarks>This method should not be called directly. It is used for creating clones of
48    /// objects which are contained in the object that is currently cloned.</remarks>
49    /// <param name="cloner">The cloner which is responsible for keeping track of all already
50    /// cloned objects.</param>
51    /// <returns>A clone of this instance.</returns>
52    public abstract IDeepCloneable Clone(Cloner cloner);
53  }
54}
Note: See TracBrowser for help on using the repository browser.