org.apache.tools.ant.taskdefs
Class Length

java.lang.Object
  |
  +--org.apache.tools.ant.ProjectComponent
        |
        +--org.apache.tools.ant.Task
              |
              +--org.apache.tools.ant.taskdefs.Length
All 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
 
Constructor Summary
Length()
           
 
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(java.io.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(java.lang.String property)
          The property in which the length will be stored.
 void setString(java.lang.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
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, setProject
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Length

public Length()
Method Detail

setProperty

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

Parameters:
property - the String property key.

setFile

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

Parameters:
file - the File whose length to retrieve.

add

public void add(FileSet fs)
Add a FileSet.

Parameters:
fs - the FileSet to add.

setLength

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

Parameters:
ell - the long length to compare with.

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.

setMode

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

Parameters:
m - the FileMode to use.

setString

public void setString(java.lang.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.

getTrim

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

Returns:
boolean trim setting.

execute

public void execute()
Execute the length task.

Overrides:
execute in class Task

eval

public boolean eval()
Fulfill the condition contract.

Specified by:
eval in interface Condition
Returns:
true if the condition is true.
Throws:
BuildException - if an error occurs.


Copyright 2000-2005 Apache Software Foundation. All Rights Reserved.