|
|||||||||
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.BooleanArgument
@Mutable @ThreadSafety(level=NOT_THREADSAFE) public final class BooleanArgument
Creates a new argument that is intended to represent Boolean states based on
whether it was present in the provided set of command-line arguments.
Boolean arguments never have values, since the argument identifier itself is
sufficient to indicate presence. If the argument is present in the set of
provided command-line arguments, then it will be assumed to have a value of
true
. If the argument is not present, then it will be assumed to
have a value of false
.
Note that it may be beneficial in some cases to allow multiple occurrences of
the same Boolean argument if that has special meaning (e.g., if "-v" is used
to enable verbose output, then perhaps "-v -v" would be even more verbose).
Constructor Summary | |
---|---|
BooleanArgument(java.lang.Character shortIdentifier,
java.lang.String longIdentifier,
int maxOccurrences,
java.lang.String description)
Creates a new Boolean argument with the provided information. |
|
BooleanArgument(java.lang.Character shortIdentifier,
java.lang.String longIdentifier,
java.lang.String description)
Creates a new Boolean argument with the provided information. |
Method Summary | |
---|---|
protected void |
addValue(java.lang.String valueString)
Adds the provided value to the set of values for this argument. |
BooleanArgument |
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.String |
getValueConstraints()
Retrieves a human-readable string with information about any constraints that may be imposed for values of this argument. |
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. |
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, getDescription, getIdentifierString, getLongIdentifier, getLongIdentifiers, getMaxOccurrences, getNumOccurrences, getShortIdentifier, getShortIdentifiers, getValuePlaceholder, hasLongIdentifier, hasShortIdentifier, isHidden, isPresent, isRequired, isUsageArgument, setHidden, setMaxOccurrences, setUsageArgument, takesValue, toString |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public BooleanArgument(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 BooleanArgument(java.lang.Character shortIdentifier, java.lang.String longIdentifier, int maxOccurrences, 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
.maxOccurrences
- The maximum number of times this argument may be
provided on the command line. A value less than
or equal to zero indicates that it may be present
any number of times.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.Method Detail |
---|
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.protected boolean hasDefaultValue()
hasDefaultValue
in class Argument
true
if this argument has one or more default values, or
false
if not.public java.lang.String getDataTypeName()
getDataTypeName
in class Argument
public java.lang.String getValueConstraints()
getValueConstraints
in class Argument
null
if there are none.public BooleanArgument getCleanCopy()
getCleanCopy
in class Argument
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 |