X-Git-Url: http://www2.svjatoslav.eu/gitweb/?a=blobdiff_plain;f=src%2Fmain%2Fjava%2Feu%2Fsvjatoslav%2Fcommons%2Fcommandline%2Fparameterparser%2FParameter.java;h=c9023a4053a5895546b2fc9aec63a8f48182208a;hb=b91077678c2a0af17a2f852c0b3901813837117a;hp=6e29ba66663cf541a76efe5da7f48122f0381853;hpb=6846681d727a07385bcd3e0eb856f70a7e96448c;p=svjatoslav_commons.git

diff --git a/src/main/java/eu/svjatoslav/commons/commandline/parameterparser/Parameter.java b/src/main/java/eu/svjatoslav/commons/commandline/parameterparser/Parameter.java
index 6e29ba6..c9023a4 100755
--- a/src/main/java/eu/svjatoslav/commons/commandline/parameterparser/Parameter.java
+++ b/src/main/java/eu/svjatoslav/commons/commandline/parameterparser/Parameter.java
@@ -1,23 +1,25 @@
 /*
- * Svjatoslav Commons - shared library of common functionality.
- * Copyright ©2012-2017, Svjatoslav Agejenko, svjatoslav@svjatoslav.eu
- *
- * This program is free software; you can redistribute it and/or
- * modify it under the terms of version 3 of the GNU Lesser General Public License
- * or later as published by the Free Software Foundation.
+ * Svjatoslav Commons - shared library of common functionality. Author: Svjatoslav Agejenko.
+ * This project is released under Creative Commons Zero (CC0) license.
  */
-
 package eu.svjatoslav.commons.commandline.parameterparser;
 
 import java.util.ArrayList;
 import java.util.Collections;
+import java.util.List;
 
-public abstract class Parameter<T> {
+public abstract class Parameter<T, I extends Parameter> {
 
+    /**
+     * Purpose of this argument, like: input image path, compression level, etc...
+     *
+     * Note: for describing argument type (file, integer, ...) there is {@link #describeFormat()}.
+     */
     public final String description;
-    public final ArrayList<String> arguments = new ArrayList<>();
+
+    public final List<String> arguments = new ArrayList<>();
     final ArgumentCount argumentCount;
-    private final ArrayList<String> aliases = new ArrayList<>();
+    private final List<String> aliases = new ArrayList<>();
     /**
      * Indicates that at least one argument is mandatory for this parameter.
      */
@@ -26,7 +28,7 @@ public abstract class Parameter<T> {
      * If this parameter was present in the commandline, then this boolean will
      * be set to <code>true</code>.
      */
-    private boolean parameterSpecified;
+    private boolean specified;
 
     public Parameter(final boolean mandatory,
                      final ArgumentCount argumentCount, final String description,
@@ -47,12 +49,12 @@ public abstract class Parameter<T> {
     }
 
     @SuppressWarnings("unchecked")
-    public T addAliases(final String... aliasArray) {
+    public I addAliases(final String... aliasArray) {
 
         // save aliases
         Collections.addAll(aliases, aliasArray);
 
-        return (T) this;
+        return (I) this;
     }
 
     /**
@@ -92,7 +94,10 @@ public abstract class Parameter<T> {
     }
 
     /**
-     * @return Single line argument type description.
+     * @return Single line argument type description. If argument type should be file,
+     * date, integer, regular expression, etc..
+     *
+     * Note: for argument purpose description there is {@link #description}
      */
     public abstract String describeFormat();
 
@@ -116,7 +121,11 @@ public abstract class Parameter<T> {
         // first line
         buffer.append(getAliases());
         if (!argumentCount.equals(ArgumentCount.NONE)) {
-            buffer.append(" (" + describeFormat() + ")");
+            buffer
+                    .append(" (")
+                    .append(isMandatory() ? "mandatory, " : "")
+                    .append(describeFormat())
+                    .append(")");
 
             if (argumentCount.equals(ArgumentCount.MULTI))
                 buffer.append("...");
@@ -129,7 +138,7 @@ public abstract class Parameter<T> {
         return buffer.toString();
     }
 
-    public abstract Object getValue();
+    public abstract T getValue();
 
     public boolean isMandatory() {
         return mandatory;
@@ -138,15 +147,15 @@ public abstract class Parameter<T> {
     /**
      * @return the parameterSpecified
      */
-    public boolean isParameterSpecified() {
-        return parameterSpecified;
+    public boolean isSpecified() {
+        return specified;
     }
 
     /**
-     * @param parameterSpecified the parameterSpecified to set
+     * @param specified the parameterSpecified to set
      */
-    public void setParameterSpecified(final boolean parameterSpecified) {
-        this.parameterSpecified = parameterSpecified;
+    protected void setSpecified(final boolean specified) {
+        this.specified = specified;
     }
 
     /**
@@ -180,9 +189,9 @@ public abstract class Parameter<T> {
     }
 
     @SuppressWarnings("unchecked")
-    public T setMandatory() {
+    public I setMandatory() {
         mandatory = true;
-        return (T) this;
+        return (I) this;
     }
 
     /**