Package org.gradle.api.provider

Interface ProviderFactory

public interface ProviderFactory

A factory for creating instances of Provider.

An instance of the factory can be injected into a task, plugin or other object by annotating a public constructor or property getter method with javax.inject.Inject. It is also available via Project.getProviders().

Since:

4.0

Method Summary

Modifier and Type	Method	Description
<T,P extends ValueSourceParameters> Provider<T>	of(Class<? extends ValueSource<T,P>> valueSourceType, Action<? super ValueSourceSpec<P>> configuration)	Creates a Provider whose value is obtained from the given ValueSource.
<T> Provider<T>	provider(Callable<? extends T> value)	Creates a Provider whose value is calculated using the given Callable.
Provider<String>	systemProperty(String propertyName)	Creates a Provider whose value is fetched from system properties using the given property name.
Provider<String>	systemProperty(Provider<String> propertyName)	Creates a Provider whose value is fetched from system properties using the given property name.

Method Detail

provider

<T> Provider<T> provider(Callable<? extends T> value)

Creates a Provider whose value is calculated using the given Callable.

The provider is live and will call the Callable each time its value is queried. The Callable may return null, in which case the provider is considered to have no value.

Parameters:

value - The java.util.concurrent.Callable use to calculate the value.

Returns:

The provider. Never returns null.

systemProperty

@Incubating
Provider<String> systemProperty(String propertyName)

Creates a Provider whose value is fetched from system properties using the given property name.

Parameters:

propertyName - the name of the system property

Returns:

the provider for the system property, never returns null

Since:

6.1

systemProperty

@Incubating
Provider<String> systemProperty(Provider<String> propertyName)

Creates a Provider whose value is fetched from system properties using the given property name.

Parameters:

propertyName - the name of the system property

Returns:

the provider for the system property, never returns null

Since:

6.1

of

@Incubating
<T,P extends ValueSourceParameters> Provider<T> of(Class<? extends ValueSource<T,P>> valueSourceType,
                                                         Action<? super ValueSourceSpec<P>> configuration)

Creates a Provider whose value is obtained from the given ValueSource.

Parameters:

valueSourceType - the type of the ValueSource

configuration - action to configure the parameters to the given ValueSource

Returns:

the provider, never returns null

Since:

6.1