Update naming in commandline parser

[cli-helper.git] / src / main / java / eu / svjatoslav / commons / cli_helper / parameter_parser / parameter / ExistenceType.java

diff --git a/src/main/java/eu/svjatoslav/commons/cli_helper/parameter_parser/parameter/ExistenceType.java b/src/main/java/eu/svjatoslav/commons/cli_helper/parameter_parser/parameter/ExistenceType.java
index 0b6b4bc..dfedb74 100755 (executable)
--- a/src/main/java/eu/svjatoslav/commons/cli_helper/parameter_parser/parameter/ExistenceType.java
+++ b/src/main/java/eu/svjatoslav/commons/cli_helper/parameter_parser/parameter/ExistenceType.java
@@ -4,10 +4,31 @@
  */
 package eu.svjatoslav.commons.cli_helper.parameter_parser.parameter;
 
+/**
+ * This enum is used to define if resource denoted by particular option parameter shall exist or not.
+ * <p>
+ * This allows to specify for example if directory shall exist or not.
+ */
 public enum ExistenceType {
 
-    MUST_EXIST("existing"), MUST_NOT_EXIST("not existing"), DOES_NOT_MATTER("");
+    /**
+     * Resource shall exist.
+     */
+    MUST_EXIST("existing"),
+
+    /**
+     * Resource shall not exist.
+     */
+    MUST_NOT_EXIST("not existing"),
+
+    /**
+     * Resource existence does not matter.
+     */
+    DOES_NOT_MATTER("");
 
+    /**
+     * Human readable description of existence type.
+     */
     public final String description;
 
     ExistenceType(final String description) {