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         public Parameter findParameterByAlias(final String alias) {
  49
  50                 for (final Parameter parameter : parameters)
  51                         if (parameter.matchesAlias(alias))
  52                                 return parameter;
  53
  54                 return null;
  55         }
  56
  57         /**
  58          * @return <code>true</code> if no errors were found. <code>false</code>
  59          *         otherwise.
  60          */
  61         public boolean parse(final String[] args) {
  62
  63                 Parameter currentParameter = null;
  64
  65                 for (final String argument : args) {
  66
  67                         final Parameter parameterForAlias = findParameterByAlias(argument);
  68                         if (parameterForAlias == null) {
  69                                 if (currentParameter == null) {
  70                                         System.out.println("Unknown commandline parameter: "
  71                                                         + argument);
  72                                         return false;
  73                                 }
  74
  75                                 if (!currentParameter.addArgument(argument))
  76                                         return false;
  77
  78                         } else {
  79                                 if (currentParameter != null)
  80                                         if (!currentParameter.noMoreArguments())
  81                                                 return false;
  82
  83                                 parameterForAlias.setParameterSpecified(true);
  84                                 currentParameter = parameterForAlias;
  85                         }
  86
  87                 }
  88
  89                 return checkMandatoryArgumentsPresent();
  90         }
  91
  92         public void showHelp() {
  93                 for (final Parameter parameter : parameters)
  94                         System.out.println(parameter.getHelp());
  95         }
  96
  97 }