Class FileTreeBuilder

java.lang.Object

org.jdrupes.builder.core.AbstractProvider

org.jdrupes.builder.core.AbstractGenerator

org.jdrupes.builder.core.FileTreeBuilder

All Implemented Interfaces:

Generator, Renamable, ResourceProvider

public class FileTreeBuilder
extends AbstractGenerator

A provider that generates a FileTree from existing file trees. In general, copying file trees should be avoided. However, in some situations a resource provider and a consumer cannot be configured so that the output of the former can be used directly by the latter.

The provider generates a FileTree in the directory specified with into(Path) by copying files from the sources defined with one of the source-methods. The class is not named Copier because the specification of FileTreeBuilder.Sources supports transformations beyond simply copying.

The provider generates the FileTree in response requests that match the prototype set with provideResources(ResourceRequest). The content of the generated file tree is returned using the type specified in the request.

A request for Cleanliness deletes the directory specified with into(Path).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	FileTreeBuilder.Source	Describes a source that contributes files to the generated tree.

Constructor Summary

Constructors

Constructor	Description
FileTreeBuilder(Project project)	Initializes a new file tree builder.

Method Summary

Modifier and Type	Method	Description
FileTreeBuilder	add(Stream<FileTreeBuilder.Source> sources)	Adds the given Stream of FileTreeBuilder.Source specifications.
FileTreeBuilder	add(FileTreeBuilder.Source source)	Adds the given FileTreeBuilder.Source specification.
protected <T extends Resource> Collection<T>	doProvide(ResourceRequest<T> request)	Invoked by ResourceProviderSpi.provide(ResourceRequest) after checking if the invocation is allowed.
FileTreeBuilder	into(Path destination)	Sets the destination directory for the generated file tree.
FileTreeBuilder	provideResources(ResourceRequest<? extends FileTree<?>> proto)	Configures the request that this builder responds to by providing the generated file tree.
FileTreeBuilder	source(Path root, String pattern)	Convenience method for adding a FileTreeBuilder.Source without renaming or filter to the sources.
FileTreeBuilder	source(Path root, String pattern, Function<Path,Path> renamer, BiConsumer<InputStream, OutputStream> filter)	Convenience method for adding a FileTreeBuilder.Source with optional renaming and filtering to the sources.

Methods inherited from class AbstractGenerator

cleanup, name, project, toString

Methods inherited from class AbstractProvider

context, name, of, rename, vavrStream

Methods inherited from class Object

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

Methods inherited from interface ResourceProvider

context, name, of, resources

Constructor Details

FileTreeBuilder

public FileTreeBuilder(Project project)

Initializes a new file tree builder.

Parameters:

project - the project

Method Details

add

public FileTreeBuilder add(Stream<FileTreeBuilder.Source> sources)

Adds the given Stream of FileTreeBuilder.Source specifications.

Parameters:

sources - the sources

Returns:

the file tree builder

add

public FileTreeBuilder add(FileTreeBuilder.Source source)

Adds the given FileTreeBuilder.Source specification.

Parameters:

source - the source

Returns:

the file tree builder

source

public FileTreeBuilder source(Path root,
 String pattern)

Convenience method for adding a FileTreeBuilder.Source without renaming or filter to the sources. If root is a relative path, it is resolved against the project's directory.

Parameters:

root - the root

pattern - the pattern

Returns:

the file tree builder

source

public FileTreeBuilder source(Path root,
 String pattern,
 Function<Path,Path> renamer,
 BiConsumer<InputStream, OutputStream> filter)

Convenience method for adding a FileTreeBuilder.Source with optional renaming and filtering to the sources. If root is a relative path, it is resolved against the project's directory.

Parameters:

root - the root

pattern - the pattern

renamer - the renamer (may be null)

filter - the filter (may be null)

Returns:

the file tree builder

into

public FileTreeBuilder into(Path destination)

Sets the destination directory for the generated file tree. If the destination is relative, it is resolved against the project's directory.

Parameters:

destination - the destination

Returns:

the file tree builder

provideResources

public FileTreeBuilder provideResources(ResourceRequest<? extends FileTree<?>> proto)

Configures the request that this builder responds to by providing the generated file tree.

Parameters:

proto - a prototype request describing the requests that the provider should respond to

Returns:

the file tree builder

doProvide

protected <T extends Resource> Collection<T> doProvide(ResourceRequest<T> request)

Description copied from class: AbstractProvider

Invoked by ResourceProviderSpi.provide(ResourceRequest) after checking if the invocation is allowed.

Specified by:

doProvide in class AbstractProvider

Type Parameters:

T - the generic type

Parameters:

request - the request for resources

Returns:

the stream