org.apache.tools.ant.types.selectors
Class DateSelector
- ExtendFileSelector, FileSelector, Parameterizable
public class DateSelector
Selector that chooses files based on their last modified date.
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
|
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) - Should we be checking 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) - For users that prefer to express time in milliseconds 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 cmp) - Sets the type of comparison to be done on the file's last modified
date.
|
String | toString()
|
void | verifySettings() - This is a consistency check to ensure the selector's required
values have been set.
|
checkAttributesAllowed , checkChildrenAllowed , circularReference , dieOnCircularReference , getCheckedRef , getDescription , getRefid , isChecked , isReference , noChildrenAllowed , setChecked , setDescription , setRefid , tooManyAttributes |
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
DateSelector
public DateSelector()
Creates a new DateSelector
instance.
getMillis
public long getMillis()
Returns the millisecond value the selector is set for.
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.
- isSelected in interface FileSelector
- isSelected in interface BaseExtendSelector
basedir
- the base directory the scan is being done fromfilename
- is the name of the file to checkfile
- is a java.io.File object the selector can use
- whether the file should be selected or not
setCheckdirs
public void setCheckdirs(boolean includeDirs)
Should we be checking dates on directories?
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
dateTime
- a string in MM/DD/YYYY HH:MM AM_PM format
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.
granularity
- the number of milliconds leeway
setMillis
public void setMillis(long millis)
For users that prefer to express time in milliseconds since 1970
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.
- setParameters in interface Parameterizable
- setParameters in interface BaseExtendSelector
parameters
- the complete set of parameters for this selector
setPattern
public void setPattern(String pattern)
Sets the pattern to be used for the SimpleDateFormat
pattern
- the pattern that defines the date format
setWhen
public void setWhen(DateSelector.TimeComparisons cmp)
Sets the type of comparison to be done on the file's last modified
date.
cmp
- The comparison to perform, an EnumeratedAttribute
toString
public String toString()
- a string describing this object
verifySettings
public void verifySettings()
This is a consistency check to ensure the selector's required
values have been set.
- verifySettings in interface BaseSelector
Copyright B) 2000-2008 Apache Software Foundation. All Rights Reserved.