projects
/
svjatoslav_commons.git
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
raw
|
inline
| side by side
Updated copyright
[svjatoslav_commons.git]
/
src
/
main
/
java
/
eu
/
svjatoslav
/
commons
/
commandline
/
parameterparser
/
Parameter.java
diff --git
a/src/main/java/eu/svjatoslav/commons/commandline/parameterparser/Parameter.java
b/src/main/java/eu/svjatoslav/commons/commandline/parameterparser/Parameter.java
index
95df0c0
..
67c6af3
100755
(executable)
--- a/
src/main/java/eu/svjatoslav/commons/commandline/parameterparser/Parameter.java
+++ b/
src/main/java/eu/svjatoslav/commons/commandline/parameterparser/Parameter.java
@@
-1,6
+1,6
@@
/*
* Svjatoslav Commons - shared library of common functionality.
/*
* Svjatoslav Commons - shared library of common functionality.
- * Copyright ©2012-201
7
, Svjatoslav Agejenko, svjatoslav@svjatoslav.eu
+ * Copyright ©2012-201
9
, Svjatoslav Agejenko, svjatoslav@svjatoslav.eu
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of version 3 of the GNU Lesser General Public License
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of version 3 of the GNU Lesser General Public License
@@
-11,13
+11,20
@@
package eu.svjatoslav.commons.commandline.parameterparser;
import java.util.ArrayList;
import java.util.Collections;
import java.util.ArrayList;
import java.util.Collections;
+import java.util.List;
public abstract class Parameter<T, I extends Parameter> {
public abstract class Parameter<T, I extends Parameter> {
+ /**
+ * Purpose of this argument, like: input image path, compression level, etc...
+ *
+ * Note: for describing argument type (file, integer, ...) there is {@link #describeFormat()}.
+ */
public final String description;
public final String description;
- public final ArrayList<String> arguments = new ArrayList<>();
+
+ public final List<String> arguments = new ArrayList<>();
final ArgumentCount argumentCount;
final ArgumentCount argumentCount;
- private final
Array
List<String> aliases = new ArrayList<>();
+ private final List<String> aliases = new ArrayList<>();
/**
* Indicates that at least one argument is mandatory for this parameter.
*/
/**
* Indicates that at least one argument is mandatory for this parameter.
*/
@@
-92,7
+99,10
@@
public abstract class Parameter<T, I extends Parameter> {
}
/**
}
/**
- * @return Single line argument type description.
+ * @return Single line argument type description. If argument type should be file,
+ * date, integer, regular expression, etc..
+ *
+ * Note: for argument purpose description there is {@link #description}
*/
public abstract String describeFormat();
*/
public abstract String describeFormat();