|
|||||||||
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.LDAPURLArgumentValueValidator
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class LDAPURLArgumentValueValidator
This class provides an implementation of an argument value validator that is expected to be used with a string argument and ensures that all values for the argument are valid LDAP URLs. It can optionally indicate which elements are required to be present in the URL.
Constructor Summary | |
---|---|
LDAPURLArgumentValueValidator()
Creates a new instance of this LDAP URL argument value validator that will accept values that represent any valid LDAP URL. |
|
LDAPURLArgumentValueValidator(boolean requireHost,
boolean requirePort,
boolean requireBaseDN,
boolean requireAttributes,
boolean requireScope,
boolean requireFilter)
Creates a new instance of this LDAP URL argument value validator that will accept values that represent valid LDAP URLs with the specified constraints. |
Method Summary | |
---|---|
boolean |
requireAttributes()
Indicates whether LDAP URL values are required to include the attributes element with at least one attribute description. |
boolean |
requireBaseDN()
Indicates whether LDAP URL values are required to include a non-empty base DN element. |
boolean |
requireFilter()
Indicates whether LDAP URL values are required to include the filter element. |
boolean |
requireHost()
Indicates whether LDAP URL values are required to include the host element. |
boolean |
requirePort()
Indicates whether LDAP URL values are required to include the port element. |
boolean |
requireScope()
Indicates whether LDAP URL values are required to include the scope element. |
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 LDAPURLArgumentValueValidator()
public LDAPURLArgumentValueValidator(boolean requireHost, boolean requirePort, boolean requireBaseDN, boolean requireAttributes, boolean requireScope, boolean requireFilter)
requireHost
- Indicates whether LDAP URL values are required
to include the host element.requirePort
- Indicates whether LDAP URL values are required
to include the port element.requireBaseDN
- Indicates whether LDAP URL values are required
to include a non-empty base DN element.requireAttributes
- Indicates whether LDAP URL values are required
to include an attribute list with at least one
attribute description.requireScope
- Indicates whether LDAP URL values are required
to include the scope element.requireFilter
- Indicates whether LDAP URL values are required
to include the filter element.Method Detail |
---|
public boolean requireHost()
true
if LDAP URL values are required to include the host
element, or false
if not.public boolean requirePort()
true
if LDAP URL values are required to include the port
element, or false
if not.public boolean requireBaseDN()
true
if LDAP URL values are required to include a
non-empty base DN element, or false
if not.public boolean requireAttributes()
true
if LDAP URL values are required to include the
attributes element, or false
if not.public boolean requireScope()
true
if LDAP URL values are required to include the scope
element, or false
if not.public boolean requireFilter()
true
if LDAP URL values are required to include the filter
element, or false
if not.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 |