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

Timestamp:

11/10/09 16:52:52 (15 years ago)

Author:

gkronber

Message:

worked on plugin infrastructure refactoring. #799

Location:

branches/PluginInfrastructure Refactoring/HeuristicLab.PluginInfrastructure/Attributes

Files:

• . (added)
• ApplicationDescriptionAttribute.cs (added)
• AssemblyBuildDateAttribute.cs (moved) (moved from branches/PluginInfrastructure Refactoring/HeuristicLab.PluginInfrastructure/AssemblyBuildDateAttribute.cs) (2 diffs)
• PluginDependencyAttribute.cs (moved) (moved from branches/PluginInfrastructure Refactoring/HeuristicLab.PluginInfrastructure/DependencyAttribute.cs) (2 diffs)
• PluginDescriptionAttribute.cs (moved) (moved from branches/PluginInfrastructure Refactoring/HeuristicLab.PluginInfrastructure/ClassInfoAttribute.cs) (2 diffs)
• PluginFileAttribute.cs (moved) (moved from branches/PluginInfrastructure Refactoring/HeuristicLab.PluginInfrastructure/PluginFileAttribute.cs) (2 diffs)

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

@@ -27 +27 @@
 namespace HeuristicLab.PluginInfrastructure {
   /// <summary>
-  /// Attribute of an assembly when it was built.
+  /// Build date attribute. Allows to declare the build date of assemblies.
   /// </summary>
   [AttributeUsage(AttributeTargets.Assembly, AllowMultiple = false)]
@@ -33 +33 @@
     private DateTime buildDate;
     /// <summary>
-    /// Gets or sets the date when the assembly has been built.
+    /// Gets or sets the build date.
     /// </summary>
     public DateTime BuildDate {

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

@@ -26 +26 @@
 namespace HeuristicLab.PluginInfrastructure {
   /// <summary>
-  /// This attribute can be used to specify that an assembly depends on a different plugin.
+  /// This attribute can be used to declare that an plugin depends on a another plugin.
   /// </summary>
-  [AttributeUsage(AttributeTargets.Class,AllowMultiple=true)]
-  public sealed class DependencyAttribute : System.Attribute {
+  [AttributeUsage(AttributeTargets.Class, AllowMultiple = true)]
+  public sealed class PluginDependencyAttribute : System.Attribute {
     private string dependency;
 
     /// <summary>
-    /// Gets or sets the name of the plugin that is needed to load the assembly.
+    /// Gets or sets the name of the plugin that is needed to load a plugin.
     /// </summary>
     public string Dependency {
@@ -41 +41 @@
 
     /// <summary>
-    /// Initializes a new instance of <see cref="DependencyAttribute"/>.
+    /// Initializes a new instance of <see cref="PluginDependencyAttribute"/>.
+    /// <param name="dependency">The name of the plugin that is needed to load a plugin.</param>
     /// </summary>
-    public DependencyAttribute() {
+    public PluginDependencyAttribute(string dependency) {
+      this.dependency = dependency;
     }
   }

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

@@ -26 +26 @@
 namespace HeuristicLab.PluginInfrastructure {
   /// <summary>
-  /// This attribute can be used to specify meta data for classes. 
-  /// For example to specify name, version and description of applications or plugins.
+  /// This attribute can be used to specify meta data for plugins. 
+  /// For example to specify name, version and description of plugins.
   /// </summary>
   [AttributeUsage(AttributeTargets.Class)]
-  public class ClassInfoAttribute : System.Attribute {
+  public class PluginDescriptionAttribute : System.Attribute {
     private string name;
     /// <summary>
-    /// Gets or sets the name of the plugin to which the assembly belongs to.
+    /// Gets or sets the name of the plugin.
     /// </summary>
     public string Name {
@@ -58 +58 @@
     }
 
-    private bool autoRestart;
     /// <summary>
-    /// Gets or sets the boolean flag whether the plugin should be automatically restarted.
+    /// Initializes a new instance of <see cref="PluginDescriptionAttribute"/>.
+    /// <param name="name">Name of the plugin</param>
     /// </summary>
-    public bool AutoRestart {
-      get { return autoRestart; }
-      set { autoRestart = value; }
+    public PluginDescriptionAttribute(string name)
+      : this(name, "") {
     }
 
     /// <summary>
-    /// Initializes a new instance of <see cref="ClassInfoAttribute"/>.
+    /// Initializes a new instance of <see cref="PluginDescriptionAttribute"/>.
+    /// <param name="name">Name of the plugin</param>
+    /// <param name="description">Description of the plugin</param>
     /// </summary>
-    public ClassInfoAttribute() {}
+    public PluginDescriptionAttribute(string name, string description)
+      : this(name, 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/PluginFileAttribute.cs

@@ -36 +36 @@
 
   /// <summary>
-  /// Attribute for plugins providing information about their corresponding files.
+  /// PluginFileAttribute can be used to declare which files make up an plugin.
+  /// Multiple files can be associated to an plugin. Each file should be associated to only one plugin.
   /// </summary>
-  [AttributeUsage(AttributeTargets.Class, AllowMultiple=true)]
+  [AttributeUsage(AttributeTargets.Class, AllowMultiple = true)]
   public class PluginFileAttribute : System.Attribute {
     private string filename;
@@ -62 +63 @@
     /// <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>
     /// </summary>
-    public PluginFileAttribute() { }
+    public PluginFileAttribute(string filename, PluginFileType type) {
+      this.filename = filename;
+      this.filetype = type;
+    }
   }
 }