Class AbstractProvider

java.lang.Object

org.jdrupes.builder.core.AbstractProvider

All Implemented Interfaces:

ResourceProvider

Direct Known Subclasses:

AbstractGenerator, AbstractProject, JavaExecutor, MvnRepoLookup

public abstract class AbstractProvider
extends Object
implements ResourceProvider

A base implementation forResourceProviders.

Constructor Summary

Constructors

Constructor	Description
AbstractProvider()	Initializes a new abstract provider.

Method Summary

Modifier and Type	Method	Description
DefaultBuildContext	context()	Convenience method to access the build context which is sometimes needed in the context of resource requests.
protected abstract <T extends Resource> Stream<T>	doProvide(ResourceRequest<T> requested)	Invoked by ResourceProviderSpi.provide(ResourceRequest) after checking if the invocation is allowed.
String	name()	Returns the name of this resource provider.
protected <T extends Resource> T	newResource(ResourceType<T> type, Object... args)	Convenience function to create a new resource.
<T extends Resource> ResourceRequest<T>	of(ResourceType<? extends T> type)	Create a new request for the given resource.
protected final AbstractProvider	rename(String name)	Allows derived classes to change the provider's name in their implementation of Renamable.name(String).
String	toString()
<T extends Resource> io.vavr.collection.Stream<T>	vavrStream(Resources<T> resources)	Retrieves the resources as a Vavr stream.

Methods inherited from class Object

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

Methods inherited from interface ResourceProvider

of, resources

Constructor Details

AbstractProvider

public AbstractProvider()

Initializes a new abstract provider.

Method Details

name

public String name()

Description copied from interface: ResourceProvider

Returns the name of this resource provider.

Specified by:

name in interface ResourceProvider

Returns:

the string

rename

protected final AbstractProvider rename(String name)

Allows derived classes to change the provider's name in their implementation of Renamable.name(String). Throws an UnsupportedOperationException if the derived class does not implement Renamable.

Parameters:

name - the name

Returns:

the abstract provider

doProvide

protected abstract <T extends Resource> Stream<T> doProvide(ResourceRequest<T> requested)

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

Type Parameters:

T - the generic type

Parameters:

requested - the requested

Returns:

the stream

of

public <T extends Resource> ResourceRequest<T> of(ResourceType<? extends T> type)

Description copied from interface: ResourceProvider

Create a new request for the given resource.

Specified by:

of in interface ResourceProvider

Type Parameters:

T - the resource type

Parameters:

type - the type

Returns:

the resource request

context

public DefaultBuildContext context()

Description copied from interface: ResourceProvider

Convenience method to access the build context which is sometimes needed in the context of resource requests.

Specified by:

context in interface ResourceProvider

Returns:

the builder configuration

newResource

protected <T extends Resource> T newResource(ResourceType<T> type,
 Object... args)

Convenience function to create a new resource. Short for invoking ResourceFactory.create(ResourceType, Project, Object...) with the requested resource type, null for the project and the remaining given arguments appended.

Type Parameters:

T - the resource type

Parameters:

type - the type

args - the arguments

Returns:

the resource

vavrStream

public <T extends Resource>
io.vavr.collection.Stream<T> vavrStream(Resources<T> resources)

Retrieves the resources as a Vavr stream.

Type Parameters:

T - the resource type

Parameters:

resources - the resources

Returns:

the stream

toString

public String toString()

Overrides:

toString in class Object