Package com.unboundid.util.args

Class ScopeArgument

java.lang.Object

com.unboundid.util.args.Argument

com.unboundid.util.args.ScopeArgument

All Implemented Interfaces:

Serializable

@Mutable
@ThreadSafety(level=NOT_THREADSAFE)
public final class ScopeArgument
extends Argument

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:

• baseObject scope -- base, baseObject, base-object, 0
• singleLevel scope -- one, singleLevel, single-level, oneLevel, one-level, 1
• wholeSubtree scope -- sub, subtree, wholeSubtree, whole-subtree, 2
• subordinateSubtree scope -- subord, subordinate, subordinates, subordinateSubtree, subordinate-subtree, 3

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
ScopeArgument(Character shortIdentifier, String longIdentifier, boolean isRequired, String valuePlaceholder, String description)	Creates a new search scope argument with the provided information.
ScopeArgument(Character shortIdentifier, String longIdentifier, boolean isRequired, String valuePlaceholder, String description, SearchScope defaultValue)	Creates a new search scope argument with the provided information.
ScopeArgument(Character shortIdentifier, String longIdentifier, String description)	Creates a new search scope argument with the provided information.

Method Summary

Modifier and Type	Method	Description
protected void	addToCommandLine(List<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(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.
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.
String	getValueConstraints()	Retrieves a human-readable string with information about any constraints that may be imposed for values of this argument.
List<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(StringBuilder buffer)	Appends a string representation of this argument to the provided buffer.

Methods inherited from class com.unboundid.util.args.Argument

addLongIdentifier, addLongIdentifier, addShortIdentifier, addShortIdentifier, appendBasicToStringInfo, getArgumentGroupName, getDescription, getIdentifierString, getLongIdentifier, getLongIdentifiers, getLongIdentifiers, getMaxOccurrences, getNumOccurrences, getShortIdentifier, getShortIdentifiers, 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 Details

ScopeArgument

public ScopeArgument(@Nullable
 Character shortIdentifier,
 @Nullable
 String longIdentifier,
 @NotNull
 String description)
              throws ArgumentException

Creates a new search scope argument with the provided information. It will not be required, will use a default placeholder, and will not have a default value.

Parameters:

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.

Throws:

ArgumentException - If there is a problem with the definition of this argument.

ScopeArgument

public ScopeArgument(@Nullable
 Character shortIdentifier,
 @Nullable
 String longIdentifier,
 boolean isRequired,
 @Nullable
 String valuePlaceholder,
 @NotNull
 String description)
              throws ArgumentException

Creates a new search scope argument with the provided information. It will not have a default value.

Parameters:

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.

Throws:

ArgumentException - If there is a problem with the definition of this argument.

ScopeArgument

public ScopeArgument(@Nullable
 Character shortIdentifier,
 @Nullable
 String longIdentifier,
 boolean isRequired,
 @Nullable
 String valuePlaceholder,
 @NotNull
 String description,
 @Nullable
 SearchScope defaultValue)
              throws ArgumentException

Creates a new search scope argument with the provided information.

Parameters:

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 to use for this argument if no values were provided. It may be null if there should be no default values.

Throws:

ArgumentException - If there is a problem with the definition of this argument.

Method Details

getDefaultValue

@Nullable
public SearchScope getDefaultValue()

Retrieves the default value for this argument, which will be used if no value was provided.

Returns:

The default value for this argument, or null if there is no default value.

addValue

protected void addValue(@NotNull
 String valueString)
                 throws ArgumentException

Adds the provided value to the set of values for this argument. This method should only be called by the argument parser.

Specified by:

addValue in class Argument

Parameters:

valueString - The string representation of the value.

Throws:

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.

getValue

@Nullable
public SearchScope getValue()

Retrieves the value for this argument, or the default value if none was provided.

Returns:

The value for this argument, or the default value if none was provided, or null if there is no value and no default value.

getValueStringRepresentations

@NotNull
public List<String> getValueStringRepresentations(boolean useDefault)

Retrieves a list containing the string representations of the values for this argument, if any. The list returned does not necessarily need to include values that will be acceptable to the argument, but it should imply what the values are (e.g., in the case of a boolean argument that doesn't take a value, it may be the string "true" or "false" even if those values are not acceptable to the argument itself).

Specified by:

getValueStringRepresentations in class Argument

Parameters:

useDefault - Indicates whether to use any configured default value if the argument doesn't have a user-specified value.

Returns:

A string representation of the value for this argument, or an empty list if the argument does not have a value.

hasDefaultValue

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.

Specified by:

hasDefaultValue in class Argument

Returns:

true if this argument has one or more default values, or false if not.

getDataTypeName

@NotNull
public String getDataTypeName()

Retrieves a concise name of the data type with which this argument is associated.

Specified by:

getDataTypeName in class Argument

Returns:

A concise name of the data type with which this argument is associated.

getValueConstraints

@NotNull
public String getValueConstraints()

Retrieves a human-readable string with information about any constraints that may be imposed for values of this argument.

Overrides:

getValueConstraints in class Argument

Returns:

A human-readable string with information about any constraints that may be imposed for values of this argument, or null if there are none.

reset

protected void reset()

Resets this argument so that it appears in the same form as before it was used to parse arguments. Subclasses that override this method must call super.reset() to ensure that all necessary reset processing is performed.

Overrides:

reset in class Argument

getCleanCopy

@NotNull
public 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. The new argument will have all of the same identifiers and constraints as this parser.

Specified by:

getCleanCopy in class Argument

Returns:

The "clean" copy of this argument.

addToCommandLine

protected void addToCommandLine(@NotNull
 List<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.

Specified by:

addToCommandLine in class Argument

Parameters:

argStrings - The list to update with the string representation of the command-line arguments.

toString

public void toString(@NotNull
 StringBuilder buffer)

Appends a string representation of this argument to the provided buffer.

Specified by:

toString in class Argument

Parameters:

buffer - The buffer to which the information should be appended.