X-Git-Url: http://www2.svjatoslav.eu/gitweb/?p=cli-helper.git;a=blobdiff_plain;f=src%2Fmain%2Fjava%2Feu%2Fsvjatoslav%2Fcommons%2Fcli_helper%2Fparameter_parser%2Fparameter%2FFileOption.java;fp=src%2Fmain%2Fjava%2Feu%2Fsvjatoslav%2Fcommons%2Fcli_helper%2Fparameter_parser%2Fparameter%2FFileOption.java;h=c10ec1e63d7e58fe7ee6e00e04a09591df0cf826;hp=935ea9f26f993cb2b40b17358a19eae84ed54065;hb=b4b3152b0012f4e0b0b5d3e98cc8a7e4a12e8c18;hpb=e8f029969d48634280dc5ad9d9c43ba4c0699cd9

diff --git a/src/main/java/eu/svjatoslav/commons/cli_helper/parameter_parser/parameter/FileOption.java b/src/main/java/eu/svjatoslav/commons/cli_helper/parameter_parser/parameter/FileOption.java
index 935ea9f..c10ec1e 100755
--- a/src/main/java/eu/svjatoslav/commons/cli_helper/parameter_parser/parameter/FileOption.java
+++ b/src/main/java/eu/svjatoslav/commons/cli_helper/parameter_parser/parameter/FileOption.java
@@ -9,6 +9,10 @@ import eu.svjatoslav.commons.cli_helper.parameter_parser.Option;
 
 import java.io.File;
 
+/**
+ * This class represents commandline option which accepts exactly one parameter
+ * which is a file.
+ */
 public class FileOption extends Option<File, FileOption> {
 
     private ExistenceType existenceType = ExistenceType.DOES_NOT_MATTER;
@@ -61,11 +65,21 @@ public class FileOption extends Option<File, FileOption> {
         return new File(parameters.get(0));
     }
 
+    /**
+     * This method sets that file shall exist.
+     *
+     * @return This object.
+     */
     public FileOption mustExist() {
         existenceType = ExistenceType.MUST_EXIST;
         return this;
     }
 
+    /**
+     * This method sets that file shall not exist.
+     *
+     * @return This object.
+     */
     public FileOption mustNotExist() {
         existenceType = ExistenceType.MUST_NOT_EXIST;
         return this;