org.apache.tools.ant.types.selectors

Class DateSelector

public class DateSelector extends BaseExtendSelector

Selector that chooses files based on their last modified date.

Since: 1.5

Nested Class Summary
static class	DateSelector.TimeComparisons Enumerated attribute with the values for time comparison.

Field Summary
static String	CHECKDIRS_KEY Key to used for parameterized custom selector
static String	DATETIME_KEY Key to used for parameterized custom selector
static String	GRANULARITY_KEY Key to used for parameterized custom selector
static String	MILLIS_KEY Key to used for parameterized custom selector
static String	PATTERN_KEY Key to used for parameterized custom selector
static String	WHEN_KEY Key to used for parameterized custom selector

Constructor Summary
	DateSelector() Creates a new `DateSelector` instance.

Method Summary
long	getMillis() Returns the millisecond value the selector is set for.
boolean	isSelected(File basedir, String filename, File file) The heart of the matter.
void	setCheckdirs(boolean includeDirs) Set whether to check dates on directories.
void	setDatetime(String dateTime) Sets the date.
void	setGranularity(int granularity) Sets the number of milliseconds leeway we will give before we consider a file not to have matched a date.
void	setMillis(long millis) Set the time; for users who prefer to express time in ms since 1970.
void	setParameters(Parameter[] parameters) When using this as a custom selector, this method will be called.
void	setPattern(String pattern) Sets the pattern to be used for the SimpleDateFormat.
void	setWhen(DateSelector.TimeComparisons tcmp) Sets the type of comparison to be done on the file's last modified date.
void	setWhen(TimeComparison t) Set the comparison type.
String	toString()
void	verifySettings() This is a consistency check to ensure the selector's required values have been set.

Field Detail

CHECKDIRS_KEY

public static final String CHECKDIRS_KEY

Key to used for parameterized custom selector

DATETIME_KEY

public static final String DATETIME_KEY

Key to used for parameterized custom selector

GRANULARITY_KEY

public static final String GRANULARITY_KEY

Key to used for parameterized custom selector

MILLIS_KEY

public static final String MILLIS_KEY

Key to used for parameterized custom selector

PATTERN_KEY

public static final String PATTERN_KEY

Key to used for parameterized custom selector

WHEN_KEY

public static final String WHEN_KEY

Key to used for parameterized custom selector

Constructor Detail

DateSelector

public DateSelector()

Creates a new DateSelector instance.

Method Detail

getMillis

public long getMillis()

Returns the millisecond value the selector is set for.

Returns: the millisecond value.

isSelected

public boolean isSelected(File basedir, String filename, File file)

The heart of the matter. This is where the selector gets to decide on the inclusion of a file in a particular fileset.

Parameters: basedir the base directory from which the scan is being performed. filename is the name of the file to check. file is a java.io.File object the selector can use.

Returns: whether the file is selected.

setCheckdirs

public void setCheckdirs(boolean includeDirs)

Set whether to check dates on directories.

Parameters: includeDirs whether to check the timestamp on directories.

setDatetime

public void setDatetime(String dateTime)

Sets the date. The user must supply it in MM/DD/YYYY HH:MM AM_PM format, unless an alternate pattern is specified via the pattern attribute.

Parameters: dateTime a formatted date String.

setGranularity

public void setGranularity(int granularity)

Sets the number of milliseconds leeway we will give before we consider a file not to have matched a date.

Parameters: granularity the number of milliseconds leeway.

setMillis

public void setMillis(long millis)

Set the time; for users who prefer to express time in ms since 1970.

Parameters: millis the time to compare file's last modified date to, expressed in milliseconds.

setParameters

public void setParameters(Parameter[] parameters)

When using this as a custom selector, this method will be called. It translates each parameter into the appropriate setXXX() call.

Parameters: parameters the complete set of parameters for this selector.

setPattern

public void setPattern(String pattern)

Sets the pattern to be used for the SimpleDateFormat.

Parameters: pattern the pattern that defines the date format.

setWhen

public void setWhen(DateSelector.TimeComparisons tcmp)

Sets the type of comparison to be done on the file's last modified date.

Parameters: tcmp The comparison to perform, an EnumeratedAttribute.

setWhen

public void setWhen(TimeComparison t)

Set the comparison type.

Parameters: t TimeComparison object.

toString

public String toString()

Returns: a string describing this object

verifySettings

public void verifySettings()

This is a consistency check to ensure the selector's required values have been set.