public interface CommandLineParameter
ServerPluginManager
in the REGISTER phase.execute
method of the parameters will be called in
the same order as they are added to the ServerPluginManager
! So make sure to sort the
ServerPluginManager.register(Class, Object)
calls accordingly.Modifier and Type | Method and Description |
---|---|
void |
execute(PDFC.ComparisonParameters parameters,
java.lang.String optionalParameter)
Executes the parameter to modify the comparison configuration accordingly.
|
java.lang.String |
getHelpMessage()
Returns a string to attach to the list of commands of the tool.
|
java.lang.String |
getKey()
Returns the long/full key of the parameter.
|
java.lang.String |
getMissingArgMsg()
Returns the message in case
hasValue() is true but no argument was passed. |
char |
getShortcut()
Returns the single character short cut switch, use a space if no shortcut can be used.
|
boolean |
hasValue()
Returns whether the parameter requires an additional argument like a path.
|
java.lang.String getKey()
null
if not usedchar getShortcut()
boolean hasValue()
true
if the next parameter is the argument to this parameterjava.lang.String getMissingArgMsg()
hasValue()
is true but no argument was passed. If hasValue()
returns false
, this method may return null
.hasValue()
is true but no argument was passedvoid execute(PDFC.ComparisonParameters parameters, java.lang.String optionalParameter)
parameters
- the configuration instance for the comparison to run after all command line parameters
have been evaluated.optionalParameter
- if hasValue()
yields true
, the caller will pass the additional value in this parameterjava.lang.String getHelpMessage()
null
for no help contentCopyright © 2010-2022 by i-net software GmbH