Class Copier

java.lang.Object

org.jdrupes.builder.core.AbstractProvider

org.jdrupes.builder.core.AbstractGenerator

org.jdrupes.builder.core.Copier

All Implemented Interfaces:

Generator, Renamable, ResourceProvider

public class Copier
extends AbstractGenerator

The Class Copier.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	Copier.Source	A source description.

Constructor Summary

Constructors

Constructor	Description
Copier(Project project)	Initializes a new copier.

Method Summary

Modifier and Type	Method	Description
protected <T extends Resource> Stream<T>	doProvide(ResourceRequest<T> request)	Invoked by ResourceProviderSpi.provide(ResourceRequest) after checking if the invocation is allowed.
Copier	into(Path destination)	Sets the destination directory for the copied resources.
Copier	provideResources(ResourceRequest<?> proto)	Provide the generated resources in response to a request like the given one.
Copier	source(Path root, String pattern)	Convenience method to add a FileTree without subdirectory or filter to the sources.
Copier	source(Stream<Copier.Source> sources)	Add the given Stream of Sources to the source resources.

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, of, resources

Constructor Details

Copier

public Copier(Project project)

Initializes a new copier.

Parameters:

project - the project

Method Details

source

public Copier source(Stream<Copier.Source> sources)

Add the given Stream of Sources to the source resources.

Parameters:

sources - the sources

Returns:

the copier

source

public Copier source(Path root,
 String pattern)

Convenience method to add a FileTree without subdirectory 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 copier

into

public Copier into(Path destination)

Sets the destination directory for the copied resources. If the destination is relative, it is resolved against the project's directory.

Parameters:

destination - the destination

Returns:

the copier

provideResources

public Copier provideResources(ResourceRequest<?> proto)

Provide the generated resources in response to a request like the given one.

Parameters:

proto - defines the kind of request that the copier should respond to with the copied resources

Returns:

the copier

doProvide

protected <T extends Resource> Stream<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