com.unboundid.util.args

Class RequireDNInSubtreeArgumentValueValidator

java.lang.Object

com.unboundid.util.args.ArgumentValueValidator

com.unboundid.util.args.RequireDNInSubtreeArgumentValueValidator

All Implemented Interfaces:

java.io.Serializable

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

This class provides an implementation of an argument value validator that is expected to be used with string or DN arguments and ensures that all values for the argument are valid DNs that are within one or more specified subtrees.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
RequireDNInSubtreeArgumentValueValidator(java.util.Collection<DN> baseDNs) Creates a new instance of this argument value validator with the provided information.
RequireDNInSubtreeArgumentValueValidator(DN... baseDNs) Creates a new instance of this argument value validator with the provided information.

Method Summary

Modifier and Type	Method and Description
java.util.List<DN>	getBaseDNs() Retrieves a list of the permitted base DNs for this argument value validator.
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

RequireDNInSubtreeArgumentValueValidator

public RequireDNInSubtreeArgumentValueValidator(@NotNull
                                                DN... baseDNs)

Creates a new instance of this argument value validator with the provided information.

Parameters:

baseDNs - The set of permitted base DNs for values of the associated argument. It must not be null or empty.

RequireDNInSubtreeArgumentValueValidator

public RequireDNInSubtreeArgumentValueValidator(@NotNull
                                                java.util.Collection<DN> baseDNs)

Creates a new instance of this argument value validator with the provided information.

Parameters:

baseDNs - The set of permitted base DNs for values of the associated argument. It must not be null or empty.

Method Detail

getBaseDNs

@NotNull
public java.util.List<DN> getBaseDNs()

Retrieves a list of the permitted base DNs for this argument value validator.

Returns:

A list of the permitted base DNs for this argument value validator.

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.

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.