org.apache.tools.ant.taskdefs

Class Length

public class Length extends Task implements Condition

Gets lengths: of files/resources, byte size; of strings, length (optionally trimmed). The task is overloaded in this way for semantic reasons, much like Available.

Since: Ant 1.6.3

Nested Class Summary
static classLength.FileMode
EnumeratedAttribute operation mode
static classLength.When
EnumeratedAttribute for the when attribute.
Method Summary
voidadd(FileSet fs)
Add a FileSet.
booleaneval()
Fulfill the condition contract.
voidexecute()
Execute the length task.
booleangetTrim()
Learn whether strings will be trimmed.
voidsetFile(File file)
Set the single file for this task.
voidsetLength(long ell)
Set the target count number for use as a Condition.
voidsetMode(Length.FileMode m)
Set the execution mode for working with files.
voidsetProperty(String property)
The property in which the length will be stored.
voidsetString(String string)
Set the string whose length to get.
voidsetTrim(boolean trim)
Set whether to trim in string mode.
voidsetWhen(Length.When w)
Set the comparison criteria for use as a Condition: "equal", "greater", "less".

Method Detail

add

public void add(FileSet fs)
Add a FileSet.

Parameters: fs the FileSet to add.

eval

public boolean eval()
Fulfill the condition contract.

Returns: true if the condition is true.

Throws: BuildException if an error occurs.

execute

public void execute()
Execute the length task.

getTrim

public boolean getTrim()
Learn whether strings will be trimmed.

Returns: boolean trim setting.

setFile

public void setFile(File file)
Set the single file for this task.

Parameters: file the File whose length to retrieve.

setLength

public void setLength(long ell)
Set the target count number for use as a Condition.

Parameters: ell the long length to compare with.

setMode

public void setMode(Length.FileMode m)
Set the execution mode for working with files.

Parameters: m the FileMode to use.

setProperty

public void setProperty(String property)
The property in which the length will be stored.

Parameters: property the String property key.

setString

public void setString(String string)
Set the string whose length to get.

Parameters: string String.

setTrim

public void setTrim(boolean trim)
Set whether to trim in string mode.

Parameters: trim boolean.

setWhen

public void setWhen(Length.When w)
Set the comparison criteria for use as a Condition: "equal", "greater", "less". Default is "equal".

Parameters: w EnumeratedAttribute When.

Copyright