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

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