improved javadoc

[svjatoslav_commons.git] / src / main / java / eu / svjatoslav / commons / commandline / parameterparser / Parameter.java

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 2e1c03a..25f406d 100755 (executable)
--- a/src/main/java/eu/svjatoslav/commons/commandline/parameterparser/Parameter.java
+++ b/src/main/java/eu/svjatoslav/commons/commandline/parameterparser/Parameter.java
@@ -1,7 +1,7 @@
 /*
  * Svjatoslav Commons - shared library of common functionality.
  * Copyright ©2012-2014, 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.
@@ -9,11 +9,9 @@
 
 package eu.svjatoslav.commons.commandline.parameterparser;
 
-import java.io.File;
 import java.util.ArrayList;
-import java.util.List;
 
-public abstract class Parameter {
+public abstract class Parameter<T> {
 
        /**
         * Indicates that at least one argument is mandatory for this parameter.
@@ -24,9 +22,9 @@ public abstract class Parameter {
 
        public final String description;
 
-       protected final ArrayList<String> arguments = new ArrayList<String>();
+       public final ArrayList<String> arguments = new ArrayList<String>();
 
-       ArgumentCount argumentCount;
+       final ArgumentCount argumentCount;
 
        /**
         * If this parameter was present in the commandline, then this boolean will
@@ -53,16 +51,19 @@ public abstract class Parameter {
                this.argumentCount = argumentCount;
        }
 
-       public Parameter addAliases(final String... aliasArray) {
+       @SuppressWarnings("unchecked")
+       public T addAliases(final String... aliasArray) {
 
                // save aliases
                for (final String alias : aliasArray)
                        aliases.add(alias);
 
-               return this;
+               return (T) this;
        }
 
        /**
+        * @param argumentString
+        *            argument to add
         * @return <code>true</code> if no errors were found. <code>false</code>
         *         otherwise.
         */
@@ -116,31 +117,6 @@ public abstract class Parameter {
                return buffer.toString();
        }
 
-       public List<File> getArgumentsAsFiles() {
-               final ArrayList<File> result = new ArrayList<File>();
-
-               for (final String argument : arguments) {
-                       final File file = new File(argument);
-                       result.add(file);
-               }
-
-               return result;
-       }
-
-       public List<Integer> getArgumentsAsIntegers() {
-               final ArrayList<Integer> result = new ArrayList<Integer>();
-
-               for (final String argument : arguments)
-                       result.add(Integer.valueOf(argument));
-
-               return result;
-       }
-
-       public List<String> getArgumentsAsStrings() {
-               final ArrayList<String> result = new ArrayList<String>(arguments);
-               return result;
-       }
-
        public String getHelp() {
                final StringBuffer buffer = new StringBuffer();
 
@@ -160,6 +136,8 @@ public abstract class Parameter {
                return buffer.toString();
        }
 
+       public abstract Object getValue();
+
        public boolean isMandatory() {
                return mandatory;
        }
@@ -172,6 +150,8 @@ public abstract class Parameter {
        }
 
        /**
+        * @param alias
+        *            alias to check against
         * @return <code>true</code> if given alias is registered for this
         *         parameter.
         */
@@ -185,7 +165,7 @@ public abstract class Parameter {
        /**
         * Notifies this parameter that no more arguments will follow. This gives
         * parameter chance to verify if this is ok.
-        * 
+        *
         * @return <code>true</code> if no errors were found. <code>false</code>
         *         otherwise.
         */
@@ -202,9 +182,10 @@ public abstract class Parameter {
                return true;
        }
 
-       public Parameter setMandatory() {
+       @SuppressWarnings("unchecked")
+       public T setMandatory() {
                mandatory = true;
-               return this;
+               return (T) this;
        }
 
        /**
@@ -216,6 +197,8 @@ public abstract class Parameter {
        }
 
        /**
+        * @param value
+        *            value to validate
         * @return <code>true</code> if value is correct, <code>false</code>
         *         otherwise.
         */