Add Javadoc comments to enhance code clarity
[cli-helper.git] / src / main / java / eu / svjatoslav / commons / cli_helper / parameter_parser / parameter / NullOption.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 /**
11  * This class represents commandline option which accepts exactly zero parameters.
12  */
13 public class NullOption extends Option<Boolean, NullOption> {
14
15     public NullOption(final String description) {
16         super(description, ParameterCount.NONE);
17     }
18
19     @Override
20     public java.lang.String describeFormat() {
21         return "None.";
22     }
23
24     @Override
25     public Boolean getValue() {
26         return isPresent();
27     }
28
29     @Override
30     public boolean isValid(final java.lang.String value) {
31         return true;
32     }
33
34 }