com.unboundid.util.args
Class DNArgument

java.lang.Object
  com.unboundid.util.args.Argument
      com.unboundid.util.args.DNArgument

All Implemented Interfaces:

java.io.Serializable

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

This class defines an argument that is intended to hold one or more distinguished name values. DN arguments must take values, and those values must be able to be parsed as distinguished names.

See Also:

Serialized Form

Constructor Summary

DNArgument(java.lang.Character shortIdentifier, java.lang.String longIdentifier, boolean isRequired, int maxOccurrences, java.lang.String valuePlaceholder, java.lang.String description)
Creates a new DN argument with the provided information.

DNArgument(java.lang.Character shortIdentifier, java.lang.String longIdentifier, boolean isRequired, int maxOccurrences, java.lang.String valuePlaceholder, java.lang.String description, DN defaultValue)
Creates a new DN argument with the provided information.

DNArgument(java.lang.Character shortIdentifier, java.lang.String longIdentifier, boolean isRequired, int maxOccurrences, java.lang.String valuePlaceholder, java.lang.String description, java.util.List<DN> defaultValues)
Creates a new DN 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.
DNArgument	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.util.List<DN>	getDefaultValues() Retrieves the list of default values for this argument, which will be used if no values were provided.
java.lang.String	getStringValue() Retrieves a string representation of the value for this argument, or a string representation of the default value if none was provided.
DN	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.
java.util.List<DN>	getValues() Retrieves the set of values for 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

DNArgument

public DNArgument(java.lang.Character shortIdentifier,
                  java.lang.String longIdentifier,
                  boolean isRequired,
                  int maxOccurrences,
                  java.lang.String valuePlaceholder,
                  java.lang.String description)
           throws ArgumentException

Creates a new DN 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.

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.

Throws:

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

DNArgument

public DNArgument(java.lang.Character shortIdentifier,
                  java.lang.String longIdentifier,
                  boolean isRequired,
                  int maxOccurrences,
                  java.lang.String valuePlaceholder,
                  java.lang.String description,
                  DN defaultValue)
           throws ArgumentException

Creates a new DN 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.

defaultValue - The default value to use for this argument if no values were provided.

Throws:

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

DNArgument

public DNArgument(java.lang.Character shortIdentifier,
                  java.lang.String longIdentifier,
                  boolean isRequired,
                  int maxOccurrences,
                  java.lang.String valuePlaceholder,
                  java.lang.String description,
                  java.util.List<DN> defaultValues)
           throws ArgumentException

Creates a new DN 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.

defaultValues - The set of default values to use for this argument if no values were provided.

Throws:

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

Method Detail

getDefaultValues

public java.util.List<DN> getDefaultValues()

Retrieves the list of default values for this argument, which will be used if no values were provided.

Returns:

The list of default values for this argument, or null if there are no default values.

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.

getValue

public DN getValue()

Retrieves the value for this argument, or the default value if none was provided. If there are multiple values, then the first will be returned.

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.

getValues

public java.util.List<DN> getValues()

Retrieves the set of values for this argument.

Returns:

The set of values for this argument.

getStringValue

public java.lang.String getStringValue()

Retrieves a string representation of the value for this argument, or a string representation of the default value if none was provided. If there are multiple values, then the first will be returned.

Returns:

The string representation of the value for this argument, or the string representation of the default value if none was provided, or null if there is no value and no default 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

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