gradle/org.gradle.api.provider/MapProperty

MapProperty

@SupportsKotlinAssignmentOverloading

interface MapProperty<K, V> : Provider<T> , HasConfigurableValue, SupportsConvention(source)

Represents a property whose type is a Map of keys of type K and values of type V. Retains iteration order.

You can create a MapProperty instance using factory method mapProperty.

Note: This interface is not intended for implementation by build script or plugin authors.

Since

5.1

Parameters

<K>

the type of keys.

<V>

the type of values.

Functions

assign

fun <K, V> MapProperty<K, V>.assign(entries: Map<out K?, V?>?)

Sets the value of this property to the entries of the given Map, and replaces any existing value

fun <K, V> MapProperty<K, V>.assign(provider: Provider<out Map<out K?, V?>?>)

Sets the property to have the same value of the given provider, and replaces any existing value

convention

abstract fun convention(@Nullable value: Map<out K, out V>): MapProperty<K, V>

Specifies the value to use as the convention for this property.

abstract fun convention(valueProvider: Provider<out Map<out K, out V>>): MapProperty<K, V>

Specifies the provider of the value to use as the convention for this property.

disallowChanges

abstract fun disallowChanges()

disallowUnsafeRead

abstract fun disallowUnsafeRead()

empty

abstract fun empty(): MapProperty<K, V>

Sets the value of this property to an empty map, and replaces any existing value.

filter

abstract fun filter(spec: Spec<in T>): Provider<T>

finalizeValue

abstract fun finalizeValue()

Disallows further changes to the value of this property.

finalizeValueOnRead

abstract fun finalizeValueOnRead()

flatMap

abstract fun <S> flatMap(transformer: Transformer<out @Nullable Provider<out S>, in T>): Provider<S>

forUseAtConfigurationTime

abstract fun forUseAtConfigurationTime(): Provider<T>

get

abstract fun get(): T

getOrElse

abstract fun getOrElse(defaultValue: T): T

getOrNull

abstract fun getOrNull(): T

getting

abstract fun getting(key: K): Provider<V>

Returns a provider that resolves to the value of the mapping of the given key.

isPresent

abstract fun isPresent(): Boolean

keySet

abstract fun keySet(): Provider<Set<K>>

Returns a Provider that returns the set of keys for the map that is the property value.

map

abstract fun <S> map(transformer: Transformer<out @Nullable S, in T>): Provider<S>

orElse

abstract fun orElse(value: T): Provider<T>

put

abstract fun put(key: K, value: V)

abstract fun put(key: K, providerOfValue: Provider<out V>)

Adds a map entry to the property value.

putAll

abstract fun putAll(entries: Map<out K, out V>)

abstract fun putAll(provider: Provider<out Map<out K, out V>>)

Adds all entries from another Map to the property value.

set

abstract fun set(@Nullable entries: Map<out K, out V>)

Sets the value of this property to the entries of the given Map, and replaces any existing value.

abstract fun set(provider: Provider<out Map<out K, out V>>)

Sets the property to have the same value of the given provider, and replaces any existing value.

unset

@Incubating

abstract fun unset(): MapProperty<K, V>

This is similar to calling value with a null argument.

unsetConvention

@Incubating

abstract fun unsetConvention(): MapProperty<K, V>

This is similar to calling convention with a null argument.

value

abstract fun value(@Nullable entries: Map<out K, out V>): MapProperty<K, V>

Sets the value of this property to the entries of the given Map, and replaces any existing value.

abstract fun value(provider: Provider<out Map<out K, out V>>): MapProperty<K, V>

Sets the property to have the same value of the given provider, and replaces any existing value.

zip

abstract fun <U, R> zip(right: Provider<U>, combiner: BiFunction<in T, in U, out @Nullable R>): Provider<R>