gradle/org.gradle.api.provider/ListProperty

ListProperty

interface ListProperty<T> : Provider<T> , HasMultipleValues<T> (source)

Represents a property whose type is a List of elements of type T.

You can create a ListProperty instance using factory method listProperty.

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

Since

4.3

Parameters

<T>

the type of elements.

Functions

add

abstract fun add(element: T)

addAll

abstract fun addAll(elements: Array<T>)

assign

fun <T> HasMultipleValues<T>.assign(elements: Iterable<T?>?)

Sets the value of the property to the elements of the given iterable, and replaces any existing value

fun <T> HasMultipleValues<T>.assign(provider: Provider<out Iterable<T?>?>)

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

convention

abstract fun convention(@Nullable elements: Iterable<out T>): ListProperty<T>

abstract fun convention(provider: Provider<out Iterable<out T>>): ListProperty<T>

disallowChanges

abstract fun disallowChanges()

disallowUnsafeRead

abstract fun disallowUnsafeRead()

empty

abstract fun empty(): ListProperty<T>

filter

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

finalizeValue

abstract fun finalizeValue()

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

isPresent

abstract fun isPresent(): Boolean

map

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

orElse

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

set

abstract fun set(elements: Iterable<out T>)

unset

abstract fun unset(): ListProperty<T>

This is similar to calling value with a null argument.

unsetConvention

abstract fun unsetConvention(): ListProperty<T>

This is similar to calling convention with a null argument.

value

abstract fun value(@Nullable elements: Iterable<out T>): ListProperty<T>

abstract fun value(provider: Provider<out Iterable<out T>>): ListProperty<T>

zip

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