org.apache.tools.ant.taskdefs

Class Length

Implemented Interfaces:
Condition

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.

Field Summary

Fields inherited from class org.apache.tools.ant.Task

description, location, target, taskName, taskType, wrapper

Fields inherited from class org.apache.tools.ant.ProjectComponent

project

Method Summary

void
add(FileSet fs)
Add a FileSet.
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 criteria for use as a Condition: "equal", "greater", "less".

Methods inherited from class org.apache.tools.ant.Task

execute, getDescription, getLocation, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, maybeConfigure, perform, reconfigure, setDescription, setLocation, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType

Methods inherited from class org.apache.tools.ant.ProjectComponent

getProject, log, log, setProject

Method Details

add

public void add(FileSet fs)
Add a FileSet.

Parameters:
fs - the FileSet to add.


eval

public boolean eval()
Fulfill the condition contract.
Specified by:
eval in interface Condition

Returns:
true if the condition is true.


execute

public void execute()
Execute the length task.
Overrides:
execute in interface 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 B) 2000-2005 Apache Software Foundation. All Rights Reserved.