src/main/java/eu/svjatoslav/commons/commandline/parameterparser/Parser.java

   1 /*
   2  * Svjatoslav Commons - shared library of common functionality.
   3  * Copyright ©2012-2014, Svjatoslav Agejenko, svjatoslav@svjatoslav.eu
   4  *
   5  * This program is free software; you can redistribute it and/or
   6  * modify it under the terms of version 3 of the GNU Lesser General Public License
   7  * or later as published by the Free Software Foundation.
   8  */
   9
  10 package eu.svjatoslav.commons.commandline.parameterparser;
  11
  12 import java.util.ArrayList;
  13
  14 /**
  15  * <pre>
  16  * Single commandline parameter can have any amount of arguments.
  17  * </pre>
  18  */
  19 public class Parser {
  20
  21         private final ArrayList<Parameter<?>> parameters = new ArrayList<Parameter<?>>();
  22
  23         public <E extends Parameter<?>> E add(final E parameter) {
  24                 parameters.add(parameter);
  25                 return parameter;
  26         }
  27
  28         /**
  29          * @return <code>true</code> if no errors were found. <code>false</code>
  30          *         otherwise.
  31          */
  32         private boolean checkMandatoryArgumentsPresent() {
  33
  34                 for (final Parameter<?> parameter : parameters)
  35                         if (parameter.isMandatory() && (!parameter.isParameterSpecified())) {
  36                                 System.out.println("Error! Mandatory parameter ("
  37                                                 + parameter.getAliases() + ") is not specified.");
  38                                 return false;
  39                         }
  40
  41                 return true;
  42         }
  43
  44         /**
  45          * Return parameter by given alias or <code>null</code> if no parameter
  46          * exists for given alias.
  47          *
  48          * @param alias
  49          *            parameter alias
  50          * @return found parameter or <code>null</code> if parameter was not found.
  51          */
  52         public Parameter<?> findParameterByAlias(final String alias) {
  53
  54                 for (final Parameter<?> parameter : parameters)
  55                         if (parameter.matchesAlias(alias))
  56                                 return parameter;
  57
  58                 return null;
  59         }
  60
  61         /**
  62          * @param args
  63          *            commandline arguments
  64          * @return <code>true</code> if no errors were found. <code>false</code>
  65          *         otherwise.
  66          */
  67         public boolean parse(final String[] args) {
  68
  69                 Parameter<?> currentParameter = null;
  70
  71                 for (final String argument : args) {
  72
  73                         final Parameter<?> parameterForAlias = findParameterByAlias(argument);
  74                         if (parameterForAlias == null) {
  75                                 if (currentParameter == null) {
  76                                         System.out.println("Unknown commandline parameter: "
  77                                                         + argument);
  78                                         return false;
  79                                 }
  80
  81                                 if (!currentParameter.addArgument(argument))
  82                                         return false;
  83
  84                         } else {
  85                                 if (currentParameter != null)
  86                                         if (!currentParameter.noMoreArguments())
  87                                                 return false;
  88
  89                                 parameterForAlias.setParameterSpecified(true);
  90                                 currentParameter = parameterForAlias;
  91                         }
  92
  93                 }
  94
  95                 return checkMandatoryArgumentsPresent();
  96         }
  97
  98         public void showHelp() {
  99                 for (final Parameter<?> parameter : parameters)
 100                         System.out.println(parameter.getHelp());
 101         }
 102
 103 }