org.apache.tools.ant.types.resources.selectors

Class Compare

Implemented Interfaces:
Cloneable, ResourceSelector

public class Compare
extends DataType
implements ResourceSelector

ResourceSelector that compares against "control" Resource(s) using ResourceComparators.
Since:
Ant 1.7

Field Summary

Fields inherited from class org.apache.tools.ant.types.DataType

checked, ref

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

description, location, project

Method Summary

void
add(ResourceComparator c)
Add a ResourceComparator to this Compare selector.
ResourceCollection
createControl()
Create the nested control element.
protected void
dieOnCircularReference(Stack stk, Project p)
Overrides the version from DataType to recurse on nested ResourceComparators.
boolean
isSelected(Resource r)
void
setAgainst(Quantifier against)
Set the quantifier to be used.
void
setWhen(Comparison when)
Set the comparison to be used.

Methods inherited from class org.apache.tools.ant.types.DataType

checkAttributesAllowed, checkChildrenAllowed, circularReference, clone, dieOnCircularReference, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, setChecked, setRefid, toString, tooManyAttributes

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

clone, getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject

Method Details

add

public void add(ResourceComparator c)
Add a ResourceComparator to this Compare selector. If multiple ResourceComparators are added, they will be processed in LIFO order.
Parameters:
c - the ResourceComparator to add.

createControl

public ResourceCollection createControl()
Create the nested control element. These are the resources to compare against.
Returns:
ResourceCollection.

dieOnCircularReference

protected void dieOnCircularReference(Stack stk,
                                      Project p)
            throws BuildException
Overrides the version from DataType to recurse on nested ResourceComparators.
Overrides:
dieOnCircularReference in interface DataType
Parameters:
stk - the stack of data types to use (recursively).
p - the project to use to dereference the references.
Throws:
BuildException - on error.

isSelected

public boolean isSelected(Resource r)
Specified by:
isSelected in interface ResourceSelector

setAgainst

public void setAgainst(Quantifier against)
Set the quantifier to be used. Default "all".
Parameters:
against - the Quantifier EnumeratedAttribute to use.

setWhen

public void setWhen(Comparison when)
Set the comparison to be used. Default "equal".
Parameters:
when - the Comparison EnumeratedAttribute to use.