|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.unboundid.util.args.ArgumentValueValidator
com.unboundid.util.args.RequireDNInSubtreeArgumentValueValidator
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class RequireDNInSubtreeArgumentValueValidator
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.
Constructor Summary | |
---|---|
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 | |
---|---|
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 |
---|
public RequireDNInSubtreeArgumentValueValidator(DN... baseDNs)
baseDNs
- The set of permitted base DNs for values of the associated
argument. It must not be null
or empty.public RequireDNInSubtreeArgumentValueValidator(java.util.Collection<DN> baseDNs)
baseDNs
- The set of permitted base DNs for values of the associated
argument. It must not be null
or empty.Method Detail |
---|
public java.util.List<DN> getBaseDNs()
public void validateArgumentValue(Argument argument, java.lang.String valueString) throws ArgumentException
validateArgumentValue
in class ArgumentValueValidator
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.
ArgumentException
- If the provided value is determined to be
unacceptable.public java.lang.String toString()
toString
in class java.lang.Object
public void toString(java.lang.StringBuilder buffer)
buffer
- The buffer to which the string representation should be
appended.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |