Interface RequiredResourceSupport

All Superinterfaces:

ResourceProvider

All Known Implementing Classes:

JavaExecutor, NpmExecutor

public interface RequiredResourceSupport
extends ResourceProvider

Implemented by ResourceProviders that require resources to be available without needing them for a specific purpose. The need for this usually arises when a ResourceProvider is scriptable and the required resources depend on the script.

Such resource providers should use the methods from this interface to register the required resources, thus ensuring a consistent API.

Method Summary

Modifier and Type	Method	Description
RequiredResourceSupport	required(Path file)	Convenience method that adds a FileResource to the required resources.
RequiredResourceSupport	required(Path root, String pattern)	Convenience method that adds a FileTree to the required resources.
RequiredResourceSupport	required(Stream<? extends Resource> resources)	Adds the given Stream of resources to the required resources.

Methods inherited from interface ResourceProvider

context, name, of, resources

Method Details

required

RequiredResourceSupport required(Stream<? extends Resource> resources)

Adds the given Stream of resources to the required resources.

Parameters:

resources - the resources

Returns:

the provider

required

RequiredResourceSupport required(Path root,
 String pattern)

Convenience method that adds a FileTree to the required resources. If root is relative, it is resolved against the project's directory.

Parameters:

root - the root

pattern - the pattern

Returns:

the provider

required

RequiredResourceSupport required(Path file)

Convenience method that adds a FileResource to the required resources. If path is relative, it is resolved against the project's directory.

Parameters:

file - the file

Returns:

the provider