org.apache.tools.ant.types.selectors
public class SizeSelector extends BaseExtendSelector
Since: 1.5
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 String | SIZE_KEY Used for parameterized custom selector |
static String | UNITS_KEY Used for parameterized custom selector |
static String | WHEN_KEY Used for parameterized custom selector |
Constructor Summary | |
---|---|
SizeSelector()
Creates a new SizeSelector instance.
|
Method Summary | |
---|---|
boolean | isSelected(File basedir, String filename, 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 scmp)
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.
|
String | toString()
Returns a String object representing the specified
SizeSelector. |
void | verifySettings() Checks to make sure all settings are kosher. |
SizeSelector
instance.
Parameters: basedir A java.io.File object for the base directory. filename The name of the file to check. file A File object for this filename.
Returns: whether the file should be selected or not.
Parameters: parameters the complete set of parameters for this selector.
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.
Parameters: units The units to compare the size to, using an EnumeratedAttribute.
Parameters: size the size to select against expressed in units.
Parameters: scmp The comparison to perform, an EnumeratedAttribute.
String
object representing the specified
SizeSelector. This is "{sizeselector value: " + <"compare",
"less", "more", "equal"> + "}".Returns: a string describing this object
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.