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