Free cookie consent management tool by TermsFeed Policy Generator

source: branches/2922-DataCompletenessChartPerf/HeuristicLab.PluginInfrastructure/3.3/Attributes/PluginDependencyAttribute.cs @ 16175

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

#2640: Updated year of copyrights in license headers

File size: 2.3 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
22using System;
23
24namespace HeuristicLab.PluginInfrastructure {
25  /// <summary>
26  /// This attribute can be used to declare that a plugin depends on a another plugin.
27  /// </summary>
28  [AttributeUsage(AttributeTargets.Class, AllowMultiple = true)]
29  public sealed class PluginDependencyAttribute : System.Attribute {
30    private string dependency;
31
32    /// <summary>
33    /// Gets the name of the plugin that is needed to load a plugin.
34    /// </summary>
35    public string Dependency {
36      get { return dependency; }
37    }
38
39    private Version version;
40    /// <summary>
41    /// Gets the version of the plugin dependency.
42    /// </summary>
43    public Version Version {
44      get { return version; }
45    }
46
47    /// <summary>
48    /// Initializes a new instance of <see cref="PluginDependencyAttribute" />.
49    /// </summary>
50    /// <param name="dependency">Name of the plugin dependency.</param>
51    /// <param name="version">Version of the plugin dependency.</param>
52    public PluginDependencyAttribute(string dependency, string version) {
53      if (string.IsNullOrEmpty(dependency)) throw new ArgumentException("Dependency name is null or empty.", "dependency");
54      if (string.IsNullOrEmpty(version)) throw new ArgumentException("Dependency version is null or empty.", "version");
55      this.dependency = dependency;
56      this.version = new Version(version); // throws format exception if the version string can't be parsed
57    }
58  }
59}
Note: See TracBrowser for help on using the repository browser.