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 import eu.svjatoslav.commons.commandline.parameterparser.parameter.StringParameter;
  15
  16 /**
  17  * <pre>
  18  * Single commandline parameter can have any amount of arguments.
  19  * </pre>
  20  */
  21 public class Parser {
  22
  23         private final ArrayList<Parameter> parameters = new ArrayList<Parameter>();
  24
  25         public void addParameter(final Parameter parameter) {
  26                 parameters.add(parameter);
  27         }
  28
  29         public StringParameter createStringParameter(final String description) {
  30                 final StringParameter parameter = new StringParameter(description);
  31                 parameters.add(parameter);
  32                 return parameter;
  33         }
  34
  35         /**
  36          * Return parameter by given alias or <code>null</code> if no parameter
  37          * exists for given alias.
  38          */
  39         public Parameter getParameterByAlias(final String alias) {
  40
  41                 for (final Parameter parameter : parameters)
  42                         if (parameter.matchesAlias(alias))
  43                                 return parameter;
  44
  45                 return null;
  46         }
  47
  48         /**
  49          * @return <code>true</code> if no errors were found. <code>false</code>
  50          *         otherwise.
  51          */
  52         public boolean parse(final String[] args) {
  53
  54                 Parameter currentParameter = null;
  55
  56                 for (final String argument : args) {
  57
  58                         final Parameter parameterForAlias = getParameterByAlias(argument);
  59                         if (parameterForAlias == null) {
  60                                 if (currentParameter == null) {
  61                                         System.out.println("Unknown commandline parameter: "
  62                                                         + argument);
  63                                         return false;
  64                                 }
  65
  66                                 if (!currentParameter.addArgument(argument))
  67                                         return false;
  68
  69                         } else {
  70                                 if (currentParameter != null)
  71                                         if (!currentParameter.noMoreArguments())
  72                                                 return false;
  73
  74                                 parameterForAlias.setParameterSpecified(true);
  75                                 currentParameter = parameterForAlias;
  76                         }
  77
  78                 }
  79
  80                 // check if any mandatory parameters are missing
  81
  82                 for (final Parameter parameter : parameters)
  83                         if (parameter.isMandatory() && (!parameter.isParameterSpecified())) {
  84                                 System.out.println("Error! Mandatory parameter ("
  85                                                 + parameter.getAliases() + ") is not specified.");
  86                                 return false;
  87                         }
  88
  89                 return true;
  90         }
  91
  92         public void showHelp() {
  93                 for (final Parameter parameter : parameters)
  94                         System.out.println(parameter.getHelp());
  95         }
  96
  97 }