src/main/java/eu/svjatoslav/commons/commandline/parameterparser/Parameter.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.io.File;
  13 import java.util.ArrayList;
  14 import java.util.List;
  15
  16 public class Parameter {
  17
  18         /**
  19          * Indicates that at least one argument is mandatory for this parameter.
  20          */
  21         private boolean mandatory;
  22
  23         private final Argument argumentType;
  24
  25         private final ArrayList<String> aliases = new ArrayList<String>();
  26
  27         public final String description;
  28
  29         protected final ArrayList<String> arguments = new ArrayList<String>();
  30
  31         ArgumentCount argumentCount;
  32
  33         /**
  34          * If this parameter was present in the commandline, then this boolean will
  35          * be set to <code>true</code>.
  36          */
  37         private boolean parameterSpecified;
  38
  39         public Parameter(final Argument argumentType, final String description,
  40                         final ArgumentCount argumentCount) {
  41
  42                 this.description = description;
  43                 this.argumentType = argumentType;
  44                 this.argumentCount = argumentCount;
  45         };
  46
  47         public Parameter(final boolean mandatory,
  48                         final ArgumentCount argumentCount, final Argument argumentType,
  49                         final String description, final String... aliases2) {
  50
  51                 this.mandatory = mandatory;
  52                 this.argumentType = argumentType;
  53                 this.description = description;
  54                 this.argumentCount = argumentCount;
  55
  56                 // save aliases
  57                 for (final String alias : aliases2)
  58                         aliases.add(alias);
  59
  60         }
  61
  62         public Parameter addAliases(final String... aliasArray) {
  63
  64                 // save aliases
  65                 for (final String alias : aliasArray)
  66                         aliases.add(alias);
  67
  68                 return this;
  69         }
  70
  71         /**
  72          * @return <code>true</code> if no errors were found. <code>false</code>
  73          *         otherwise.
  74          */
  75         public boolean addArgument(final String argumentString) {
  76                 // check if arguments are allowed for this parameter
  77                 if (argumentCount.equals(ArgumentCount.NONE)) {
  78                         System.out
  79                                         .println("Error! No arguments are allowed for parameters: "
  80                                                         + getAliases());
  81                         return false;
  82                 }
  83
  84                 // check if multiple arguments are allowed
  85                 if ((arguments.size() > 0)
  86                                 && (argumentCount.equals(ArgumentCount.SINGLE))) {
  87                         System.out
  88                                         .println("Error! Only single argument is allowed for parameters: "
  89                                                         + getAliases());
  90                         return false;
  91                 }
  92
  93                 if (!argumentType.validate(argumentString)) {
  94
  95                         System.out.println("Error! Invalid argument \"" + argumentString
  96                                         + "\". It shall be " + argumentType.describeFormat() + ".");
  97                         return false;
  98
  99                 }
 100
 101                 arguments.add(argumentString);
 102
 103                 return true;
 104         }
 105
 106         public String getAliases() {
 107                 final StringBuffer buffer = new StringBuffer();
 108
 109                 for (final String alias : aliases) {
 110
 111                         if (buffer.length() > 0)
 112                                 buffer.append(", ");
 113
 114                         buffer.append(alias);
 115                 }
 116
 117                 return buffer.toString();
 118         }
 119
 120         public File getArgumentAsFile() {
 121                 if (arguments.size() != 1)
 122                         throw new RuntimeException("Parameter " + description
 123                                         + " shall have exactly 1 argument.");
 124                 return new File(arguments.get(0));
 125         }
 126
 127         public int getArgumentAsInteger() {
 128                 if (arguments.size() != 1)
 129                         throw new RuntimeException("Parameter " + description
 130                                         + " shall have exactly 1 argument.");
 131                 return Integer.parseInt(arguments.get(0));
 132         }
 133
 134         public List<File> getArgumentsAsFiles() {
 135                 final ArrayList<File> result = new ArrayList<File>();
 136
 137                 for (final String argument : arguments) {
 138                         final File file = new File(argument);
 139                         result.add(file);
 140                 }
 141
 142                 return result;
 143         }
 144
 145         public List<Integer> getArgumentsAsIntegers() {
 146                 final ArrayList<Integer> result = new ArrayList<Integer>();
 147
 148                 for (final String argument : arguments)
 149                         result.add(Integer.valueOf(argument));
 150
 151                 return result;
 152         }
 153
 154         public List<String> getArgumentsAsStrings() {
 155                 final ArrayList<String> result = new ArrayList<String>(arguments);
 156                 return result;
 157         }
 158
 159         public String getHelp() {
 160                 final StringBuffer buffer = new StringBuffer();
 161
 162                 // first line
 163                 buffer.append(getAliases());
 164                 if (!argumentCount.equals(ArgumentCount.NONE)) {
 165                         buffer.append(" (" + argumentType.describeFormat() + ")");
 166
 167                         if (argumentCount.equals(ArgumentCount.MULTI))
 168                                 buffer.append("...");
 169                 }
 170                 buffer.append("\n");
 171
 172                 // second line
 173                 buffer.append("    " + description + "\n");
 174
 175                 return buffer.toString();
 176         }
 177
 178         public boolean isMandatory() {
 179                 return mandatory;
 180         }
 181
 182         /**
 183          * @return the parameterSpecified
 184          */
 185         public boolean isParameterSpecified() {
 186                 return parameterSpecified;
 187         }
 188
 189         /**
 190          * @return <code>true</code> if given alias is registered for this
 191          *         parameter.
 192          */
 193         public boolean matchesAlias(final String alias) {
 194                 if (aliases.contains(alias))
 195                         return true;
 196
 197                 return false;
 198         }
 199
 200         /**
 201          * Notifies this parameter that no more arguments will follow. This gives
 202          * parameter chance to verify if this is ok.
 203          *
 204          * @return <code>true</code> if no errors were found. <code>false</code>
 205          *         otherwise.
 206          */
 207         public boolean noMoreArguments() {
 208
 209                 if ((!argumentCount.equals(ArgumentCount.NONE))
 210                                 && (arguments.isEmpty())) {
 211
 212                         System.out.println("Error! " + getAliases()
 213                                         + " require at least one following argument.");
 214
 215                         return false;
 216                 }
 217                 return true;
 218         }
 219
 220         public Parameter setMandatory() {
 221                 mandatory = true;
 222                 return this;
 223         }
 224
 225         /**
 226          * @param parameterSpecified
 227          *            the parameterSpecified to set
 228          */
 229         public void setParameterSpecified(final boolean parameterSpecified) {
 230                 this.parameterSpecified = parameterSpecified;
 231         }
 232
 233 }