| org.apache.tools.ant.types.selectors.BaseSelector
 org.apache.tools.ant.types.selectors.BaseExtendSelector
org.apache.tools.ant.types.selectors.SizeSelector
| SizeSelector | | public class SizeSelector extends BaseExtendSelector (Code) | | Selector that filters files based on their size.
since:
1.5 |
| Inner Class :public static class SizeComparisons extends Comparison | |
| Constructor Summary | |
| public | SizeSelector()
Creates a new SizeSelector instance. |
| Method Summary | |
| public boolean | isSelected(File basedir, String filename, File file)
The heart of the matter. | | public void | setParameters(Parameter[] parameters)
When using this as a custom selector, this method will be called. | | public void | setUnits(ByteUnits units)
Sets the units to use for the comparison. | | public void | setValue(long size)
A size selector needs to know what size to base its selecting on. | | public void | setWhen(SizeComparisons when)
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. | | public String | toString()
Returns a String object representing the specified
SizeSelector. | | public void | verifySettings()
Checks to make sure all settings are kosher. |
| SIZE_KEY | | final public static String SIZE_KEY(Code) | | Used for parameterized custom selector
|
| UNITS_KEY | | final public static String UNITS_KEY(Code) | | Used for parameterized custom selector
|
| WHEN_KEY | | final public static String WHEN_KEY(Code) | | Used for parameterized custom selector
|
| SizeSelector | | public SizeSelector()(Code) | | Creates a new SizeSelector instance.
|
| isSelected | | public boolean isSelected(File basedir, String filename, File file)(Code) | | The heart of the matter. This is where the selector gets to decide
on the inclusion of a file in a particular fileset.
Parameters:
basedir - A java.io.File object for the base directory.
Parameters:
filename - The name of the file to check.
Parameters:
file - A File object for this filename. whether the file should be selected or not. |
| setParameters | | public void setParameters(Parameter[] parameters)(Code) | | When using this as a custom selector, this method will be called.
It translates each parameter into the appropriate setXXX() call.
Parameters:
parameters - the complete set of parameters for this selector. |
| setUnits | | public void setUnits(ByteUnits units)(Code) | | Sets the units to use for the comparison. This is a little
complicated because common usage has created standards that
play havoc with capitalization rules. Thus, some people will
use "K" for indicating 1000's, when the SI standard calls for
"k". Others have tried to introduce "K" as a multiple of 1024,
but that falls down when you reach "M", since "m" is already
defined as 0.001.
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 anEnumeratedAttribute. |
| setValue | | public void setValue(long size)(Code) | | A size selector needs to know what size to base its selecting on.
This will be further modified by the multiplier to get an
actual size limit.
Parameters:
size - the size to select against expressed in units. |
| setWhen | | public void setWhen(SizeComparisons when)(Code) | | 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.
Parameters:
when - The comparison to perform, an EnumeratedAttribute. |
| toString | | public String toString()(Code) | | Returns a String object representing the specified
SizeSelector. This is "{sizeselector value: " + <"compare",
"less", "more", "equal"> + "}".
a string describing this object |
| verifySettings | | public void verifySettings()(Code) | | 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.
|
| Fields inherited from org.apache.tools.ant.types.selectors.BaseExtendSelector | protected Parameter[] parameters(Code)(Java Doc)
|
|
|