7520aad41941ac2882bf4d24e4442801fd2cf3c6
[svjatoslav_commons.git] / src / main / java / eu / svjatoslav / commons / commandline / parameterparser / Parser.java
1 /*
2  * Svjatoslav Commons - shared library of common functionality.
3  * Copyright ©2012-2020, 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 3 of the GNU Lesser General Public License
7  * or later 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<?, ? extends Parameter>> parameters = new ArrayList<>();
22
23     public <E extends Parameter> E add(final E parameter) {
24         parameters.add(parameter);
25         return parameter;
26     }
27
28     /**
29      * @return <code>true</code> if no errors were found. <code>false</code>
30      * otherwise.
31      */
32     private boolean checkMandatoryArgumentsPresent() {
33
34         for (final Parameter parameter : parameters)
35             if (parameter.isMandatory() && (!parameter.isSpecified())) {
36                 System.out.println("Error! Mandatory parameter ("
37                         + parameter.getAliases() + ") is not specified.");
38                 return false;
39             }
40
41         return true;
42     }
43
44     /**
45      * Return parameter by given alias or <code>null</code> if no parameter
46      * exists for given alias.
47      *
48      * @param alias parameter alias
49      * @return found parameter or <code>null</code> if parameter was not found.
50      */
51     public Parameter findParameterByAlias(final String alias) {
52
53         for (final Parameter parameter : parameters)
54             if (parameter.matchesAlias(alias))
55                 return parameter;
56
57         return null;
58     }
59
60     /**
61      * @param args commandline arguments
62      * @return <code>true</code> if no errors were found. <code>false</code>
63      * otherwise.
64      */
65     public boolean parse(final String[] args) {
66
67         Parameter currentParameter = null;
68
69         for (final String argument : args) {
70
71             final Parameter parameterForAlias = findParameterByAlias(argument);
72             if (parameterForAlias == null) {
73                 if (currentParameter == null) {
74                     System.out.println("Unknown commandline parameter: "
75                             + argument);
76                     return false;
77                 }
78
79                 if (!currentParameter.addArgument(argument))
80                     return false;
81
82             } else {
83                 if (currentParameter != null)
84                     if (!currentParameter.noMoreArguments())
85                         return false;
86
87                 parameterForAlias.setSpecified(true);
88                 currentParameter = parameterForAlias;
89             }
90
91         }
92
93         return checkMandatoryArgumentsPresent();
94     }
95
96     public void showHelp() {
97         System.out.println("Available commandline arguments:");
98         for (final Parameter parameter : parameters)
99             System.out.println(parameter.getHelp());
100     }
101
102 }