From 7f293874f048f61548604f63d8351d410b09cf2c Mon Sep 17 00:00:00 2001
From: Ziver Koc <ziver@koc.se>
Date: Sat, 5 Dec 2020 00:06:02 +0100
Subject: [PATCH] Added description parameter to plugins

---
 src/zutil/plugin/PluginData.java     | 12 ++++++++++--
 src/zutil/plugin/plugin.json.example |  3 ++-
 2 files changed, 12 insertions(+), 3 deletions(-)

diff --git a/src/zutil/plugin/PluginData.java b/src/zutil/plugin/PluginData.java
index 16c221f..20ab139 100755
--- a/src/zutil/plugin/PluginData.java
+++ b/src/zutil/plugin/PluginData.java
@@ -40,8 +40,9 @@ import java.util.logging.Logger;
 public class PluginData {
     private static Logger log = LogUtil.getLogger();
 
-    private double pluginVersion;
-    private String pluginName;
+    private final double pluginVersion;
+    private final String pluginName;
+    private final String pluginDescription;
     private boolean enabled = true;
     private HashMap<Class<?>, List<Class<?>>>  classMap;
     private HashMap<Class, Object> objectMap;
@@ -53,6 +54,7 @@ public class PluginData {
 
         pluginVersion = data.getDouble("version");
         pluginName = data.getString("name");
+        pluginDescription = data.getString("description");
         log.fine("Plugin: " + this);
 
         DataNode node = data.get("interfaces");
@@ -109,6 +111,12 @@ public class PluginData {
     public String getName(){
         return pluginName;
     }
+    /**
+     * @return the name of the plugin
+     */
+    public String getDescription(){
+        return pluginDescription;
+    }
     /**
      * @return if this plugin is enabled
      */
diff --git a/src/zutil/plugin/plugin.json.example b/src/zutil/plugin/plugin.json.example
index e783b42..ad8f34c 100644
--- a/src/zutil/plugin/plugin.json.example
+++ b/src/zutil/plugin/plugin.json.example
@@ -1,6 +1,7 @@
 {
     "version": 1.0,
-    "name": "Nice name of Plugin",
+    "name": "Nice Plugin Name",
+    "description": "This is a example plugin description",
     "interfaces": [
         {"plugin.interface.class": "plugin.implementation.class"},
         {"wa.server.plugin.WAFrontend": "wa.server.plugin.apache.ApacheFrontend"}