com.unboundid.util.args

Class IA5StringArgumentValueValidator

java.lang.Object

com.unboundid.util.args.ArgumentValueValidator

com.unboundid.util.args.IA5StringArgumentValueValidator

All Implemented Interfaces:

java.io.Serializable

@NotMutable
@ThreadSafety(level=COMPLETELY_THREADSAFE)
public final class IA5StringArgumentValueValidator
extends ArgumentValueValidator
implements java.io.Serializable

This class provides an implementation of an argument value validator that ensures that values can be parsed as valid IA5 strings (that is, strings containing only ASCII characters).

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
IA5StringArgumentValueValidator() Creates a new IA5 string argument value validator.
IA5StringArgumentValueValidator(boolean allowEmptyStrings) Creates a new IA5 string argument value validator.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	allowEmptyStrings() Indicates whether empty strings should be considered valid.
java.lang.String	toString() Retrieves a string representation of this argument value validator.
void	toString(java.lang.StringBuilder buffer) Appends a string representation of this argument value validator to the provided buffer.
void	validateArgumentValue(Argument argument, java.lang.String valueString) Examines the value(s) assigned to the provided argument to determine whether they are acceptable.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

IA5StringArgumentValueValidator

public IA5StringArgumentValueValidator()

Creates a new IA5 string argument value validator. Empty strings will not be considered valid.

IA5StringArgumentValueValidator

public IA5StringArgumentValueValidator(boolean allowEmptyStrings)

Creates a new IA5 string argument value validator.

Parameters:

allowEmptyStrings - Indicates whether empty strings will be considered valid.

Method Detail

validateArgumentValue

public void validateArgumentValue(@NotNull
                         Argument argument,
                         @NotNull
                         java.lang.String valueString)
                           throws ArgumentException

Examines the value(s) assigned to the provided argument to determine whether they are acceptable.

Specified by:

validateArgumentValue in class ArgumentValueValidator

Parameters:

argument - The argument to which the value is being provided.

valueString - The string representation of the value to be validated. This value will have already passed any normal validation performed by the argument.

Throws:

ArgumentException - If the provided value is determined to be unacceptable.

allowEmptyStrings

public boolean allowEmptyStrings()

Indicates whether empty strings should be considered valid.

Returns:

true if empty strings should be considered valid, or false if not.

toString

@NotNull
public java.lang.String toString()

Retrieves a string representation of this argument value validator.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this argument value validator.

toString

public void toString(@NotNull
            java.lang.StringBuilder buffer)

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

Parameters:

buffer - The buffer to which the string representation should be appended.