Package com.unboundid.util.args

Class RequireDNInSubtreeArgumentValueValidator

java.lang.Object
com.unboundid.util.args.ArgumentValueValidator
com.unboundid.util.args.RequireDNInSubtreeArgumentValueValidator
All Implemented Interfaces:
Serializable
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class RequireDNInSubtreeArgumentValueValidator extends ArgumentValueValidator implements 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:

  • Constructor Details

    • 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 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 Details

    • getBaseDNs

      @NotNull public 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 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 String toString()
      Retrieves a string representation of this argument value validator.
      Overrides:
      toString in class Object
      Returns:
      A string representation of this argument value validator.

    • toString

      public void toString(@NotNull 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.