org.gradle.api.internal.file.collections

Interface FileCollectionResolveContext

All Known Subinterfaces:

ResolvableFileCollectionResolveContext

All Known Implementing Classes:

BuildDependenciesOnlyFileCollectionResolveContext, DefaultFileCollectionResolveContext

public interface FileCollectionResolveContext

Method Summary

Methods

Modifier and Type	Method and Description
FileCollectionResolveContext	add(Object element) Adds the given element to be resolved.
ResolvableFileCollectionResolveContext	newContext() Creates a new context which can be used to resolve element.
FileCollectionResolveContext	push(FileResolver fileResolver) Adds a nested context which resolves elements using the given resolver.

Method Detail

add

FileCollectionResolveContext add(Object element)

Adds the given element to be resolved. Handles the following types:

• Iterable - elements are recursively resolved.
• Closure - return value is recursively resolved, if not null.
• Callable - return value is recursively resolved, if not null.
• FileCollection - resolved as is.
• Task - resolved to task.outputs.files
• MinimalFileSet - wrapped as a FileCollection.
• MinimalFileTree - wrapped as a FileTree.
• FileCollectionContainer - recursively resolved.
• TaskDependency - resolved to an empty FileCollection which is builtBy the given dependency.
• Everything else - resolved to a File and wrapped in a singleton FileCollection.

Generally, the result of resolution is a composite FileCollection which contains the union of all files and dependencies add to this context.

Parameters:

element - The element to add.

Returns:

this

push

FileCollectionResolveContext push(FileResolver fileResolver)

Adds a nested context which resolves elements using the given resolver. Any element added to the returned context will be added to this context. Those elements which need to be resolved using a file resolver will use the provided resolver, instead of the default used by this context.

newContext

ResolvableFileCollectionResolveContext newContext()

Creates a new context which can be used to resolve element. Elements added to the returned context will not be added to this context. Instead, the caller should use one of ResolvableFileCollectionResolveContext.resolveAsFileCollections() or ResolvableFileCollectionResolveContext.resolveAsFileTrees().