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