Overview Package Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

org.apache.tools.ant.types.selectors

Class DateSelector

Implemented Interfaces:
ExtendFileSelector, FileSelector, Parameterizable
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

Fields inherited from class org.apache.tools.ant.types.selectors.BaseExtendSelector

parameters

Fields inherited from class org.apache.tools.ant.types.DataType

checked, description, ref

Fields inherited from class org.apache.tools.ant.ProjectComponent

project

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

Methods inherited from class org.apache.tools.ant.types.selectors.BaseExtendSelector

getParameters, isSelected, setParameters

Methods inherited from class org.apache.tools.ant.types.selectors.BaseSelector

getError, isSelected, setError, validate, verifySettings

Methods inherited from class org.apache.tools.ant.types.DataType

checkAttributesAllowed, checkChildrenAllowed, circularReference, dieOnCircularReference, getCheckedRef, getDescription, getRefid, isChecked, isReference, noChildrenAllowed, setChecked, setDescription, setRefid, tooManyAttributes

Methods inherited from class org.apache.tools.ant.ProjectComponent

getProject, log, log, setProject

Field Details

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 Details

DateSelector

public DateSelector()
Creates a new DateSelector instance.

Method Details

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.
Specified by:
isSelected in interface FileSelector
Overrides:
isSelected in interface BaseExtendSelector

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

Returns:
whether the file should be selected or not

setCheckdirs

public void setCheckdirs(boolean includeDirs)
Should we be checking 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

Parameters:
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.

Parameters:
granularity - the number of milliconds leeway

setMillis

public void setMillis(long millis)
For users that prefer to express time in milliseconds 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.
Specified by:
setParameters in interface Parameterizable
Overrides:
setParameters in interface BaseExtendSelector

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 cmp)
Sets the type of comparison to be done on the file's last modified date.

Parameters:
cmp - The comparison to perform, an EnumeratedAttribute

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.
Overrides:
verifySettings in interface BaseSelector

Overview Package Tree Index Deprecated About
Copyright B) 2000-2005 Apache Software Foundation. All Rights Reserved.