Package com.unboundid.util.args

Class URLArgumentValueValidator

java.lang.Object
com.unboundid.util.args.ArgumentValueValidator
com.unboundid.util.args.URLArgumentValueValidator
All Implemented Interfaces:
Serializable
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class URLArgumentValueValidator extends ArgumentValueValidator implements Serializable
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 URLs. It can optionally restrict the URLs to a specified set of schemes.
See Also:

  • Constructor Details

    • URLArgumentValueValidator

      public URLArgumentValueValidator(@Nullable String... allowedSchemes)
      Creates a new instance of this URL argument value validator that will accept values that are URLs with any of the specified schemes.
      Parameters:
      allowedSchemes - The names of the schemes for the URLs that will be accepted. It may be null or empty if any scheme will be accepted.

    • URLArgumentValueValidator

      public URLArgumentValueValidator(@Nullable Collection<String> allowedSchemes)
      Creates a new instance of this URL argument value validator that will accept values that are URLs with any of the specified schemes.
      Parameters:
      allowedSchemes - The names of the schemes for the URLs that will be accepted. It may be null or empty if any scheme will be accepted.

  • Method Details

    • getAllowedSchemes

      @NotNull public Set<String> getAllowedSchemes()
      Retrieves the names of the schemes for the URLs that will be accepted.
      Returns:
      The names of the schemes for the URLs that will be accepted, or an empty set if URLs will be allowed to have any scheme.

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