com.unboundid.util.args

Class ArgumentValueValidator

java.lang.Object

com.unboundid.util.args.ArgumentValueValidator

Direct Known Subclasses:

AttributeNameArgumentValueValidator, DNSHostNameArgumentValueValidator, IA5StringArgumentValueValidator, IPAddressArgumentValueValidator, LDAPURLArgumentValueValidator, OIDArgumentValueValidator, ProhibitDNInSubtreeArgumentValueValidator, RegularExpressionArgumentValueValidator, RequireDNInSubtreeArgumentValueValidator, TimestampRangeArgumentValueValidator, URLArgumentValueValidator

@Extensible
 @ThreadSafety(level=INTERFACE_NOT_THREADSAFE)
public abstract class ArgumentValueValidator
extends java.lang.Object

This class defines an API that may be used to create argument value validators, which can be used to enforce additional constraints on the values provided to an argument.

Constructor Summary

Constructors

Constructor and Description
ArgumentValueValidator()

Method Summary

Modifier and Type	Method and Description
abstract 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, toString, wait, wait, wait

Constructor Detail

ArgumentValueValidator

public ArgumentValueValidator()

Method Detail

validateArgumentValue

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

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.