FORGE-2247: Introduced InputComponent.set/getNote

ui/api/src/main/java/org/jboss/forge/addon/ui/input/InputComponent.java

@@ -170,4 +170,25 @@ public interface InputComponent<IMPLTYPE, VALUETYPE> extends MutableFaceted<Hint
     * @param validator the {@link UIValidationContext} object that holds validation errors
     */
    void validate(UIValidationContext context);
+
+   /**
+    * A note is a description about the value of this input. in a GUI environment, it is displayed below the input.
+    * 
+    * @param note to be displayed below the input in GUIs
+    */
+   IMPLTYPE setNote(String note);
+
+   /**
+    * A note is a description about the value of this input. in a GUI environment, it is displayed below the input.
+    * 
+    * @param note to be displayed below the input in GUIs
+    */
+   IMPLTYPE setNote(Callable<String> note);
+
+   /**
+    * A note is a description about the value of this input. in a GUI environment, it is displayed below the input.
+    * 
+    * @return the note to be displayed below the input in GUIs
+    */
+   String getNote();
 }

ui/impl/src/main/java/org/jboss/forge/addon/ui/impl/input/AbstractInputComponent.java

@@ -49,6 +49,7 @@ public abstract class AbstractInputComponent<IMPLTYPE extends InputComponent<IMP
 
    private String label;
    private Callable<String> description;
+   private Callable<String> note;
    private Callable<Boolean> enabled = Callables.returning(Boolean.TRUE);
    private Callable<Boolean> required = Callables.returning(Boolean.FALSE);
    private Callable<String> requiredMessage;
@@ -131,7 +132,7 @@ public IMPLTYPE setDescription(String description)
       this.description = Callables.returning(description);
       return (IMPLTYPE) this;
    }
-   
+
    @Override
    public IMPLTYPE setDescription(Callable<String> description)
    {
@@ -171,7 +172,7 @@ public IMPLTYPE setRequiredMessage(String requiredMessage)
       this.requiredMessage = Callables.returning(requiredMessage);
       return (IMPLTYPE) this;
    }
-   
+
    @Override
    public IMPLTYPE setRequiredMessage(Callable<String> requiredMessage)
    {
@@ -239,6 +240,26 @@ public ValueChangeListener removeListener()
       };
    }
 
+   @Override
+   public IMPLTYPE setNote(Callable<String> note)
+   {
+      this.note = note;
+      return (IMPLTYPE) this;
+   }
+
+   @Override
+   public IMPLTYPE setNote(String note)
+   {
+      this.note = Callables.returning(note);
+      return (IMPLTYPE) this;
+   }
+
+   @Override
+   public String getNote()
+   {
+      return Callables.call(note);
+   }
+
    protected Set<ValueChangeListener> getValueChangeListeners()
    {
       return valueChangeListeners;

ui/tests/src/test/java/org/jboss/forge/addon/ui/impl/UIInputInjectionTest.java

@@ -9,6 +9,7 @@
 
 import java.util.Arrays;
 import java.util.Iterator;
+import java.util.concurrent.Callable;
 
 import javax.inject.Inject;
 
@@ -267,4 +268,23 @@ public void testNotNullValuesForUISelectComponents()
       Assert.assertFalse(unknown.getValue().iterator().hasNext());
    }
 
+   @Test
+   public void testNote()
+   {
+      // FORGE-2247
+      Assert.assertNull(firstName.getNote());
+      firstName.setNote("A Note From String Signature");
+      Assert.assertEquals("A Note From String Signature", firstName.getNote());
+      firstName.setNote((String) null);
+      Assert.assertNull(firstName.getNote());
+      firstName.setNote(new Callable<String>()
+      {
+         @Override
+         public String call() throws Exception
+         {
+            return "A Note from Callable Signature";
+         }
+      });
+      Assert.assertEquals("A Note from Callable Signature", firstName.getNote());
+   }
 }