public class DateSelector extends BaseExtendSelector
Modifier and Type | Class and Description |
---|---|
static class |
DateSelector.TimeComparisons
Enumerated attribute with the values for time comparison.
|
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CHECKDIRS_KEY
Key to used for parameterized custom selector
|
static java.lang.String |
DATETIME_KEY
Key to used for parameterized custom selector
|
static java.lang.String |
GRANULARITY_KEY
Key to used for parameterized custom selector
|
static java.lang.String |
MILLIS_KEY
Key to used for parameterized custom selector
|
static java.lang.String |
PATTERN_KEY
Key to used for parameterized custom selector
|
static java.lang.String |
WHEN_KEY
Key to used for parameterized custom selector
|
parameters
description, location, project
Constructor and Description |
---|
DateSelector()
Creates a new
DateSelector instance. |
Modifier and Type | Method and Description |
---|---|
long |
getMillis()
Returns the millisecond value the selector is set for.
|
boolean |
isSelected(java.io.File basedir,
java.lang.String filename,
java.io.File file)
The heart of the matter.
|
void |
setCheckdirs(boolean includeDirs)
Set whether to check dates on directories.
|
void |
setDatetime(java.lang.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(java.lang.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.
|
java.lang.String |
toString()
Basic DataType toString().
|
void |
verifySettings()
This is a consistency check to ensure the selector's required
values have been set.
|
getParameters
getError, setError, setError, validate
checkAttributesAllowed, checkChildrenAllowed, circularReference, clone, dieOnCircularReference, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, setRefid, tooManyAttributes
getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
public static final java.lang.String MILLIS_KEY
public static final java.lang.String DATETIME_KEY
public static final java.lang.String CHECKDIRS_KEY
public static final java.lang.String GRANULARITY_KEY
public static final java.lang.String WHEN_KEY
public static final java.lang.String PATTERN_KEY
public java.lang.String toString()
DataType
public void setMillis(long millis)
millis
- the time to compare file's last modified date to,
expressed in milliseconds.public long getMillis()
public void setDatetime(java.lang.String dateTime)
dateTime
- a formatted date String
.public void setCheckdirs(boolean includeDirs)
includeDirs
- whether to check the timestamp on directories.public void setGranularity(int granularity)
granularity
- the number of milliseconds leeway.public void setWhen(DateSelector.TimeComparisons tcmp)
tcmp
- The comparison to perform, an EnumeratedAttribute.public void setWhen(TimeComparison t)
t
- TimeComparison object.public void setPattern(java.lang.String pattern)
pattern
- the pattern that defines the date format.public void setParameters(Parameter[] parameters)
setParameters
in interface Parameterizable
setParameters
in class BaseExtendSelector
parameters
- the complete set of parameters for this selector.public void verifySettings()
verifySettings
in class BaseSelector
public boolean isSelected(java.io.File basedir, java.lang.String filename, java.io.File file)
isSelected
in interface FileSelector
isSelected
in class BaseExtendSelector
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.