net.dpml.cli.validation

Class DateValidator

java.lang.Object

net.dpml.cli.validation.DateValidator

All Implemented Interfaces:

Validator

public class DateValidator
extends java.lang.Object
implements Validator

The DateValidator validates the argument values are date or time value(s). The following example shows how to validate that an argument value(s) is a Date of the following type: d/M/yy (see DateFormat).

 DateFormat date = new SimpleDateFormat("d/M/yy");
 ...
 ArgumentBuilder builder = new ArgumentBuilder();
 Argument dateFormat =
     builder.withName("date");
            .withValidator(new DateValidator(dateFormat));
 

The following example shows how to validate that an argument value(s) is a time of the following type: HH:mm:ss (see DateFormat).

 DateFormat timeFormat = new SimpleDateFormat("HH:mm:ss");
 ...
 ArgumentBuilder builder = new ArgumentBuilder();
 Argument time =
     builder.withName("time");
            .withValidator(new DateValidator(timeFormat));
 

Version:

@PROJECT-VERSION@

Author:

@PUBLISHER-NAME@

See Also:

DateFormat

Constructor Summary

Constructors

Constructor and Description
DateValidator() Creates a Validator for the default date/time format
DateValidator(java.text.DateFormat format) Creates a Validator for the specified DateFormat.
DateValidator(java.util.List formats) Creates a Validator for the List of specified DateFormats.

Method Summary

Modifier and Type	Method and Description
static DateValidator	getDateInstance() Creates a Validator for dates.
static DateValidator	getDateTimeInstance() Creates a Validator for date/times
java.text.DateFormat[]	getFormats() Gets the date formats permitted.
java.util.Date	getMaximum() Returns the maximum date permitted.
java.util.Date	getMinimum() Returns the minimum date permitted.
static DateValidator	getTimeInstance() Creates a Validator for times.
boolean	isLeniant() Return the leaniant flag.
void	setFormat(java.text.DateFormat format) Sets the date format permitted.
void	setFormats(java.text.DateFormat[] formats) Sets the date formats permitted.
void	setFormats(java.util.List formats) Sets the date formats permitted.
void	setLeniant(boolean lenient) Set the leaniant flag.
void	setMaximum(java.util.Date maximum) Sets the maximum Date to the specified value.
void	setMinimum(java.util.Date minimum) Sets the minimum Date to the specified value.
void	validate(java.util.List values) Validate each String value in the specified List against this instances permitted DateFormats.

Methods inherited from class java.lang.Object

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

Constructor Detail

DateValidator

public DateValidator()

Creates a Validator for the default date/time format

DateValidator

public DateValidator(java.text.DateFormat format)

Creates a Validator for the specified DateFormat.

Parameters:

format - a DateFormat which dates must conform to

DateValidator

public DateValidator(java.util.List formats)

Creates a Validator for the List of specified DateFormats.

Parameters:

formats - a List of DateFormats which dates must conform to

Method Detail

getDateInstance

public static DateValidator getDateInstance()

Creates a Validator for dates.

Returns:

DateValidator a Validator for dates

getTimeInstance

public static DateValidator getTimeInstance()

Creates a Validator for times.

Returns:

DateValidator a Validator for times

getDateTimeInstance

public static DateValidator getDateTimeInstance()

Creates a Validator for date/times

Returns:

DateValidator a Validator for date/times

validate

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

Validate each String value in the specified List against this instances permitted DateFormats. If a value is valid then it's String value in the list is replaced with it's Date value.

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)

setLeniant

public void setLeniant(boolean lenient)

Set the leaniant flag.

Parameters:

lenient - true if leniant

isLeniant

public boolean isLeniant()

Return the leaniant flag.

Returns:

true if leniant

getMaximum

public java.util.Date getMaximum()

Returns the maximum date permitted.

Returns:

Date the maximum date permitted. If no maximum date has been specified then return null.

setMaximum

public void setMaximum(java.util.Date maximum)

Sets the maximum Date to the specified value.

Parameters:

maximum - the maximum Date permitted

getMinimum

public java.util.Date getMinimum()

Returns the minimum date permitted.

Returns:

Date the minimum date permitted. If no minimum date has been specified then return null.

setMinimum

public void setMinimum(java.util.Date minimum)

Sets the minimum Date to the specified value.

Parameters:

minimum - the minimum Date permitted

setFormat

public void setFormat(java.text.DateFormat format)

Sets the date format permitted.

Parameters:

format - the format to use

setFormats

public void setFormats(java.util.List formats)

Sets the date formats permitted.

Parameters:

formats - the List of DateFormats to use

setFormats

public void setFormats(java.text.DateFormat[] formats)

Sets the date formats permitted.

Parameters:

formats - the array of DateFormats to use

getFormats

public java.text.DateFormat[] getFormats()

Gets the date formats permitted.

Returns:

the permitted formats