2 * Svjatoslav Commons - shared library of common functionality.
3 * Copyright ©2012-2013, Svjatoslav Agejenko, svjatoslav@svjatoslav.eu
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.
10 package eu.svjatoslav.commons.commandline.parameterparser;
13 import java.util.ArrayList;
14 import java.util.List;
16 public abstract class Parameter {
19 * Indicates that at least one argument is mandatory for this parameter.
21 protected boolean mandatory;
23 private final ArrayList<String> aliases = new ArrayList<String>();
25 public final String description;
27 protected final ArrayList<String> arguments = new ArrayList<String>();
29 ArgumentCount argumentCount;
32 * If this parameter was present in the commandline, then this boolean will
33 * be set to <code>true</code>.
35 private boolean parameterSpecified;
37 public Parameter(final String description, final ArgumentCount argumentCount) {
38 this.description = description;
39 this.argumentCount = argumentCount;
42 public Parameter(final boolean mandatory,
43 final ArgumentCount argumentCount, final String description,
44 final String... aliases2) {
46 this.mandatory = mandatory;
47 this.description = description;
48 this.argumentCount = argumentCount;
51 for (final String alias : aliases2)
56 public Parameter addAliases(final String... aliasArray) {
59 for (final String alias : aliasArray)
66 * @return <code>true</code> if no errors were found. <code>false</code>
69 public boolean addArgument(final String argumentString) {
70 // check if arguments are allowed for this parameter
71 if (argumentCount.equals(ArgumentCount.NONE)) {
73 .println("Error! No arguments are allowed for parameters: "
78 // check if multiple arguments are allowed
79 if ((arguments.size() > 0)
80 && (argumentCount.equals(ArgumentCount.SINGLE))) {
82 .println("Error! Only single argument is allowed for parameters: "
87 if (!validate(argumentString)) {
89 System.out.println("Error! Invalid argument \"" + argumentString
90 + "\". It shall be " + describeFormat() + ".");
95 arguments.add(argumentString);
100 public String getAliases() {
101 final StringBuffer buffer = new StringBuffer();
103 for (final String alias : aliases) {
105 if (buffer.length() > 0)
108 buffer.append(alias);
111 return buffer.toString();
114 public List<File> getArgumentsAsFiles() {
115 final ArrayList<File> result = new ArrayList<File>();
117 for (final String argument : arguments) {
118 final File file = new File(argument);
125 public List<Integer> getArgumentsAsIntegers() {
126 final ArrayList<Integer> result = new ArrayList<Integer>();
128 for (final String argument : arguments)
129 result.add(Integer.valueOf(argument));
134 public List<String> getArgumentsAsStrings() {
135 final ArrayList<String> result = new ArrayList<String>(arguments);
139 public String getHelp() {
140 final StringBuffer buffer = new StringBuffer();
143 buffer.append(getAliases());
144 if (!argumentCount.equals(ArgumentCount.NONE)) {
145 buffer.append(" (" + describeFormat() + ")");
147 if (argumentCount.equals(ArgumentCount.MULTI))
148 buffer.append("...");
153 buffer.append(" " + description + "\n");
155 return buffer.toString();
158 public boolean isMandatory() {
163 * @return the parameterSpecified
165 public boolean isParameterSpecified() {
166 return parameterSpecified;
170 * @return <code>true</code> if given alias is registered for this
173 public boolean matchesAlias(final String alias) {
174 if (aliases.contains(alias))
181 * Notifies this parameter that no more arguments will follow. This gives
182 * parameter chance to verify if this is ok.
184 * @return <code>true</code> if no errors were found. <code>false</code>
187 public boolean noMoreArguments() {
189 if ((!argumentCount.equals(ArgumentCount.NONE))
190 && (arguments.isEmpty())) {
192 System.out.println("Error! " + getAliases()
193 + " require at least one following argument.");
200 public Parameter setMandatory() {
206 * @param parameterSpecified
207 * the parameterSpecified to set
209 public void setParameterSpecified(final boolean parameterSpecified) {
210 this.parameterSpecified = parameterSpecified;
214 * @return Single line argument type description.
216 public abstract String describeFormat();
219 * @return <code>true</code> if value is correct, <code>false</code>
222 public abstract boolean validate(String value);