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:
- java.lang.Cloneable,- Parameterizable,- ResourceSelector,- ExtendFileSelector,- FileSelector
 
 public class DateSelector extends BaseExtendSelector Selector that chooses files based on their last modified date.- Since:
- 1.5
 
- 
- 
Nested Class SummaryNested Classes Modifier and Type Class Description static classDateSelector.TimeComparisonsEnumerated attribute with the values for time comparison.
 - 
Field SummaryFields Modifier and Type Field Description static java.lang.StringCHECKDIRS_KEYKey to used for parameterized custom selectorstatic java.lang.StringDATETIME_KEYKey to used for parameterized custom selectorstatic java.lang.StringGRANULARITY_KEYKey to used for parameterized custom selectorstatic java.lang.StringMILLIS_KEYKey to used for parameterized custom selectorstatic java.lang.StringPATTERN_KEYKey to used for parameterized custom selectorstatic java.lang.StringWHEN_KEYKey to used for parameterized custom selector- 
Fields inherited from class org.apache.tools.ant.types.selectors.BaseExtendSelectorparameters
 - 
Fields inherited from class org.apache.tools.ant.ProjectComponentdescription, location, project
 
- 
 - 
Constructor SummaryConstructors Constructor Description DateSelector()
 - 
Method SummaryModifier and Type Method Description longgetMillis()Returns the millisecond value the selector is set for.booleanisSelected(java.io.File basedir, java.lang.String filename, java.io.File file)The heart of the matter.voidsetCheckdirs(boolean includeDirs)Set whether to check dates on directories.voidsetDatetime(java.lang.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(java.lang.String pattern)Sets the pattern to be used for the SimpleDateFormat.voidsetWhen(DateSelector.TimeComparisons tcmp)Sets the type of comparison to be done on the file's last modified date.voidsetWhen(TimeComparison t)Set the comparison type.java.lang.StringtoString()Basic DataType toString().voidverifySettings()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.BaseExtendSelectorgetParameters
 - 
Methods inherited from class org.apache.tools.ant.types.selectors.BaseSelectorgetError, setError, setError, validate
 - 
Methods inherited from class org.apache.tools.ant.types.DataTypecheckAttributesAllowed, checkChildrenAllowed, circularReference, clone, dieOnCircularReference, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, setRefid, tooManyAttributes
 - 
Methods inherited from class org.apache.tools.ant.ProjectComponentgetDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
 - 
Methods inherited from class java.lang.Objectequals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 - 
Methods inherited from interface org.apache.tools.ant.types.selectors.FileSelectorisSelected
 
- 
 
- 
- 
- 
Field Detail- 
MILLIS_KEYpublic static final java.lang.String MILLIS_KEY Key to used for parameterized custom selector- See Also:
- Constant Field Values
 
 - 
DATETIME_KEYpublic static final java.lang.String DATETIME_KEY Key to used for parameterized custom selector- See Also:
- Constant Field Values
 
 - 
CHECKDIRS_KEYpublic static final java.lang.String CHECKDIRS_KEY Key to used for parameterized custom selector- See Also:
- Constant Field Values
 
 - 
GRANULARITY_KEYpublic static final java.lang.String GRANULARITY_KEY Key to used for parameterized custom selector- See Also:
- Constant Field Values
 
 - 
WHEN_KEYpublic static final java.lang.String WHEN_KEY Key to used for parameterized custom selector- See Also:
- Constant Field Values
 
 - 
PATTERN_KEYpublic static final java.lang.String PATTERN_KEY Key to used for parameterized custom selector- See Also:
- Constant Field Values
 
 
- 
 - 
Method Detail- 
toStringpublic java.lang.String toString() Description copied from class:DataTypeBasic DataType toString().
 - 
setMillispublic 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.
 
 - 
getMillispublic long getMillis() Returns the millisecond value the selector is set for.- Returns:
- the millisecond value.
 
 - 
setDatetimepublic void setDatetime(java.lang.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.
 
 - 
setCheckdirspublic void setCheckdirs(boolean includeDirs) Set whether to check dates on directories.- Parameters:
- includeDirs- whether to check the timestamp on directories.
 
 - 
setGranularitypublic 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.
 
 - 
setWhenpublic 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.
 
 - 
setWhenpublic void setWhen(TimeComparison t) Set the comparison type.- Parameters:
- t- TimeComparison object.
 
 - 
setPatternpublic void setPattern(java.lang.String pattern) Sets the pattern to be used for the SimpleDateFormat.- Parameters:
- pattern- the pattern that defines the date format.
 
 - 
setParameterspublic 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:
- setParametersin interface- Parameterizable
- Overrides:
- setParametersin class- BaseExtendSelector
- Parameters:
- parameters- the complete set of parameters for this selector.
 
 - 
verifySettingspublic void verifySettings() This is a consistency check to ensure the selector's required values have been set.- Overrides:
- verifySettingsin class- BaseSelector
 
 - 
isSelectedpublic boolean isSelected(java.io.File basedir, java.lang.String filename, java.io.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:
- isSelectedin interface- FileSelector
- Specified by:
- isSelectedin class- BaseExtendSelector
- 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.
 
 
- 
 
-