|
SizeSelector (Apache Ant API)
org.apache.tools.ant.types.selectors
|
Nested Class Summary | |
static class |
SizeSelector.ByteUnits
Enumerated attribute with the values for units. |
static class |
SizeSelector.SizeComparisons
Enumerated attribute with the values for size comparison. |
Field Summary | |
static java.lang.String |
SIZE_KEY
|
static java.lang.String |
UNITS_KEY
|
static java.lang.String |
WHEN_KEY
|
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 | |
SizeSelector()
|
Method Summary | |
boolean |
isSelected(java.io.File basedir,
java.lang.String filename,
java.io.File file)
The heart of the matter. |
void |
setParameters(Parameter[] parameters)
When using this as a custom selector, this method will be called. |
void |
setUnits(SizeSelector.ByteUnits units)
Sets the units to use for the comparison. |
void |
setValue(long size)
A size selector needs to know what size to base its selecting on. |
void |
setWhen(SizeSelector.SizeComparisons cmp)
This specifies when the file should be selected, whether it be when the file matches a particular size, when it is smaller, or whether it is larger. |
java.lang.String |
toString()
|
void |
verifySettings()
Checks to make sure all settings are kosher. |
Methods inherited from class org.apache.tools.ant.types.selectors.BaseExtendSelector |
getParameters |
Methods inherited from class org.apache.tools.ant.types.selectors.BaseSelector |
getError, setError, validate |
Methods inherited from class org.apache.tools.ant.types.DataType |
circularReference, dieOnCircularReference, getCheckedRef, getDescription, isReference, noChildrenAllowed, setDescription, setRefid, tooManyAttributes |
Methods inherited from class org.apache.tools.ant.ProjectComponent |
getProject, log, log, setProject |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
public static final java.lang.String SIZE_KEY
public static final java.lang.String UNITS_KEY
public static final java.lang.String WHEN_KEY
Constructor Detail |
public SizeSelector()
Method Detail |
public java.lang.String toString()
toString
in class java.lang.Object
public void setValue(long size)
size
- the size to select against expressed in unitspublic void setUnits(SizeSelector.ByteUnits units)
To get around this complexity, a number of standards bodies have proposed the 2^10 standard, and at least one has adopted it. But we are still left with a populace that isn't clear on how capitalization should work.
We therefore ignore capitalization as much as possible. Completely mixed case is not possible, but all upper and lower forms are accepted for all long and short forms. Since we have no need to work with the 0.001 case, this practice works here.
This function translates all the long and short forms that a unit prefix can occur in and translates them into a single multiplier.
units
- The units to compare the size to, using an
EnumeratedAttributepublic void setWhen(SizeSelector.SizeComparisons cmp)
cmp
- The comparison to perform, an EnumeratedAttributepublic void setParameters(Parameter[] parameters)
setParameters
in interface Parameterizable
setParameters
in class BaseExtendSelector
parameters
- the complete set of parameters for this selectorpublic void verifySettings()
Checks to make sure all settings are kosher. In this case, it means that the size attribute has been set (to a positive value), that the multiplier has a valid setting, and that the size limit is valid. Since the latter is a calculated value, this can only fail due to a programming error.
If a problem is detected, the setError() method is called.
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
- A java.io.File object for the base directoryfilename
- The name of the file to checkfile
- A File object for this filename
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |