Refactor ParameterCount enum and update option descriptions
[cli-helper.git] / src / main / java / eu / svjatoslav / commons / cli_helper / parameter_parser / parameter / ExistenceType.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 /**
8  * This enum is used to define if resource denoted by particular option parameter shall exist or not.
9  * <p>
10  * This allows to specify for example if directory shall exist or not.
11  */
12 public enum ExistenceType {
13
14     /**
15      * Resource shall exist.
16      */
17     MUST_EXIST,
18
19     /**
20      * Resource shall not exist.
21      */
22     MUST_NOT_EXIST,
23
24     /**
25      * Resource existence does not matter.
26      */
27     DOES_NOT_MATTER;
28
29 }