gradle/org.gradle.api.provider/ListProperty

ListProperty

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

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

Instances of this interface are not thread-safe for reading and writing. It is not safe to share the same ListProperty instance between different projects.

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)

abstract fun add(provider: Provider<out T>)

Adds an element to the property value.

addAll

abstract fun addAll(elements: Array<T>)

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

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

Adds zero or more elements to the property value.

convention

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

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

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

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

disallowChanges

abstract fun disallowChanges()

Disallows further direct changes to this object.

disallowUnsafeRead

abstract fun disallowUnsafeRead()

Disallows reading the value of this object when its value may not yet be available or may still change.

empty

abstract fun empty(): ListProperty<T>

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

filter

@Incubating

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

Returns a new Provider with the value of this provider if the passed spec is satisfied and no value otherwise.

finalizeValue

abstract fun finalizeValue()

Disallows further changes to the value of this property.

finalizeValueOnRead

abstract fun finalizeValueOnRead()

Requests that the final value of this object be calculated on the next read of the value, if not already known.

flatMap

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

Returns a new Provider from the value of this provider transformed using the given function.

get

abstract fun get(): T

Returns the value of this provider if it has a value present, otherwise throws java.lang.IllegalStateException.

getOrElse

abstract fun getOrElse(defaultValue: T): T

Returns the value of this provider if it has a value present.

getOrNull

@Nullable

abstract fun getOrNull(): @Nullable T

Returns the value of this provider if it has a value present.

isPresent

abstract fun isPresent(): Boolean

Returns true if there is a value present, otherwise false.

map

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

Returns a new Provider whose value is the value of this provider transformed using the given function.

orElse

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

Returns a Provider whose value is the value of this provider, if present, otherwise the given default value.

abstract fun orElse(provider: Provider<out T>): Provider<T>

Returns a Provider whose value is the value of this provider, if present, otherwise uses the value from the given provider, if present.

set

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

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

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

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

unset

abstract fun unset(): ListProperty<T>

Unsets this object's explicit value, allowing the convention to be selected when evaluating this object's value.

unsetConvention

abstract fun unsetConvention(): ListProperty<T>

Unsets this object's convention value.

value

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

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

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

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>

Returns a provider which value will be computed by combining this provider value with another provider value using the supplied combiner function.

ListProperty

Since

Parameters

See also

Functions