Package com.unboundid.util.args
Class ArgumentListArgument
- java.lang.Object
-
- com.unboundid.util.args.Argument
-
- com.unboundid.util.args.ArgumentListArgument
-
- All Implemented Interfaces:
java.io.Serializable
@Mutable @ThreadSafety(level=NOT_THREADSAFE) public final class ArgumentListArgument extends Argument
This class defines an argument whose values are intended to be argument strings as might be provided to a command-line application (e.g., "--arg1 arg1value --arg2 --arg3 arg3value"). Instances of this argument will have their own argument parser that may be used to process the argument strings. This type of argument may not be particularly useful for use in command-line applications, but may be used in other applications that may use arguments in other ways.- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description ArgumentListArgument(java.lang.Character shortIdentifier, java.lang.String longIdentifier, boolean isRequired, int maxOccurrences, java.lang.String valuePlaceholder, java.lang.String description, ArgumentParser parser)
Creates a new argument list argument with the provided information.ArgumentListArgument(java.lang.Character shortIdentifier, java.lang.String longIdentifier, java.lang.String description, ArgumentParser parser)
Creates a new argument list argument with the provided information.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description 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.ArgumentListArgument
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.ArgumentParser
getCleanParser()
Retrieves a "clean" copy of the argument parser that will be used to process values provided for this argument.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.java.util.List<ArgumentParser>
getValueParsers()
Retrieves the list of argument parsers that have been used to process values provided to 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.java.util.List<java.lang.String>
getValueStrings()
Retrieves the list of the string representations of the values provided to 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.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, 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
-
-
-
-
Constructor Detail
-
ArgumentListArgument
public ArgumentListArgument(@Nullable java.lang.Character shortIdentifier, @Nullable java.lang.String longIdentifier, @NotNull java.lang.String description, @NotNull ArgumentParser parser) throws ArgumentException
Creates a new argument list argument with the provided information. It will not be required, will permit at most one occurrence, and will use a default placeholder.- Parameters:
shortIdentifier
- The short identifier for this argument. It may not benull
if the long identifier isnull
.longIdentifier
- The long identifier for this argument. It may not benull
if the short identifier isnull
.description
- A human-readable description for this argument. It must not benull
.parser
- The argument parser that will be used to process values provided for this argument.- Throws:
ArgumentException
- If there is a problem with the definition of this argument.
-
ArgumentListArgument
public ArgumentListArgument(@Nullable java.lang.Character shortIdentifier, @Nullable java.lang.String longIdentifier, boolean isRequired, int maxOccurrences, @Nullable java.lang.String valuePlaceholder, @NotNull java.lang.String description, @NotNull ArgumentParser parser) throws ArgumentException
Creates a new argument list argument with the provided information.- Parameters:
shortIdentifier
- The short identifier for this argument. It may not benull
if the long identifier isnull
.longIdentifier
- The long identifier for this argument. It may not benull
if the short identifier isnull
.isRequired
- Indicates whether this argument is required to be provided.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.valuePlaceholder
- A placeholder to display in usage information to indicate that a value must be provided. It may benull
if a default placeholder should be used.description
- A human-readable description for this argument. It must not benull
.parser
- The argument parser that will be used to process values provided for this argument.- Throws:
ArgumentException
- If there is a problem with the definition of this argument.
-
-
Method Detail
-
getCleanParser
@NotNull public ArgumentParser getCleanParser()
Retrieves a "clean" copy of the argument parser that will be used to process values provided for this argument.- Returns:
- A "clean" copy of the argument parser that will be used to process values provided for this argument.
-
addValue
protected void addValue(@NotNull java.lang.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 classArgument
- 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.
-
getValueParsers
@NotNull public java.util.List<ArgumentParser> getValueParsers()
Retrieves the list of argument parsers that have been used to process values provided to this argument.- Returns:
- The list of argument parsers that have been used to process values provided to this argument.
-
getValueStrings
@NotNull public java.util.List<java.lang.String> getValueStrings()
Retrieves the list of the string representations of the values provided to this argument.- Returns:
- The list of the string representations of the values provided to this argument.
-
getValueStringRepresentations
@NotNull public java.util.List<java.lang.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 classArgument
- 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 classArgument
- Returns:
true
if this argument has one or more default values, orfalse
if not.
-
getDataTypeName
@NotNull public java.lang.String getDataTypeName()
Retrieves a concise name of the data type with which this argument is associated.- Specified by:
getDataTypeName
in classArgument
- Returns:
- A concise name of the data type with which this argument is associated.
-
getValueConstraints
@NotNull public java.lang.String getValueConstraints()
Retrieves a human-readable string with information about any constraints that may be imposed for values of this argument.- Overrides:
getValueConstraints
in classArgument
- 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 callsuper.reset()
to ensure that all necessary reset processing is performed.
-
getCleanCopy
@NotNull public ArgumentListArgument 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 classArgument
- Returns:
- The "clean" copy of this argument.
-
addToCommandLine
protected void addToCommandLine(@NotNull 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.- Specified by:
addToCommandLine
in classArgument
- Parameters:
argStrings
- The list to update with the string representation of the command-line arguments.
-
-