Changeset 2504 for branches/PluginInfrastructure Refactoring/HeuristicLab.PluginInfrastructure/Attributes

Timestamp:

11/18/09 18:33:30 (15 years ago)

Author:

gkronber

Message:

Worked on core of plugin infrastructure.

• Collected all classes into a single assembly (HL.PluginInfrastructure)
• Moved SplashScreen and MainForm from HeuristicLab.exe project into the plugin infrastructure.
• Introduced namespaces
• Added strict access modifiers (internal)
• Fixed most FxCop warnings in plugin infrastructure core.
• Fixed issues with plugin load/unload events
• Deleted empty interface IControl

#799

Location:

branches/PluginInfrastructure Refactoring/HeuristicLab.PluginInfrastructure/Attributes

Files:

• ApplicationAttribute.cs (modified) (4 diffs)
• AssemblyBuildDateAttribute.cs (modified) (2 diffs)
• PluginAttribute.cs (modified) (2 diffs)
• PluginDependencyAttribute.cs (modified) (2 diffs)
• PluginFileAttribute.cs (modified) (2 diffs)

branches/PluginInfrastructure Refactoring/HeuristicLab.PluginInfrastructure/Attributes/ApplicationAttribute.cs

@@ -27 +27 @@
   /// <summary>
   /// This attribute can be used to specify meta data for applications. 
-  /// For example to specify name, version and description of applications.
+  /// For example to specify name and description of applications.
   /// </summary>
   [AttributeUsage(AttributeTargets.Class)]
-  public class ApplicationAttribute : System.Attribute {
+  public sealed class ApplicationAttribute : System.Attribute {
     private string name;
     /// <summary>
-    /// Gets or sets the name of the application.
+    /// Gets the name of the application.
     /// </summary>
     public string Name {
       get { return name; }
-      set { name = value; }
     }
-
-    //private string version;
-    ///// <summary>
-    ///// Gets or sets the version of the application.
-    ///// </summary>
-    //public string Version {
-    //  get { return version; }
-    //  set { version = value; }
-    //}
 
     private string description;
     /// <summary>
-    /// Gets or sets the description of the application.
+    /// Gets the description of the application.
     /// </summary>
     public string Description {
       get { return description; }
-      set { description = value; }
     }
 
     private bool restartOnErrors;
     /// <summary>
-    /// Gets or sets the boolean flag whether the plugin should be automatically restarted when it is closed because of an exception (for services).
+    /// Gets whether the plugin should be automatically restarted when it is closed because of an exception (for services).
     /// </summary>
     public bool RestartOnErrors {
       get { return restartOnErrors; }
-      set { restartOnErrors = value; }
     }
 
@@ -72 +60 @@
     /// </summary>
     public ApplicationAttribute(string name)
-      : this(name, "") {
+      : this(name, String.Empty) {
     }
 
@@ -84 +72 @@
     }
 
-    ///// <summary>
-    ///// Initializes a new instance of <see cref="ApplicationAttribute"/>.
-    ///// <param name="name">Name of the application</param>
-    ///// <param name="description">Description of the application</param>
-    ///// <param name="version">Version string of the application</param>
-    ///// </summary>
-    //public ApplicationAttribute(string name, string description, string version)
-    //  : this(name, description, version, false) {
-    //}
-
     /// <summary>
     /// Initializes a new instance of <see cref="ApplicationAttribute"/>.
@@ -102 +80 @@
     /// </summary>
     public ApplicationAttribute(string name, string description, bool restartOnErrors) {
+      if (name == null) throw new ArgumentNullException("name", "Application name is null.");
+      if (description == null) throw new ArgumentNullException("description", "Application description is null.");
       this.name = name;
       this.description = description;

branches/PluginInfrastructure Refactoring/HeuristicLab.PluginInfrastructure/Attributes/AssemblyBuildDateAttribute.cs

@@ -30 +30 @@
   /// </summary>
   [AttributeUsage(AttributeTargets.Assembly, AllowMultiple = false)]
-  public class AssemblyBuildDateAttribute : Attribute {
+  public sealed class AssemblyBuildDateAttribute : Attribute {
     private DateTime buildDate;
     /// <summary>
-    /// Gets or sets the build date.
+    /// Gets the build date.
     /// </summary>
     public DateTime BuildDate {
       get { return buildDate; }
-      set { buildDate = value; }
     }
+
     /// <summary>
     /// Initializes a new instance of <see cref="AssemblyBuildDateAttribute"/> with the given 
@@ -44 +44 @@
     /// </summary>
     /// <exception cref="FormatException">Thrown when the time stamp could not be parsed as build date.</exception>
-    /// <param name="timeStamp">The build date of the assembly.</param>
-    public AssemblyBuildDateAttribute(string timeStamp)
+    /// <param name="buildDate">The build date of the assembly.</param>
+    public AssemblyBuildDateAttribute(string buildDate)
       : base() {
-
-      if(!DateTime.TryParse(timeStamp, out buildDate)) {
-        throw new FormatException("Can't parse AssemblyBuildDate " + timeStamp);
+      if (!DateTime.TryParse(buildDate, out this.buildDate)) {
+        throw new FormatException("Can't parse AssemblyBuildDate " + buildDate);
       }
     }

branches/PluginInfrastructure Refactoring/HeuristicLab.PluginInfrastructure/Attributes/PluginAttribute.cs

@@ -27 +27 @@
   /// <summary>
   /// This attribute can be used to specify meta data for plugins. 
-  /// For example to specify name, version and description of plugins.
+  /// For example to specify name and description of plugins.
   /// </summary>
   [AttributeUsage(AttributeTargets.Class)]
-  public class PluginAttribute : System.Attribute {
+  public sealed class PluginAttribute : System.Attribute {
     private string name;
     /// <summary>
-    /// Gets or sets the name of the plugin.
+    /// Gets the name of the plugin.
     /// </summary>
     public string Name {
       get { return name; }
-      // set { name = value; }
     }
-
-    //private string version;
-    ///// <summary>
-    ///// Gets or sets the version of the plugin.
-    ///// </summary>
-    //public string Version {
-    //  get { return version; }
-    //  set { version = value; }
-    //}
 
     private string description;
     /// <summary>
-    /// Gets or sets the description of the plugin.
+    /// Gets the description of the plugin.
     /// </summary>
     public string Description {
       get { return description; }
-      // set { description = value; }
     }
 
@@ -75 +64 @@
       this.description = description;
     }
-
-    ///// <summary>
-    ///// Initializes a new instance of <see cref="PluginDescriptionAttribute"/>.
-    ///// <param name="name">Name of the plugin</param>
-    ///// <param name="description">Description of the plugin</param>
-    ///// <param name="version">Version string of the plugin</param>
-    ///// </summary>
-    //public PluginDescriptionAttribute(string name, string description, string version) {
-    //  this.name = name;
-    //  this.version = version;
-    //  this.description = description;
-    //}
   }
 }

branches/PluginInfrastructure Refactoring/HeuristicLab.PluginInfrastructure/Attributes/PluginDependencyAttribute.cs

@@ -33 +33 @@
 
     /// <summary>
-    /// Gets or sets the name of the plugin that is needed to load a plugin.
+    /// Gets the name of the plugin that is needed to load a plugin.
     /// </summary>
     public string Dependency {
       get { return dependency; }
-      // set { dependency = value; }
     }
 
@@ -45 +44 @@
     /// </summary>
     public PluginDependencyAttribute(string dependency) {
+      if (string.IsNullOrEmpty(dependency)) throw new ArgumentException("Dependency is null or empty.", "dependency");
       this.dependency = dependency;
     }

branches/PluginInfrastructure Refactoring/HeuristicLab.PluginInfrastructure/Attributes/PluginFileAttribute.cs

@@ -23 +23 @@
 using System.Collections.Generic;
 using System.Text;
+using System.IO;
 
 namespace HeuristicLab.PluginInfrastructure {
@@ -40 +41 @@
   /// </summary>
   [AttributeUsage(AttributeTargets.Class, AllowMultiple = true)]
-  public class PluginFileAttribute : System.Attribute {
-    private string filename;
+  public sealed class PluginFileAttribute : System.Attribute {
+    private string fileName;
 
     /// <summary>
-    /// Gets or sets the filename of the plugin.
+    /// Gets the file name of the plugin.
     /// </summary>
-    public string Filename {
-      get { return filename; }
-      //set { filename = value; }
+    public string FileName {
+      get { return fileName; }
     }
 
-    private PluginFileType filetype = PluginFileType.Data;
+    private PluginFileType fileType = PluginFileType.Data;
 
     /// <summary>
-    /// Gets or sets the filetype of the plugin file.
+    /// Gets the file type of the plugin file.
     /// </summary>
-    public PluginFileType Filetype {
-      get { return filetype; }
-      //set { filetype = value; }
+    public PluginFileType FileType {
+      get { return fileType; }
     }
 
     /// <summary>
     /// Initializes a new instance of <see cref="PluginFileAttribute"/>.
-    /// <param name="filename">Name of the file</param>
-    /// <param name="type">Type of the file (Assembly, Executable, Data, License)</param>
+    /// <param name="fileName">Name of the file</param>
+    /// <param name="fileType">Type of the file (Assembly, NativeDll, Data, License)</param>
     /// </summary>
-    public PluginFileAttribute(string filename, PluginFileType type) {
-      this.filename = filename;
-      this.filetype = type;
+    public PluginFileAttribute(string fileName, PluginFileType fileType) {
+      if (string.IsNullOrEmpty(fileName)) throw new ArgumentException("File name is empty.", "fileName");
+      // NB: doesn't check if the file actually exists
+      this.fileName = fileName;
+      this.fileType = fileType;
     }
   }