e108417ef63648da6543e1b0cbc9c92904e33282
[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.addAliases(aliasArray);
24                 return this;
25         }
26
27         @Override
28         public java.lang.String describeFormat() {
29                 return "string";
30         }
31
32         public String getValue() {
33
34                 if (arguments.size() != 1)
35                         throw new RuntimeException("Parameter " + description
36                                         + " shall have exactly 1 argument.");
37
38                 return arguments.get(0);
39         }
40
41         @Override
42         public StringParameter setMandatory() {
43                 mandatory = true;
44                 return this;
45         }
46
47         @Override
48         public boolean validate(final java.lang.String value) {
49                 return true;
50         }
51
52 }