FileCollectionStrategy

public interface FileCollectionStrategy

DirectoryChildrenFileCollectionStrategy, PathFileCollectionStrategy, RecursiveFileCollectionStrategy, RecursiveIgnoreCaseExtensionFileCollectionStrategy, WildcardFileCollectionStrategy

Strategy interface for collecting and discovering files for task execution.

Implementations are responsible for enumerating the requested files given the current execution and task directory configuration.

This interface is used for detecting any addition-wise changes to the file system during incremental builds. If a task is run for a given file set, and new files are added by the user, implementations of this interface can detect the addition of the new files, and a rerun will be triggered for the task with appropriate deltas.

Implementations can collect files and directories alike as they wish.

Subclasses should satisfy the equals(Object) and hashCode() contract.

It is strongly recommended that subclasses implement the Externalizable interface.

Examples:

Collect files in a given directory. (DirectoryChildrenFileCollectionStrategy)
Collect files with a given extension, recursively. (RecursiveFileCollectionStrategy)
Collect files based on a wildcard. (WildcardFileCollectionStrategy)

It is recommended that subclasses have a static factory method (with name create) to instantiate an appropriately made FileCollectionStrategy instance.

TaskContext.reportInputFileAdditionDependency(Object, FileCollectionStrategy)

Methods

public NavigableMap<SakerPath, SakerFile>	collectFiles(ExecutionDirectoryContext executiondirectorycontext, TaskDirectoryContext taskdirectorycontext) Collects the files for the given configuration using this strategy.
public boolean	equals(Object obj) Check if this strategy will collect the same files as the argument given they are passed the same parameters.
public int	hashCode() Returns a hash code value for the object.

public abstract NavigableMap<SakerPath, SakerFile> collectFiles(ExecutionDirectoryContext executiondirectorycontext, TaskDirectoryContext taskdirectorycontext)

Collects the files for the given configuration using this strategy.

Implementations should use the passed parameter to retrieve the directories of interest and collect the requested files accordingly.

This method should not be called directly, but through TaskExecutionUtilities.collectFiles(FileCollectionStrategy), after constructing an appropriate FileCollectionStrategy instance.

Implementations should gracefully handle the case when the task working directory is null. When it is null, implementations should handle that case in the same way it would handle if the directory did not exist.

executiondirectorycontextThe execution directory context.

taskdirectorycontextThe task directory context.

A naturally ordered navigable map with the discovered files, with absolute paths as keys.

public abstract boolean equals(Object obj)

Check if this strategy will collect the same files as the argument given they are passed the same parameters.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any non-null reference values x and y, this method returns true if and only if x and y refer to the same object (x == y has the value true).

Note that it is generally necessary to override the hashCode method whenever this method is overridden, so as to maintain the general contract for the hashCode method, which states that equal objects must have equal hash codes.

true if this object is the same as the obj argument; false otherwise.

public abstract int hashCode()

Overridden from: Object

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals(Object) method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the Object.equals(Object) method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

As much as is reasonably practical, the hashCode method defined by class Object does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the Java™ programming language.)

a hash code value for this object.

Object.equals(Object)

System.identityHashCode(Object)