net.dpml.cli.validation

Class URLValidator

java.lang.Object

net.dpml.cli.validation.URLValidator

All Implemented Interfaces:

Validator

public class URLValidator
extends java.lang.Object
implements Validator

The URLValidator validates the string argument values are URLs. If the value is a URL, the string value in the List of values is replaced with the URL instance. URLs can also be validated based on their scheme by using the setProtocol method, or by using the specified constructor. The following example shows how to limit the valid values for the site argument to 'https' URLs.

 ...
 ArgumentBuilder builder = new ArgumentBuilder();
 Argument site =
     builder.withName("site");
            .withValidator(new URLValidator("https"));
 

Version:

@PROJECT-VERSION@

Author:

@PUBLISHER-NAME@

Constructor Summary

Constructors

Constructor and Description
URLValidator() Creates a URLValidator.
URLValidator(java.lang.String protocol) Creates a URLValidator for the specified protocol.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getProtocol() Returns the protocol that must be used by a valid URL.
void	setProtocol(java.lang.String protocol) Specifies the protocol that a URL must have to be valid.
void	validate(java.util.List values) Validate the list of values against the list of permitted values.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

URLValidator

public URLValidator()

Creates a URLValidator.

URLValidator

public URLValidator(java.lang.String protocol)

Creates a URLValidator for the specified protocol.

Parameters:

protocol - the url protocol

Method Detail

validate

public void validate(java.util.List values)
              throws InvalidArgumentException

Validate the list of values against the list of permitted values. If a value is valid, replace the string in the values List with the { java.net.URL} instance.

Specified by:

validate in interface Validator

Parameters:

values - the list of values to validate

Throws:

InvalidArgumentException - if a value is invalid

See Also:

Validator.validate(java.util.List)

getProtocol

public java.lang.String getProtocol()

Returns the protocol that must be used by a valid URL.

Returns:

the protocol that must be used by a valid URL.

setProtocol

public void setProtocol(java.lang.String protocol)

Specifies the protocol that a URL must have to be valid.

Parameters:

protocol - the protocol that a URL must have to be valid.