1 | #region License Information
|
---|
2 | /* HeuristicLab
|
---|
3 | * Copyright (C) 2002-2019 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 | using System;
|
---|
23 |
|
---|
24 | namespace HeuristicLab.PluginInfrastructure {
|
---|
25 | /// <summary>
|
---|
26 | /// This attribute can be used to specify meta data for applications.
|
---|
27 | /// For example to specify name and description of applications.
|
---|
28 | /// </summary>
|
---|
29 | [AttributeUsage(AttributeTargets.Class)]
|
---|
30 | public sealed class ApplicationAttribute : System.Attribute {
|
---|
31 | private string name;
|
---|
32 | /// <summary>
|
---|
33 | /// Gets the name of the application.
|
---|
34 | /// </summary>
|
---|
35 | public string Name {
|
---|
36 | get { return name; }
|
---|
37 | }
|
---|
38 |
|
---|
39 | private string description;
|
---|
40 | /// <summary>
|
---|
41 | /// Gets the description of the application.
|
---|
42 | /// </summary>
|
---|
43 | public string Description {
|
---|
44 | get { return description; }
|
---|
45 | }
|
---|
46 |
|
---|
47 | private bool restartOnErrors;
|
---|
48 | /// <summary>
|
---|
49 | /// Gets whether the plugin should be automatically restarted when it is closed because of an exception (for services).
|
---|
50 | /// </summary>
|
---|
51 | public bool RestartOnErrors {
|
---|
52 | get { return restartOnErrors; }
|
---|
53 | }
|
---|
54 |
|
---|
55 | /// <summary>
|
---|
56 | /// Initializes a new instance of <see cref="ApplicationAttribute"/>.
|
---|
57 | /// <param name="name">Name of the application</param>
|
---|
58 | /// </summary>
|
---|
59 | public ApplicationAttribute(string name)
|
---|
60 | : this(name, String.Empty) {
|
---|
61 | }
|
---|
62 |
|
---|
63 | /// <summary>
|
---|
64 | /// Initializes a new instance of <see cref="ApplicationAttribute"/>.
|
---|
65 | /// <param name="name">Name of the application</param>
|
---|
66 | /// <param name="description">Description of the application</param>
|
---|
67 | /// </summary>
|
---|
68 | public ApplicationAttribute(string name, string description)
|
---|
69 | : this(name, description, false) {
|
---|
70 | }
|
---|
71 |
|
---|
72 | /// <summary>
|
---|
73 | /// Initializes a new instance of <see cref="ApplicationAttribute"/>.
|
---|
74 | /// <param name="name">Name of the application</param>
|
---|
75 | /// <param name="description">Description of the application</param>
|
---|
76 | /// <param name="restartOnErrors">Flag that indicates if the application should be restarted on exceptions (for services)</param>
|
---|
77 | /// </summary>
|
---|
78 | public ApplicationAttribute(string name, string description, bool restartOnErrors) {
|
---|
79 | if (name == null) throw new ArgumentNullException("name", "Application name is null.");
|
---|
80 | if (description == null) throw new ArgumentNullException("description", "Application description is null.");
|
---|
81 | this.name = name;
|
---|
82 | this.description = description;
|
---|
83 | this.restartOnErrors = restartOnErrors;
|
---|
84 | }
|
---|
85 | }
|
---|
86 | }
|
---|