Package tigase.util.ui.console
Class CommandlineParameter
java.lang.Object
tigase.util.ui.console.CommandlineParameter
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionboolean
Retrieves default value for this parameter optionRetrieves description for this parameter optionRetrieves full name for this parameter optiongetFullName
(boolean includeDash) Retrieves full name for this parameter optionRetrieves list of possible selection options for this parameter optionRetrieves single letter identification for this parameter optiongetSingleLetter
(boolean includeDash) Retrieves single letter identification for this parameter optiongetType()
Retrives expected class of a parametergetValue()
Retrieves stored value for this parameter optionint
hashCode()
boolean
boolean
Retrieves information whether this parameter option requires argumentsboolean
Retrieves information whether this parameter option is requiredboolean
isSecret()
Retrieves information whether this parameter option is secretvoid
Sets value for this parameter optionvoid
Sets the value from the configured default if presenttoString()
-
Method Details
-
equals
-
getDefaultValue
Retrieves default value for this parameter option- Returns:
- Optional for the default value
-
getDescription
Retrieves description for this parameter option- Returns:
- Optional for the description
-
getFullName
Retrieves full name for this parameter option- Parameters:
includeDash
- controls whether dashes should be included- Returns:
- Optional for the full name (which may include dashes depending on parameter)
-
getFullName
Retrieves full name for this parameter option- Returns:
- Optional for the full name
-
getSelectionOptions
Retrieves list of possible selection options for this parameter option- Returns:
- Optional list of the possible selection options
-
getSingleLetter
Retrieves single letter identification for this parameter option- Returns:
- Optional for the single letter
-
getSingleLetter
Retrieves single letter identification for this parameter option- Parameters:
includeDash
- controls whether dash should be included- Returns:
- Optional for the single letter (which may include dash depending on parameter)
-
getType
Retrives expected class of a parameter -
getValue
Retrieves stored value for this parameter option- Returns:
- Optional with the stored value
-
setValue
Sets value for this parameter option- Parameters:
value
- to be set
-
getValueDependentParameters
-
hasValueDependentParameters
public boolean hasValueDependentParameters() -
hashCode
public int hashCode() -
isRequireArguments
public boolean isRequireArguments()Retrieves information whether this parameter option requires arguments- Returns:
- true if the parameter option requires arguments
-
isRequired
public boolean isRequired()Retrieves information whether this parameter option is required- Returns:
- true if the parameter option is required
-
isSecret
public boolean isSecret()Retrieves information whether this parameter option is secret- Returns:
- true if the parameter option is secret
-
setValueFromDefault
public void setValueFromDefault()Sets the value from the configured default if present -
toString
-
toStringSimple
-