Update sample.

Author: zhhe-me

README.md

@@ -1,14 +1,14 @@
 # java-cli-menu
-An clean, interactive command line parser/menu for Java CLI.
+An concise, interactive and versatile command line parser/menu for Java CLI.
 
-Idealy, a Java CLI based app can be trigger by ```java -cp <class> <params>```. But sometimes, a menu based configuration is useful and convinient. The interaction looks like:
+Idealy, a Java CLI based app can be trigger by ```java -cp <class> <params>```. But sometimes, a menu based configuration is more useful and convinient. The interaction looks like:
 
-```shell 1) --grammar,-g Grammar [Csv]           specify grammar name            It should be same with file name of your .g4   2) --startRule,-r  [token]           start rule name. &quot;token&quot; is a special value.   --  R): refresh menu;  X): exit   Your input [# value]: 1 some wrong values   &gt;! Bad
+```sh
  Wrong arguments:
    -g: [Invalid_value]
        Only 'Csv' is acceptable!
  1) -g,--grammar []: Grammar name
- 2) -,--startRule [token]: Start rule of this parser
+ 2) -,--startRule [token]: Start rule
 
  --
  R): refresh menu;  X): exit
@@ -20,7 +20,7 @@ Your input [# value]: 1 Http
 Your input [# value]: 1 Csv
 Your input [# value]: R
  1) -g,--grammar [Csv]: Grammar name
- 2) -,--startRule [token]: Start rule of this parser
+ 2) -,--startRule [token]: Start rule
 
  --
  R): refresh menu;  X): exit
@@ -32,13 +32,60 @@ Back to main, let's continue.
 
 Just try to run 
 
-- [BeanBuilderSample.java](https://github.com/zhhe-me/java-cli-menu/blob/master/src/test/java/me/zhhe/cli/menu/sample/BeanBuilderSample.java)  (extract argument defintion via naming convention or Java Bean)
-- [BasicBuilderSample.java](https://github.com/zhhe-me/java-cli-menu/blob/master/src/test/java/me/zhhe/cli/menu/sample/BasicBuilderSample.java) (set up argument definition via code)
+- [BeanBuilderWithAnnotationSample.java](https://github.com/zhhe-me/java-cli-menu/blob/master/src/test/java/me/zhhe/cli/menu/sample/BeanBuilderWithAnnotationSample.java)  (extract argument defintion via annotation + naming convention or Java Bean) **Recommanded**
+- [BeanBuilderSample.java](https://github.com/zhhe-me/java-cli-menu/blob/master/src/test/java/me/zhhe/cli/menu/sample/BeanBuilderSample.java)  (extract argument defintion via naming convention or Java Bean) **No configuration**
+- [BasicBuilderSample.java](https://github.com/zhhe-me/java-cli-menu/blob/master/src/test/java/me/zhhe/cli/menu/sample/BasicBuilderSample.java) (set up argument definition via code) **Everything in your control**
 - [ChainedBuilderSample.java](https://github.com/zhhe-me/java-cli-menu/blob/master/src/test/java/me/zhhe/cli/menu/sample/ChainedBuilderSample.java) (set up argument via chained/multiple builders)
 
 with input above.
 
-This project is on the way and changes will happen any time without notification until it gets GA.
+Here is code from BeanBuilderWithAnnotationSample.java:
+
+```java
+public class BeanBuilderWithAnnotationSample {
+
+    // Annotation can help supply extra info, like arg name, description
+    @Option(name = "g", description = "Grammar name")
+    private String grammar;
+
+    // use field name when neither name nor longArgName is specified.
+    @Option(description = "Start rule")
+    private String startRule;
+
+    // matched by naming convention
+    public void setGrammar(final String value) {
+        if (!"Csv".equals(value))
+            throw new IllegalArgumentException("Only 'Csv' is acceptable!");
+        grammar = value;
+    }
+
+    // ignored due to setStartRule2
+    public void setStartRule(final String value) {
+        startRule = value;
+    }
+
+    // Annotation is preferred to reflection/naming convention
+    @Setter("startRule")
+    public void setStartRule2(final String value) {
+        startRule = "2-" + value;
+    }
+
+    public static void main(final String... args) {
+        final BeanBuilderWithAnnotationSample sample = new BeanBuilderWithAnnotationSample();
+        // mock arguments
+        final String[] mockedArgs = {"-g", "Invalid_value", "--startRule", "token"};
+
+        new BeanMenuBuilder().bean(sample).build(mockedArgs).render();
+
+        // continue your business after all setting is done.
+        System.out.println("\nBack to main, let's continue.");
+    }
+}
+```
+
+
+
+_This project is on the way and changes will happen any time without notification until it gets GA._
 
 **Here is flow Java CLI Menu likes to support:**
 

src/test/java/me/zhhe/cli/menu/sample/BeanBuilderSample.java

@@ -22,28 +22,30 @@
  */
 public class BeanBuilderSample {
 
+    // use field name as long arg name
     private String grammar;
     private String startRule;
 
-    public static void main(final String... args) {
-        final BeanBuilderSample sample = new BeanBuilderSample();
-        // mock arguments
-        final String[] mockedArgs = {"--grammar", "Invalid_value", "--startRule", "token"};
-
-        new BeanMenuBuilder().bean(sample).build(mockedArgs).render();
-
-        System.out.println("\nBack to main, let's continue.");
-    }
-
-
+    // matched by naming convention
     public void setGrammar(final String value) {
         if (!"Csv".equals(value))
             throw new IllegalArgumentException("Only 'Csv' is acceptable!");
-
         grammar = value;
     }
 
+    // matched by naming convention
     public void setStartRule(final String value) {
         startRule = value;
     }
+
+    public static void main(final String... args) {
+        final BeanBuilderSample sample = new BeanBuilderSample();
+        // mock arguments
+        final String[] mockedArgs = {"--grammar", "Invalid_value", "--startRule", "token"};
+
+        new BeanMenuBuilder().bean(sample).build(mockedArgs).render();
+
+        // continue your business after all setting is done.
+        System.out.println("\nBack to main, let's continue.");
+    }
 }

src/test/java/me/zhhe/cli/menu/sample/BeanBuilderWithAnnotationSample.java

@@ -24,32 +24,22 @@
  */
 public class BeanBuilderWithAnnotationSample {
 
+    // Annotation can help supply extra info, like arg name, description
     @Option(name = "g", description = "Grammar name")
     private String grammar;
 
     // use field name when neither name nor longArgName is specified.
     @Option(description = "Start rule")
     private String startRule;
 
-    public static void main(final String... args) {
-        final BeanBuilderWithAnnotationSample sample = new BeanBuilderWithAnnotationSample();
-        // mock arguments
-        final String[] mockedArgs = {"-g", "Invalid_value", "--startRule", "token"};
-
-        new BeanMenuBuilder().bean(sample).build(mockedArgs).render();
-
-        System.out.println("\nBack to main, let's continue.");
-    }
-
-
+    // matched by naming convention
     public void setGrammar(final String value) {
         if (!"Csv".equals(value))
             throw new IllegalArgumentException("Only 'Csv' is acceptable!");
-
         grammar = value;
     }
 
-
+    // ignored due to setStartRule2
     public void setStartRule(final String value) {
         startRule = value;
     }
@@ -59,4 +49,16 @@ public void setStartRule(final String value) {
     public void setStartRule2(final String value) {
         startRule = "2-" + value;
     }
+
+    public static void main(final String... args) {
+        final BeanBuilderWithAnnotationSample sample = new BeanBuilderWithAnnotationSample();
+        // mock arguments
+        final String[] mockedArgs = {"-g", "Invalid_value", "--startRule", "token"};
+
+        new BeanMenuBuilder().bean(sample).build(mockedArgs).render();
+
+        // continue your business after all setting is done.
+        System.out.println("\nBack to main, let's continue.");
+
+    }
 }