Class DateSelector
java.lang.Object
org.apache.tools.ant.ProjectComponent
org.apache.tools.ant.types.DataType
org.apache.tools.ant.types.selectors.BaseSelector
org.apache.tools.ant.types.selectors.BaseExtendSelector
org.apache.tools.ant.types.selectors.DateSelector
- All Implemented Interfaces:
Cloneable,Parameterizable,ResourceSelector,ExtendFileSelector,FileSelector
Selector that chooses files based on their last modified date.
- Since:
- 1.5
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classEnumerated attribute with the values for time comparison. -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringKey to used for parameterized custom selectorstatic final StringKey to used for parameterized custom selectorstatic final StringKey to used for parameterized custom selectorstatic final StringKey to used for parameterized custom selectorstatic final StringKey to used for parameterized custom selectorstatic final StringKey to used for parameterized custom selectorFields inherited from class org.apache.tools.ant.types.selectors.BaseExtendSelector
parametersFields inherited from class org.apache.tools.ant.ProjectComponent
description, location, project -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionlongReturns the millisecond value the selector is set for.booleanisSelected(File basedir, String filename, File file) The heart of the matter.voidsetCheckdirs(boolean includeDirs) Set whether to check dates on directories.voidsetDatetime(String dateTime) Sets the date.voidsetGranularity(int granularity) Sets the number of milliseconds leeway we will give before we consider a file not to have matched a date.voidsetMillis(long millis) Set the time; for users who prefer to express time in ms since 1970.voidsetParameters(Parameter... parameters) When using this as a custom selector, this method will be called.voidsetPattern(String pattern) Sets the pattern to be used for the SimpleDateFormat.voidSets the type of comparison to be done on the file's last modified date.voidSet the comparison type.toString()Basic DataType toString().voidThis 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
getParametersMethods inherited from class org.apache.tools.ant.types.selectors.BaseSelector
getError, setError, setError, validateMethods inherited from class org.apache.tools.ant.types.DataType
checkAttributesAllowed, checkChildrenAllowed, circularReference, clone, dieOnCircularReference, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, setRefid, tooManyAttributesMethods inherited from class org.apache.tools.ant.ProjectComponent
getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProjectMethods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface org.apache.tools.ant.types.selectors.FileSelector
isSelected
-
Field Details
-
MILLIS_KEY
Key to used for parameterized custom selector- See Also:
-
DATETIME_KEY
Key to used for parameterized custom selector- See Also:
-
CHECKDIRS_KEY
Key to used for parameterized custom selector- See Also:
-
GRANULARITY_KEY
Key to used for parameterized custom selector- See Also:
-
WHEN_KEY
Key to used for parameterized custom selector- See Also:
-
PATTERN_KEY
Key to used for parameterized custom selector- See Also:
-
-
Constructor Details
-
DateSelector
public DateSelector()
-
-
Method Details
-
toString
Description copied from class:DataTypeBasic DataType toString(). -
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.
-
getMillis
public long getMillis()Returns the millisecond value the selector is set for.- Returns:
- the millisecond value.
-
setDatetime
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 dateString.
-
setCheckdirs
public void setCheckdirs(boolean includeDirs) Set whether to check dates on directories.- Parameters:
includeDirs- whether to check the timestamp on directories.
-
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.
-
setWhen
Sets the type of comparison to be done on the file's last modified date.- Parameters:
tcmp- The comparison to perform, an EnumeratedAttribute.
-
setWhen
Set the comparison type.- Parameters:
t- TimeComparison object.
-
setPattern
Sets the pattern to be used for the SimpleDateFormat.- Parameters:
pattern- the pattern that defines the date format.
-
setParameters
When using this as a custom selector, this method will be called. It translates each parameter into the appropriate setXXX() call.- Specified by:
setParametersin interfaceParameterizable- Overrides:
setParametersin classBaseExtendSelector- Parameters:
parameters- the complete set of parameters for this selector.
-
verifySettings
public void verifySettings()This is a consistency check to ensure the selector's required values have been set.- Overrides:
verifySettingsin classBaseSelector
-
isSelected
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:
isSelectedin interfaceFileSelector- Specified by:
isSelectedin classBaseExtendSelector- 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.
-