2 * Svjatoslav Commons - shared library of common functionality.
3 * Copyright ©2012-2014, 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 3 of the GNU Lesser General Public License
7 * or later as published by the Free Software Foundation.
10 package eu.svjatoslav.commons.commandline.parameterparser;
12 import java.util.ArrayList;
14 public abstract class Parameter {
17 * Indicates that at least one argument is mandatory for this parameter.
19 protected boolean mandatory;
21 private final ArrayList<String> aliases = new ArrayList<String>();
23 public final String description;
25 protected final ArrayList<String> arguments = new ArrayList<String>();
27 final ArgumentCount argumentCount;
30 * If this parameter was present in the commandline, then this boolean will
31 * be set to <code>true</code>.
33 private boolean parameterSpecified;
35 public Parameter(final boolean mandatory,
36 final ArgumentCount argumentCount, final String description,
37 final String... aliases2) {
39 this.mandatory = mandatory;
40 this.description = description;
41 this.argumentCount = argumentCount;
44 for (final String alias : aliases2)
49 public Parameter(final String description, final ArgumentCount argumentCount) {
50 this.description = description;
51 this.argumentCount = argumentCount;
54 public abstract Object addAliases(final String... aliasArray);
56 protected Parameter addAliasesProtected(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);
101 * @return Single line argument type description.
103 public abstract String describeFormat();
105 public String getAliases() {
106 final StringBuffer buffer = new StringBuffer();
108 for (final String alias : aliases) {
110 if (buffer.length() > 0)
113 buffer.append(alias);
116 return buffer.toString();
119 // public List<File> getArgumentsAsFiles() {
120 // final ArrayList<File> result = new ArrayList<File>();
122 // for (final String argument : arguments) {
123 // final File file = new File(argument);
130 // public List<Integer> getArgumentsAsIntegers() {
131 // final ArrayList<Integer> result = new ArrayList<Integer>();
133 // for (final String argument : arguments)
134 // result.add(Integer.valueOf(argument));
139 // public List<String> getArgumentsAsStrings() {
140 // final ArrayList<String> result = new ArrayList<String>(arguments);
144 public String getHelp() {
145 final StringBuffer buffer = new StringBuffer();
148 buffer.append(getAliases());
149 if (!argumentCount.equals(ArgumentCount.NONE)) {
150 buffer.append(" (" + describeFormat() + ")");
152 if (argumentCount.equals(ArgumentCount.MULTI))
153 buffer.append("...");
158 buffer.append(" " + description + "\n");
160 return buffer.toString();
163 public abstract Object getValue();
165 public boolean isMandatory() {
170 * @return the parameterSpecified
172 public boolean isParameterSpecified() {
173 return parameterSpecified;
177 * @return <code>true</code> if given alias is registered for this
180 public boolean matchesAlias(final String alias) {
181 if (aliases.contains(alias))
188 * Notifies this parameter that no more arguments will follow. This gives
189 * parameter chance to verify if this is ok.
191 * @return <code>true</code> if no errors were found. <code>false</code>
194 public boolean noMoreArguments() {
196 if ((!argumentCount.equals(ArgumentCount.NONE))
197 && (arguments.isEmpty())) {
199 System.out.println("Error! " + getAliases()
200 + " require at least one following argument.");
207 public abstract Parameter setMandatory();
209 protected Parameter setMandatoryProtected() {
215 * @param parameterSpecified
216 * the parameterSpecified to set
218 public void setParameterSpecified(final boolean parameterSpecified) {
219 this.parameterSpecified = parameterSpecified;
223 * @return <code>true</code> if value is correct, <code>false</code>
226 public abstract boolean validate(String value);