improved javadoc

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

diff --git a/src/main/java/eu/svjatoslav/commons/commandline/parameterparser/Parser.java b/src/main/java/eu/svjatoslav/commons/commandline/parameterparser/Parser.java
index d2f623f..7ee27a0 100755 (executable)
--- a/src/main/java/eu/svjatoslav/commons/commandline/parameterparser/Parser.java
+++ b/src/main/java/eu/svjatoslav/commons/commandline/parameterparser/Parser.java
@@ -1,10 +1,10 @@
 /*
  * Svjatoslav Commons - shared library of common functionality.
- * Copyright (C) 2012, Svjatoslav Agejenko, svjatoslav@svjatoslav.eu
- * 
+ * 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 2 of the GNU General Public License
- * as published by the Free Software Foundation.
+ * modify it under the terms of version 3 of the GNU Lesser General Public License
+ * or later as published by the Free Software Foundation.
  */
 
 package eu.svjatoslav.commons.commandline.parameterparser;
@@ -18,37 +18,59 @@ import java.util.ArrayList;
  */
 public class Parser {
 
-       private final ArrayList<Parameter> parameters = new ArrayList<Parameter>();
+       private final ArrayList<Parameter<?>> parameters = new ArrayList<Parameter<?>>();
 
-       public void addParameter(final Parameter parameter) {
+       public <E extends Parameter<?>> E add(final E parameter) {
                parameters.add(parameter);
+               return parameter;
+       }
+
+       /**
+        * @return <code>true</code> if no errors were found. <code>false</code>
+        *         otherwise.
+        */
+       private boolean checkMandatoryArgumentsPresent() {
+
+               for (final Parameter<?> parameter : parameters)
+                       if (parameter.isMandatory() && (!parameter.isParameterSpecified())) {
+                               System.out.println("Error! Mandatory parameter ("
+                                               + parameter.getAliases() + ") is not specified.");
+                               return false;
+                       }
+
+               return true;
        }
 
        /**
         * Return parameter by given alias or <code>null</code> if no parameter
         * exists for given alias.
+        *
+        * @param alias
+        *            parameter alias
+        * @return found parameter or <code>null</code> if parameter was not found.
         */
-       public Parameter getParameterByAlias(final String alias) {
+       public Parameter<?> findParameterByAlias(final String alias) {
 
-               for (final Parameter parameter : parameters) {
+               for (final Parameter<?> parameter : parameters)
                        if (parameter.matchesAlias(alias))
                                return parameter;
-               }
 
                return null;
        }
 
        /**
+        * @param args
+        *            commandline arguments
         * @return <code>true</code> if no errors were found. <code>false</code>
         *         otherwise.
         */
        public boolean parse(final String[] args) {
 
-               Parameter currentParameter = null;
+               Parameter<?> currentParameter = null;
 
                for (final String argument : args) {
 
-                       final Parameter parameterForAlias = getParameterByAlias(argument);
+                       final Parameter<?> parameterForAlias = findParameterByAlias(argument);
                        if (parameterForAlias == null) {
                                if (currentParameter == null) {
                                        System.out.println("Unknown commandline parameter: "
@@ -60,10 +82,9 @@ public class Parser {
                                        return false;
 
                        } else {
-                               if (currentParameter != null) {
+                               if (currentParameter != null)
                                        if (!currentParameter.noMoreArguments())
                                                return false;
-                               }
 
                                parameterForAlias.setParameterSpecified(true);
                                currentParameter = parameterForAlias;
@@ -71,23 +92,12 @@ public class Parser {
 
                }
 
-               // check if any mandatory parameters are missing
-
-               for (final Parameter parameter : parameters) {
-                       if (parameter.isMandatory() && (!parameter.isParameterSpecified())) {
-                               System.out.println("Error! Mandatory parameter ("
-                                               + parameter.getAliases() + ") is not specified.");
-                               return false;
-                       }
-               }
-
-               return true;
+               return checkMandatoryArgumentsPresent();
        }
 
        public void showHelp() {
-               for (final Parameter parameter : parameters) {
+               for (final Parameter<?> parameter : parameters)
                        System.out.println(parameter.getHelp());
-               }
        }
 
 }