org.gradle.api.internal.file.collections

Class DefaultFileCollectionResolveContext

java.lang.Object

org.gradle.api.internal.file.collections.DefaultFileCollectionResolveContext

All Implemented Interfaces:

FileCollectionResolveContext, ResolvableFileCollectionResolveContext

Direct Known Subclasses:

BuildDependenciesOnlyFileCollectionResolveContext

public class DefaultFileCollectionResolveContext
extends Object
implements ResolvableFileCollectionResolveContext

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static interface	DefaultFileCollectionResolveContext.Converter<T>

Constructor Summary

Constructors

Modifier	Constructor and Description
	DefaultFileCollectionResolveContext()
	DefaultFileCollectionResolveContext(FileResolver fileResolver)
protected	DefaultFileCollectionResolveContext(FileResolver fileResolver, DefaultFileCollectionResolveContext.Converter<? extends FileCollection> fileCollectionConverter, DefaultFileCollectionResolveContext.Converter<? extends FileTree> fileTreeConverter)

Method Summary

Methods

Modifier and Type	Method and Description
DefaultFileCollectionResolveContext	add(Object element) Adds the given element to be resolved.
ResolvableFileCollectionResolveContext	newContext() Creates a new context which can be used to resolve element.
DefaultFileCollectionResolveContext	push(FileResolver fileResolver) Adds a nested context which resolves elements using the given resolver.
List<FileCollection>	resolveAsFileCollections() Resolves the contents of this context as a list of atomic FileCollection instances.
List<FileTree>	resolveAsFileTrees() Resolves the contents of this context as a list of atomic FileTree instances.
List<MinimalFileCollection>	resolveAsMinimalFileCollections() Resolves the contents of this context as a list of atomic MinimalFileCollection instances.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultFileCollectionResolveContext

public DefaultFileCollectionResolveContext()

DefaultFileCollectionResolveContext

public DefaultFileCollectionResolveContext(FileResolver fileResolver)

DefaultFileCollectionResolveContext

protected DefaultFileCollectionResolveContext(FileResolver fileResolver,
                                   DefaultFileCollectionResolveContext.Converter<? extends FileCollection> fileCollectionConverter,
                                   DefaultFileCollectionResolveContext.Converter<? extends FileTree> fileTreeConverter)

Method Detail

add

public DefaultFileCollectionResolveContext add(Object element)

Description copied from interface: FileCollectionResolveContext

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.

Specified by:

add in interface FileCollectionResolveContext

Parameters:

element - The element to add.

Returns:

this

push

public DefaultFileCollectionResolveContext push(FileResolver fileResolver)

Description copied from interface: FileCollectionResolveContext

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.

Specified by:

push in interface FileCollectionResolveContext

newContext

public ResolvableFileCollectionResolveContext newContext()

Description copied from interface: FileCollectionResolveContext

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().

Specified by:

newContext in interface FileCollectionResolveContext

resolveAsFileTrees

public List<FileTree> resolveAsFileTrees()

Resolves the contents of this context as a list of atomic FileTree instances.

Specified by:

resolveAsFileTrees in interface ResolvableFileCollectionResolveContext

resolveAsFileCollections

public List<FileCollection> resolveAsFileCollections()

Resolves the contents of this context as a list of atomic FileCollection instances.

Specified by:

resolveAsFileCollections in interface ResolvableFileCollectionResolveContext

resolveAsMinimalFileCollections

public List<MinimalFileCollection> resolveAsMinimalFileCollections()

Resolves the contents of this context as a list of atomic MinimalFileCollection instances.