com.unboundid.util.args
Class ArgumentListArgument

java.lang.Object
  extended by com.unboundid.util.args.Argument
      extended by 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
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.
 
Method Summary
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> 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.
 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

ArgumentListArgument

public ArgumentListArgument(java.lang.Character shortIdentifier,
                            java.lang.String longIdentifier,
                            boolean isRequired,
                            int maxOccurrences,
                            java.lang.String valuePlaceholder,
                            java.lang.String description,
                            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 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.
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 must not be null.
description - A human-readable description for this argument. It must not be null.
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

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(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 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.

getValueParsers

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

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.

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

public java.lang.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

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 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.

getCleanCopy

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 The new parser will have all of the same arguments and constraints as this parser.

Specified by:
getCleanCopy in class Argument
Returns:
The "clean" copy of this argument.

toString

public void toString(java.lang.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.