Overview Package Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

org.apache.tools.ant.types.resources

Class Sort

Implemented Interfaces:
Cloneable, ResourceCollection
public class Sort
extends BaseResourceCollectionWrapper
ResourceCollection that sorts another ResourceCollection. Note that Sort must not be used in cases where the ordering of the objects being sorted might change during the sorting process.
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 Sort ResourceCollection.
protected void
dieOnCircularReference(Stack stk, Project p)
Overrides the BaseResourceCollectionContainer version to recurse on nested ResourceComparators.
protected Collection
getCollection()
Sort the contained elements.

Methods inherited from class org.apache.tools.ant.types.resources.BaseResourceCollectionWrapper

add, dieOnCircularReference, getCollection, getResourceCollection, isCache, isFilesystemOnly, iterator, setCache, size, toString

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 Sort ResourceCollection. If multiple ResourceComparators are added, they will be processed in LIFO order.
Parameters:
c - the ResourceComparator to add.

dieOnCircularReference

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

getCollection

protected Collection getCollection()
Sort the contained elements.
Overrides:
getCollection in interface BaseResourceCollectionWrapper
Returns:
a Collection of Resources.

Overview Package Tree Index Deprecated About