Added getDocLocation() for UICommandMetadata

forge · Feb 16, 2013 · 13cb1b7 · 13cb1b7
1 parent b64e59b
commit 13cb1b7
Show file tree

Hide file tree

Showing 3 changed files with 35 additions and 24 deletions.
diff --git a/ui/api/src/main/java/org/jboss/forge/ui/UICommandMetadata.java b/ui/api/src/main/java/org/jboss/forge/ui/UICommandMetadata.java
@@ -7,6 +7,8 @@
 
 package org.jboss.forge.ui;
 
+import java.net.URL;
+
 /**
  * @author <a href="mailto:lincolnbaxter@gmail.com">Lincoln Baxter, III</a>
  */
@@ -17,4 +19,12 @@ public interface UICommandMetadata
    String getDescription();
 
    UICategory getCategory();
+
+   /**
+    * Returns the location of the documentation of this command
+    *
+    * @return null if no documentation was found
+    */
+   URL getDocLocation();
+
 }
diff --git a/ui/api/src/main/java/org/jboss/forge/ui/base/UICommandMetadataBase.java b/ui/api/src/main/java/org/jboss/forge/ui/base/UICommandMetadataBase.java
@@ -1,27 +1,39 @@
 package org.jboss.forge.ui.base;
 
+import java.net.URL;
+
 import org.jboss.forge.ui.UICategory;
 import org.jboss.forge.ui.UICommandMetadata;
 
 public class UICommandMetadataBase implements UICommandMetadata
 {
    private final String name;
    private final String description;
-   private UICategory category;
+   private final UICategory category;
+   private final URL docLocation;
 
    public UICommandMetadataBase(String name, String description)
    {
-      super();
-      this.name = name;
-      this.description = description;
+      this(name, description, null, null);
    }
 
    public UICommandMetadataBase(String name, String description, UICategory category)
+   {
+      this(name, description, category, null);
+   }
+
+   public UICommandMetadataBase(String name, String description, URL docLocation)
+   {
+      this(name, description, null, docLocation);
+   }
+
+   public UICommandMetadataBase(String name, String description, UICategory category, URL docLocation)
    {
       super();
       this.name = name;
       this.description = description;
       this.category = category;
+      this.docLocation = docLocation;
    }
 
    @Override
@@ -41,4 +53,10 @@ public UICategory getCategory()
    {
       return category;
    }
+
+   @Override
+   public URL getDocLocation()
+   {
+      return docLocation;
+   }
 }
diff --git a/ui/tests/src/test/java/org/jboss/forge/ui/MyFirstWizard.java b/ui/tests/src/test/java/org/jboss/forge/ui/MyFirstWizard.java
@@ -2,6 +2,7 @@
 
 import javax.inject.Inject;
 
+import org.jboss.forge.ui.base.UICommandMetadataBase;
 import org.jboss.forge.ui.util.Categories;
 import org.jboss.forge.ui.wizard.UIWizard;
 
@@ -38,26 +39,8 @@ public Result execute(UIContext context) throws Exception
    @Override
    public UICommandMetadata getMetadata()
    {
-      return new UICommandMetadata()
-      {
-         @Override
-         public String getName()
-         {
-            return MyFirstWizard.class.getName();
-         }
-
-         @Override
-         public String getDescription()
-         {
-            return "generic test wizard";
-         }
-
-         @Override
-         public UICategory getCategory()
-         {
-            return Categories.create("Example");
-         }
-      };
+      return new UICommandMetadataBase(MyFirstWizard.class.getName(), "generic test wizard",
+               Categories.create("Example"));
    }
 
    @Override