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.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 Parameter createCustomParameter(final Argument paramaterType,
  34                         final String description) {
  35                 final Parameter parameter = new Parameter(paramaterType, description,
  36                                 ArgumentCount.SINGLE);
  37                 parameters.add(parameter);
  38                 return parameter;
  39         }
  40
  41         public DirectoryParameter createDirectoryParameter(final String description) {
  42                 final DirectoryParameter parameter = new DirectoryParameter(description);
  43                 parameters.add(parameter);
  44                 return parameter;
  45         }
  46
  47         public FileParameter createFileParameter(final String description) {
  48                 final FileParameter parameter = new FileParameter(description);
  49                 parameters.add(parameter);
  50                 return parameter;
  51         }
  52
  53         public IntegerParameter createIntegerParameter(final String description) {
  54                 final IntegerParameter parameter = new IntegerParameter(description);
  55                 parameters.add(parameter);
  56                 return parameter;
  57         }
  58
  59         public NullParameter createNullParameter(final String description) {
  60                 final NullParameter parameter = new NullParameter(description);
  61                 parameters.add(parameter);
  62                 return parameter;
  63         }
  64
  65         public StringParameter createStringParameter(final String description) {
  66                 final StringParameter parameter = new StringParameter(description);
  67                 parameters.add(parameter);
  68                 return parameter;
  69         }
  70
  71         /**
  72          * Return parameter by given alias or <code>null</code> if no parameter
  73          * exists for given alias.
  74          */
  75         public Parameter getParameterByAlias(final String alias) {
  76
  77                 for (final Parameter parameter : parameters)
  78                         if (parameter.matchesAlias(alias))
  79                                 return parameter;
  80
  81                 return null;
  82         }
  83
  84         /**
  85          * @return <code>true</code> if no errors were found. <code>false</code>
  86          *         otherwise.
  87          */
  88         public boolean parse(final String[] args) {
  89
  90                 Parameter currentParameter = null;
  91
  92                 for (final String argument : args) {
  93
  94                         final Parameter parameterForAlias = getParameterByAlias(argument);
  95                         if (parameterForAlias == null) {
  96                                 if (currentParameter == null) {
  97                                         System.out.println("Unknown commandline parameter: "
  98                                                         + argument);
  99                                         return false;
 100                                 }
 101
 102                                 if (!currentParameter.addArgument(argument))
 103                                         return false;
 104
 105                         } else {
 106                                 if (currentParameter != null)
 107                                         if (!currentParameter.noMoreArguments())
 108                                                 return false;
 109
 110                                 parameterForAlias.setParameterSpecified(true);
 111                                 currentParameter = parameterForAlias;
 112                         }
 113
 114                 }
 115
 116                 // check if any mandatory parameters are missing
 117
 118                 for (final Parameter parameter : parameters)
 119                         if (parameter.isMandatory() && (!parameter.isParameterSpecified())) {
 120                                 System.out.println("Error! Mandatory parameter ("
 121                                                 + parameter.getAliases() + ") is not specified.");
 122                                 return false;
 123                         }
 124
 125                 return true;
 126         }
 127
 128         public void showHelp() {
 129                 for (final Parameter parameter : parameters)
 130                         System.out.println(parameter.getHelp());
 131         }
 132
 133 }