Add Javadoc comments to enhance code clarity
[cli-helper.git] / src / main / java / eu / svjatoslav / commons / cli_helper / parameter_parser / parameter / StringOptions.java
1 /*
2  * Svjatoslav Commons - shared library of common functionality. Author: Svjatoslav Agejenko.
3  * This project is released under Creative Commons Zero (CC0) license.
4  */
5 package eu.svjatoslav.commons.cli_helper.parameter_parser.parameter;
6
7 import eu.svjatoslav.commons.cli_helper.parameter_parser.ParameterCount;
8 import eu.svjatoslav.commons.cli_helper.parameter_parser.Option;
9
10 import java.util.List;
11
12 /**
13  * This class represents commandline option which accepts one or more parameters
14  * which are strings.
15  */
16 public class StringOptions extends Option<List<String>, StringOptions> {
17
18     public StringOptions(final String description) {
19         super(description, ParameterCount.ONE_OR_MORE);
20     }
21
22     @Override
23     public java.lang.String describeFormat() {
24         return "One to many string.";
25     }
26
27     @Override
28     public List<String> getValue() {
29         return parameters;
30     }
31
32     @Override
33     public boolean isValid(final java.lang.String value) {
34         return true;
35     }
36
37 }