|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.unboundid.util.args.Argument
com.unboundid.util.args.BooleanValueArgument
@Mutable @ThreadSafety(level=NOT_THREADSAFE) public final class BooleanValueArgument
Creates a new argument that is intended to represent Boolean states based on
the value provided for this argument. This is similar to the
BooleanArgument
argument type, except that the Boolean value for this
argument must be explicitly specified, whereas the Boolean value for the
BooleanArgument
class is inferred based on whether the argument
was present.
Arguments of this type must always have exactly one value. Values of "true",
"t", "yes", "y", "on", and "1" will be interpreted as representing a Boolean
value of true
, and values of "false", "f", "no", "n", "off", and "0"
will be interpreted as representing a Boolean value of false
. No
other values will be allowed.
Constructor Summary | |
---|---|
BooleanValueArgument(java.lang.Character shortIdentifier,
java.lang.String longIdentifier,
boolean isRequired,
java.lang.String valuePlaceholder,
java.lang.String description)
Creates a new Boolean value argument with no default value. |
|
BooleanValueArgument(java.lang.Character shortIdentifier,
java.lang.String longIdentifier,
boolean isRequired,
java.lang.String valuePlaceholder,
java.lang.String description,
java.lang.Boolean defaultValue)
Creates a new Boolean value argument with the specified default value. |
|
BooleanValueArgument(java.lang.Character shortIdentifier,
java.lang.String longIdentifier,
java.lang.String description)
Creates a new Boolean value argument with the provided information. |
Method Summary | |
---|---|
protected void |
addToCommandLine(java.util.List<java.lang.String> argStrings)
Updates the provided list to add any strings that should be included on the command line in order to represent this argument's current state. |
protected void |
addValue(java.lang.String valueString)
Adds the provided value to the set of values for this argument. |
BooleanValueArgument |
getCleanCopy()
Creates a copy of this argument that is "clean" and appears as if it has not been used in the course of parsing an argument set. |
java.lang.String |
getDataTypeName()
Retrieves a concise name of the data type with which this argument is associated. |
java.lang.Boolean |
getDefaultValue()
Retrieves the default value for this argument, if defined. |
java.lang.Boolean |
getValue()
Retrieves the value for this argument, if one was provided. |
java.lang.String |
getValueConstraints()
Retrieves a human-readable string with information about any constraints that may be imposed for values of this argument. |
java.util.List<java.lang.String> |
getValueStringRepresentations(boolean useDefault)
Retrieves a list containing the string representations of the values for this argument, if any. |
protected boolean |
hasDefaultValue()
Indicates whether this argument has one or more default values that will be used if it is not provided on the command line. |
protected void |
reset()
Resets this argument so that it appears in the same form as before it was used to parse arguments. |
void |
toString(java.lang.StringBuilder buffer)
Appends a string representation of this argument to the provided buffer. |
Methods inherited from class com.unboundid.util.args.Argument |
---|
addLongIdentifier, addShortIdentifier, appendBasicToStringInfo, getArgumentGroupName, getDescription, getIdentifierString, getLongIdentifier, getLongIdentifiers, getMaxOccurrences, getNumOccurrences, getShortIdentifier, getShortIdentifiers, getValuePlaceholder, hasLongIdentifier, hasShortIdentifier, isHidden, isPresent, isRequired, isSensitive, isUsageArgument, setArgumentGroupName, setHidden, setMaxOccurrences, setSensitive, setUsageArgument, takesValue, toString |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public BooleanValueArgument(java.lang.Character shortIdentifier, java.lang.String longIdentifier, java.lang.String description) throws ArgumentException
shortIdentifier
- The short identifier for this argument. It may
not be null
if the long identifier is
null
.longIdentifier
- The long identifier for this argument. It may
not be null
if the short identifier is
null
.description
- A human-readable description for this argument.
It must not be null
.
ArgumentException
- If there is a problem with the definition of
this argument.public BooleanValueArgument(java.lang.Character shortIdentifier, java.lang.String longIdentifier, boolean isRequired, java.lang.String valuePlaceholder, java.lang.String description) throws ArgumentException
shortIdentifier
- The short identifier for this argument. It may
not be null
if the long identifier is
null
.longIdentifier
- The long identifier for this argument. It may
not be null
if the short identifier is
null
.isRequired
- Indicates whether this argument is required to
be provided.valuePlaceholder
- A placeholder to display in usage information to
indicate that a value must be provided. It may
be null
if a default placeholder should
be used.description
- A human-readable description for this argument.
It must not be null
.
ArgumentException
- If there is a problem with the definition of
this argument.public BooleanValueArgument(java.lang.Character shortIdentifier, java.lang.String longIdentifier, boolean isRequired, java.lang.String valuePlaceholder, java.lang.String description, java.lang.Boolean defaultValue) throws ArgumentException
shortIdentifier
- The short identifier for this argument. It may
not be null
if the long identifier is
null
.longIdentifier
- The long identifier for this argument. It may
not be null
if the short identifier is
null
.isRequired
- Indicates whether this argument is required to
be provided.valuePlaceholder
- A placeholder to display in usage information to
indicate that a value must be provided. It may
be null
if a default placeholder should
be used.description
- A human-readable description for this argument.
It must not be null
.defaultValue
- The default value that will be used for this
argument if no values are provided. It may be
null
if there should not be a default
value.
ArgumentException
- If there is a problem with the definition of
this argument.Method Detail |
---|
public java.util.List<java.lang.String> getValueStringRepresentations(boolean useDefault)
getValueStringRepresentations
in class Argument
useDefault
- Indicates whether to use any configured default value
if the argument doesn't have a user-specified value.
protected boolean hasDefaultValue()
hasDefaultValue
in class Argument
true
if this argument has one or more default values, or
false
if not.public java.lang.Boolean getDefaultValue()
null
if none is
defined.public java.lang.Boolean getValue()
null
will be returned.protected void addValue(java.lang.String valueString) throws ArgumentException
addValue
in class Argument
valueString
- The string representation of the value.
ArgumentException
- If the provided value is not acceptable, if
this argument does not accept values, or if
this argument already has the maximum allowed
number of values.public java.lang.String getDataTypeName()
getDataTypeName
in class Argument
public java.lang.String getValueConstraints()
getValueConstraints
in class Argument
null
if there are none.protected void reset()
super.reset()
to ensure that all necessary reset processing is
performed.
reset
in class Argument
public BooleanValueArgument getCleanCopy()
getCleanCopy
in class Argument
protected void addToCommandLine(java.util.List<java.lang.String> argStrings)
addToCommandLine
in class Argument
argStrings
- The list to update with the string representation of
the command-line arguments.public void toString(java.lang.StringBuilder buffer)
toString
in class Argument
buffer
- The buffer to which the information should be appended.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |