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 class	Length.FileMode EnumeratedAttribute operation mode
static class	Length.When EnumeratedAttribute for the when attribute.

Method Summary
void	add(FileSet fs) Add a FileSet.
void	add(ResourceCollection c) Add a ResourceCollection.
boolean	eval() Fulfill the condition contract.
void	execute() Execute the length task.
boolean	getTrim() Learn whether strings will be trimmed.
void	setFile(File file) Set the single file for this task.
void	setLength(long ell) Set the target count number for use as a Condition.
void	setMode(Length.FileMode m) Set the execution mode for working with files.
void	setProperty(String property) The property in which the length will be stored.
void	setString(String string) Set the string whose length to get.
void	setTrim(boolean trim) Set whether to trim in string mode.
void	setWhen(Length.When w) Set the comparison for use as a Condition.
void	setWhen(Comparison c) Set the comparison for use as a Condition.

Method Detail

add

public void add(FileSet fs)

Add a FileSet.

Parameters: fs the FileSet to add.

add

public void add(ResourceCollection c)

Add a ResourceCollection.

Parameters: c the ResourceCollection to add.

Since: Ant 1.7

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 for use as a Condition.

Parameters: w EnumeratedAttribute When.

See Also: Comparison

setWhen

public void setWhen(Comparison c)

Set the comparison for use as a Condition.

Parameters: c Comparison.

Since: Ant 1.7

See Also: Comparison