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

   1 /*
   2  * Svjatoslav Commons - shared library of common functionality.
   3  * Copyright ©2012-2013, 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 2 of the GNU General Public License
   7  * 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 void addParameter(final Parameter parameter) {
  24                 parameters.add(parameter);
  25         }
  26
  27         /**
  28          * Return parameter by given alias or <code>null</code> if no parameter
  29          * exists for given alias.
  30          */
  31         public Parameter getParameterByAlias(final String alias) {
  32
  33                 for (final Parameter parameter : parameters)
  34                         if (parameter.matchesAlias(alias))
  35                                 return parameter;
  36
  37                 return null;
  38         }
  39
  40         /**
  41          * @return <code>true</code> if no errors were found. <code>false</code>
  42          *         otherwise.
  43          */
  44         public boolean parse(final String[] args) {
  45
  46                 Parameter currentParameter = null;
  47
  48                 for (final String argument : args) {
  49
  50                         final Parameter parameterForAlias = getParameterByAlias(argument);
  51                         if (parameterForAlias == null) {
  52                                 if (currentParameter == null) {
  53                                         System.out.println("Unknown commandline parameter: "
  54                                                         + argument);
  55                                         return false;
  56                                 }
  57
  58                                 if (!currentParameter.addArgument(argument))
  59                                         return false;
  60
  61                         } else {
  62                                 if (currentParameter != null)
  63                                         if (!currentParameter.noMoreArguments())
  64                                                 return false;
  65
  66                                 parameterForAlias.setParameterSpecified(true);
  67                                 currentParameter = parameterForAlias;
  68                         }
  69
  70                 }
  71
  72                 // check if any mandatory parameters are missing
  73
  74                 for (final Parameter parameter : parameters)
  75                         if (parameter.isMandatory() && (!parameter.isParameterSpecified())) {
  76                                 System.out.println("Error! Mandatory parameter ("
  77                                                 + parameter.getAliases() + ") is not specified.");
  78                                 return false;
  79                         }
  80
  81                 return true;
  82         }
  83
  84         public void showHelp() {
  85                 for (final Parameter parameter : parameters)
  86                         System.out.println(parameter.getHelp());
  87         }
  88
  89 }