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 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 import eu.svjatoslav.commons.commandline.parameterparser.parameter.StringParameters;
23 * Single commandline parameter can have any amount of arguments.
28 private final ArrayList<Parameter> parameters = new ArrayList<Parameter>();
30 public void addParameter(final Parameter parameter) {
31 parameters.add(parameter);
34 public DirectoryParameter createDirectoryParameter(final String description) {
35 final DirectoryParameter parameter = new DirectoryParameter(description);
36 parameters.add(parameter);
40 public FileParameter createFileParameter(final String description) {
41 final FileParameter parameter = new FileParameter(description);
42 parameters.add(parameter);
46 public IntegerParameter createIntegerParameter(final String description) {
47 final IntegerParameter parameter = new IntegerParameter(description);
48 parameters.add(parameter);
52 public NullParameter createNullParameter(final String description) {
53 final NullParameter parameter = new NullParameter(description);
54 parameters.add(parameter);
58 public StringParameter createStringParameter(final String description) {
59 final StringParameter parameter = new StringParameter(description);
60 parameters.add(parameter);
64 public StringParameters createStringParameters(final String description) {
65 final StringParameters stingParameters = new StringParameters(
67 parameters.add(stingParameters);
68 return stingParameters;
72 * Return parameter by given alias or <code>null</code> if no parameter
73 * exists for given alias.
75 public Parameter getParameterByAlias(final String alias) {
77 for (final Parameter parameter : parameters)
78 if (parameter.matchesAlias(alias))
85 * @return <code>true</code> if no errors were found. <code>false</code>
88 public boolean parse(final String[] args) {
90 Parameter currentParameter = null;
92 for (final String argument : args) {
94 final Parameter parameterForAlias = getParameterByAlias(argument);
95 if (parameterForAlias == null) {
96 if (currentParameter == null) {
97 System.out.println("Unknown commandline parameter: "
102 if (!currentParameter.addArgument(argument))
106 if (currentParameter != null)
107 if (!currentParameter.noMoreArguments())
110 parameterForAlias.setParameterSpecified(true);
111 currentParameter = parameterForAlias;
116 // check if any mandatory parameters are missing
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.");
128 public void showHelp() {
129 for (final Parameter parameter : parameters)
130 System.out.println(parameter.getHelp());