|
|||||||||
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.ScopeArgument
@Mutable @ThreadSafety(level=NOT_THREADSAFE) public final class ScopeArgument
This class defines an argument that is intended to hold one search scope values. Scope arguments must take values, and those arguments must represent valid search scopes. Supported scope values include:
Constructor Summary | |
---|---|
ScopeArgument(java.lang.Character shortIdentifier,
java.lang.String longIdentifier,
boolean isRequired,
java.lang.String valuePlaceholder,
java.lang.String description)
Creates a new search scope argument with the provided information. |
|
ScopeArgument(java.lang.Character shortIdentifier,
java.lang.String longIdentifier,
boolean isRequired,
java.lang.String valuePlaceholder,
java.lang.String description,
SearchScope defaultValue)
Creates a new search scope 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. |
ScopeArgument |
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. |
SearchScope |
getDefaultValue()
Retrieves the default value for this argument, which will be used if no value was provided. |
SearchScope |
getValue()
Retrieves the value for this argument, or the default value if none 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. |
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 ScopeArgument(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 must
not be 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 ScopeArgument(java.lang.Character shortIdentifier, java.lang.String longIdentifier, boolean isRequired, java.lang.String valuePlaceholder, java.lang.String description, SearchScope 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 must
not be null
.description
- A human-readable description for this argument.
It must not be null
.defaultValue
- The default value to use for this argument if no
values were provided. It may be null
if
there should be no default values.
ArgumentException
- If there is a problem with the definition of
this argument.Method Detail |
---|
public SearchScope getDefaultValue()
null
if there is
no default value.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 SearchScope getValue()
null
if there is no value and no default
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.String getDataTypeName()
getDataTypeName
in class Argument
public java.lang.String getValueConstraints()
getValueConstraints
in class Argument
null
if there are none.public ScopeArgument 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 |