[2] | 1 | #region License Information
|
---|
| 2 | /* HeuristicLab
|
---|
[11170] | 3 | * Copyright (C) 2002-2014 Heuristic and Evolutionary Algorithms Laboratory (HEAL)
|
---|
[2] | 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 | using System;
|
---|
| 23 |
|
---|
| 24 | namespace HeuristicLab.PluginInfrastructure {
|
---|
| 25 | /// <summary>
|
---|
[2475] | 26 | /// This attribute can be used to specify meta data for plugins.
|
---|
[2504] | 27 | /// For example to specify name and description of plugins.
|
---|
[2] | 28 | /// </summary>
|
---|
| 29 | [AttributeUsage(AttributeTargets.Class)]
|
---|
[2504] | 30 | public sealed class PluginAttribute : System.Attribute {
|
---|
[2] | 31 | private string name;
|
---|
| 32 | /// <summary>
|
---|
[2504] | 33 | /// Gets the name of the plugin.
|
---|
[2] | 34 | /// </summary>
|
---|
| 35 | public string Name {
|
---|
| 36 | get { return name; }
|
---|
| 37 | }
|
---|
| 38 |
|
---|
[2488] | 39 | private string description;
|
---|
| 40 | /// <summary>
|
---|
[2504] | 41 | /// Gets the description of the plugin.
|
---|
[2488] | 42 | /// </summary>
|
---|
| 43 | public string Description {
|
---|
| 44 | get { return description; }
|
---|
| 45 | }
|
---|
[2] | 46 |
|
---|
[2750] | 47 | private Version version;
|
---|
[1189] | 48 | /// <summary>
|
---|
[2750] | 49 | /// Gets the version of the plugin.
|
---|
| 50 | /// </summary>
|
---|
| 51 | public Version Version {
|
---|
| 52 | get { return version; }
|
---|
| 53 | }
|
---|
| 54 |
|
---|
| 55 | /// <summary>
|
---|
[2488] | 56 | /// Initializes a new instance of <see cref="PluginAttribute"/>.
|
---|
[2475] | 57 | /// <param name="name">Name of the plugin</param>
|
---|
[2750] | 58 | /// <param name="version">Version of the plugin</param>
|
---|
[1189] | 59 | /// </summary>
|
---|
[2750] | 60 | public PluginAttribute(string name, string version)
|
---|
| 61 | : this(name, string.Empty, version) {
|
---|
[2488] | 62 | }
|
---|
| 63 |
|
---|
| 64 | /// <summary>
|
---|
| 65 | /// Initializes a new instance of <see cref="PluginAttribute"/>.
|
---|
[2750] | 66 | /// </summary>
|
---|
[2488] | 67 | /// <param name="name">Name of the plugin</param>
|
---|
| 68 | /// <param name="description">Description of the plugin</param>
|
---|
[2750] | 69 | /// <param name="version">Version of the plugin</param>
|
---|
| 70 | public PluginAttribute(string name, string description, string version) {
|
---|
[2748] | 71 | if (string.IsNullOrEmpty(name)) throw new ArgumentException("Plugin name is null or empty.");
|
---|
| 72 | if (description == null) throw new ArgumentNullException("description");
|
---|
[4482] | 73 | if (string.IsNullOrEmpty(version)) throw new ArgumentException("Version string is null or empty.");
|
---|
[2481] | 74 | this.name = name;
|
---|
[2488] | 75 | this.description = description;
|
---|
[2750] | 76 | this.version = new Version(version); // throws format exception if the version string can't be parsed
|
---|
[242] | 77 | }
|
---|
[2] | 78 | }
|
---|
| 79 | }
|
---|