Added special commandline argument type to support multiple strings.
[svjatoslav_commons.git] / src / main / java / eu / svjatoslav / commons / commandline / parameterparser / parameter / StringParameter.java
1 /*
2  * Svjatoslav Commons - shared library of common functionality.
3  * Copyright ©2012-2014, 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.parameter;
11
12 import eu.svjatoslav.commons.commandline.parameterparser.ArgumentCount;
13 import eu.svjatoslav.commons.commandline.parameterparser.Parameter;
14
15 public class StringParameter extends Parameter {
16
17         public StringParameter(final String description) {
18                 super(description, ArgumentCount.SINGLE);
19         }
20
21         @Override
22         public StringParameter addAliases(final String... aliasArray) {
23                 super.addAliasesProtected(aliasArray);
24                 return this;
25         }
26
27         @Override
28         public java.lang.String describeFormat() {
29                 return "string";
30         }
31
32         @Override
33         public String getValue() {
34
35                 if (arguments.size() != 1)
36                         throw new RuntimeException("Parameter " + description
37                                         + " shall have exactly 1 argument.");
38
39                 return arguments.get(0);
40         }
41
42         @Override
43         public StringParameter setMandatory() {
44                 setMandatoryProtected();
45                 return this;
46         }
47
48         @Override
49         public boolean validate(final java.lang.String value) {
50                 return true;
51         }
52
53 }