better-gradle-properties/foundry.gradle.properties/PropertyResolver

PropertyResolver

class PropertyResolver( providers: PropertyResolver.SimpleProviderFactory, localPropertyProvider: (String) -> Provider<String>, localGradlePropertyProvider: (String) -> Provider<String>, startParameterProperty: (String) -> Provider<String>, globalLocalProperty: (String) -> Provider<String>, globalGradleLocalProperty: (String) -> Provider<String>)(source)

A property resolver that handles multiple property sources in a hierarchical fashion for providerFor.

This checks in the following order of priority

project-local local.properties
project-local gradle.properties
root-project local.properties
root-project/global gradle.properties

Constructors

PropertyResolver

constructor( providers: PropertyResolver.SimpleProviderFactory, localPropertyProvider: (String) -> Provider<String>, localGradlePropertyProvider: (String) -> Provider<String>, startParameterProperty: (String) -> Provider<String>, globalLocalProperty: (String) -> Provider<String>, globalGradleLocalProperty: (String) -> Provider<String>)

Types

enum BlankBehavior : Enum<PropertyResolver.BlankBehavior>

object Companion

SimpleProviderFactory

interface SimpleProviderFactory

Functions

booleanProvider

fun booleanProvider(key: String): Provider<Boolean>

fun booleanProvider(key: String, defaultValue: Boolean = false): Provider<Boolean>

fun booleanProvider(key: String, defaultValue: Provider<Boolean>): Provider<Boolean>

fun booleanValue(key: String, defaultValue: Boolean = false): Boolean

fun booleanValue(key: String, defaultValue: Provider<Boolean>): Boolean

gradleProviderOf

fun <T : Any> gradleProviderOf(optional: Optional<T>): Provider<T>

Returns a Gradle Provider around the given optional.

fun intProvider(key: String, defaultValue: Int = -1): Provider<Int>

fun intProvider(key: String, defaultValue: Provider<Int>): Provider<Int>

fun intValue(key: String, defaultValue: Int = -1): Int

fun intValue(key: String, defaultValue: Provider<Int>): Int

optionalStringProvider

fun optionalStringProvider(key: String, blankBehavior: PropertyResolver.BlankBehavior = BlankBehavior.ERROR): Provider<String>

fun optionalStringProvider( key: String, defaultValue: String? = null, blankBehavior: PropertyResolver.BlankBehavior = BlankBehavior.ERROR): Provider<String>

optionalStringValue

fun optionalStringValue(key: String, defaultValue: String? = null): String?

fun providerFor(key: String): Provider<String>

Returns a "safe" property Provider mechanism that handles multiple property sources in a hierarchical fashion.

requiredStringProvider

fun requiredStringProvider(key: String): Provider<String>

fun stringValue(key: String): String

fun stringValue(key: String, defaultValue: String): String