source: branches/CloningRefactoring/HeuristicLab.Persistence/3.3/Default/CompositeSerializers/Storable/StorableClassAttribute.cs @ 4658

Last change on this file since 4658 was 4658, checked in by mkommend, 9 years ago

Added StorableConstructorTest and StorableClassAttribute.IsStorableClass (ticket #922).

File size: 2.3 KB
Line 
1#region License Information
2/* HeuristicLab
3 * Copyright (C) 2002-2010 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;
23
24namespace HeuristicLab.Persistence.Default.CompositeSerializers.Storable {
25
26  /// <summary>
27  /// Mark a class to be considered by the <c>StorableSerializer</c>.
28  /// </summary>
29  [AttributeUsage(AttributeTargets.Class, Inherited = false, AllowMultiple = false)]
30  public sealed class StorableClassAttribute : Attribute {
31
32
33    /// <summary>
34    /// Specify how members are selected for serialization.
35    /// </summary>
36    public StorableClassType Type { get; private set; }
37
38    /// <summary>
39    /// Mark a class to be serialize by the <c>StorableSerizlier</c>
40    /// </summary>
41    /// <param name="type">The storable class type.</param>
42    public StorableClassAttribute(StorableClassType type) {
43      Type = type;
44    }
45
46    /// <summary>
47    /// Initializes a new instance of the <see cref="StorableClassAttribute"/> class.
48    /// The default value for <see cref="StorableClassType"/> is
49    /// <see cref="StorableClassType.MarkedOnly"/>.
50    /// </summary>
51    public StorableClassAttribute() { }
52
53    /// <summary>
54    ///  Checks if the <see cref="StorableClassAttribute"/> is present on a type.
55    /// </summary>
56    /// <param name="type">The type which should be checked for the <see cref="StorableClassAttribute"/></param>
57    /// <returns></returns>
58    public static bool IsStorableClass(Type type) {
59      object[] attribs = type.GetCustomAttributes(typeof(StorableClassAttribute), false);
60      return attribs.Length > 0;
61    }
62
63  }
64}
65
Note: See TracBrowser for help on using the repository browser.