gradle/org.gradle.api.provider/HasMultipleValues

HasMultipleValues

interface HasMultipleValues<T> : HasConfigurableValue, SupportsConvention(source)

Represents a property whose value can be set using multiple elements of type T, such as a collection property.

Note: This interface is not intended for implementation by build script or plugin authors. You can use the factory methods on org.gradle.api.model.ObjectFactory to create various subtypes of this interface.

Since

4.5

Parameters

<T>

the type of elements.

Inheritors

SetProperty

ListProperty

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.

assign

fun <T : Any> 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 : Any> 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: @Nullable Iterable<out T>): HasMultipleValues<T>

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

abstract fun convention(provider: Provider<out Iterable<out T>>): HasMultipleValues<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(): HasMultipleValues<T>

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

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.

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(): SupportsConvention

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

unsetConvention

abstract fun unsetConvention(): SupportsConvention

Unsets this object's convention value.

value

abstract fun value(@Nullable elements: @Nullable Iterable<out T>): HasMultipleValues<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>>): HasMultipleValues<T>

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