source: branches/PersistenceOverhaul/HeuristicLab.Persistence/3.3/Default/CompositeSerializers/Storable/StorableClassAttribute.cs @ 13367

Last change on this file since 13367 was 13367, checked in by swagner, 3 years ago

#2520: Worked on new persistence implementation

File size: 2.8 KB
Line 
1#region License Information
2/* HeuristicLab
3 * Copyright (C) 2002-2015 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    public Guid Guid { get; private set; }
39    public bool Released { get; set; }
40
41    /// <summary>
42    /// Mark a class to be serialize by the <c>StorableSerizlier</c>
43    /// </summary>
44    /// <param name="type">The storable class type.</param>
45    public StorableClassAttribute(StorableClassType type, string guid) {
46      Type = type;
47      Guid = new Guid(guid);
48      Released = false;
49    }
50
51    public StorableClassAttribute(string guid) {
52      Guid = new Guid(guid);
53      Released = false;
54    }
55
56    /// <summary>
57    /// Initializes a new instance of the <see cref="StorableClassAttribute"/> class.
58    /// The default value for <see cref="StorableClassType"/> is
59    /// <see cref="StorableClassType.MarkedOnly"/>.
60    /// </summary>
61    public StorableClassAttribute() { }
62
63    /// <summary>
64    ///  Checks if the <see cref="StorableClassAttribute"/> is present on a type.
65    /// </summary>
66    /// <param name="type">The type which should be checked for the <see cref="StorableClassAttribute"/></param>
67    /// <returns></returns>
68    public static bool IsStorableClass(Type type) {
69      object[] attribs = type.GetCustomAttributes(typeof(StorableClassAttribute), false);
70      return attribs.Length > 0;
71    }
72
73    public static StorableClassAttribute GetStorableClassAttribute(Type type) {
74      return (StorableClassAttribute)Attribute.GetCustomAttribute(type, typeof(StorableClassAttribute), false);
75    }
76
77  }
78}
79
Note: See TracBrowser for help on using the repository browser.