HasMultipleValues (Gradle API 8.7)

Type Parameters:

T - the type of elements.

All Superinterfaces:

HasConfigurableValue, SupportsConvention

All Known Subinterfaces:

ListProperty<T>, SetProperty<T>
```
@SupportsKotlinAssignmentOverloading
public interface HasMultipleValues<T>
extends HasConfigurableValue, SupportsConvention
```
Represents a property whose value can be set using multiple elements of type HasMultipleValues, 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 ObjectFactory to create various subtypes of this interface.

Since:

4.5

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`void`	`add(Provider<? extends T> provider)`	Adds an element to the property value.
`void`	`add(T element)`	Adds an element to the property value.
`void`	`addAll(java.lang.Iterable<? extends T> elements)`	Adds zero or more elements to the property value.
`void`	`addAll(Provider<? extends java.lang.Iterable<? extends T>> provider)`	Adds zero or more elements to the property value.
`void`	`addAll(T... elements)`	Adds zero or more elements to the property value.
`void`	`append(Provider<? extends T> provider)`	Adds an element to the property value.
`void`	`append(T element)`	Adds an element to the property value.
`void`	`appendAll(java.lang.Iterable<? extends T> elements)`	Adds zero or more elements to the property value.
`void`	`appendAll(Provider<? extends java.lang.Iterable<? extends T>> provider)`	Adds zero or more elements to the property value.
`void`	`appendAll(T... elements)`	Adds zero or more elements to the property value.
`HasMultipleValues<T>`	`convention(java.lang.Iterable<? extends T> elements)`	Specifies the value to use as the convention for this property.
`HasMultipleValues<T>`	`convention(Provider<? extends java.lang.Iterable<? extends T>> provider)`	Specifies the provider of the value to use as the convention for this property.
`HasMultipleValues<T>`	`empty()`	Sets the value of this property to an empty collection, and replaces any existing value.
`void`	`finalizeValue()`	Disallows further changes to the value of this property.
`void`	`set(java.lang.Iterable<? extends T> elements)`	Sets the value of the property to the elements of the given iterable, and replaces any existing value.
`void`	`set(Provider<? extends java.lang.Iterable<? extends T>> provider)`	Sets the property to have the same value of the given provider, and replaces any existing value.
`HasMultipleValues<T>`	`value(java.lang.Iterable<? extends T> elements)`	Sets the value of the property to the elements of the given iterable, and replaces any existing value.
`HasMultipleValues<T>`	`value(Provider<? extends java.lang.Iterable<? extends T>> provider)`	Sets the property to have the same value of the given provider, and replaces any existing value.

Methods inherited from interface org.gradle.api.provider.HasConfigurableValue
disallowChanges, disallowUnsafeRead, finalizeValueOnRead

Methods inherited from interface org.gradle.api.provider.SupportsConvention
unset, unsetConvention

- Method Detail
  - set
```
void set(@Nullable
         java.lang.Iterable<? extends T> elements)
```
    Sets the value of the property to the elements of the given iterable, and replaces any existing value. This property will query the elements of the iterable each time the value of this property is queried.
    This method can also be used to discard the value of the property, by passing null as the value. The convention for this property, if any, will be used to provide the value instead.
    
    Parameters:
    
    elements - The elements, can be null.
  - set
```
void set(Provider<? extends java.lang.Iterable<? extends T>> provider)
```
    Sets the property to have the same value of the given provider, and replaces any existing value. This property will track the value of the provider and query its value each time the value of this property is queried. When the provider has no value, this property will also have no value.
    
    Parameters:
    
    provider - Provider of the elements.
  - value
```
HasMultipleValues<T> value(@Nullable
                           java.lang.Iterable<? extends T> elements)
```
    Sets the value of the property to the elements of the given iterable, and replaces any existing value. This property will query the elements of the iterable each time the value of this property is queried.
    This is the same as set(Iterable) but returns this property to allow method chaining.
    
    Parameters:
    
    elements - The elements, can be null.
    
    Returns:
    
    this
    
    Since:
    
    5.6
  - value
```
HasMultipleValues<T> value(Provider<? extends java.lang.Iterable<? extends T>> provider)
```
    Sets the property to have the same value of the given provider, and replaces any existing value. This property will track the value of the provider and query its value each time the value of this property is queried. When the provider has no value, this property will also have no value.
    This is the same as set(Provider) but returns this property to allow method chaining.
    
    Parameters:
    
    provider - Provider of the elements.
    
    Returns:
    
    this
    
    Since:
    
    5.6
  - empty
```
HasMultipleValues<T> empty()
```
    Sets the value of this property to an empty collection, and replaces any existing value.
    
    Returns:
    
    this property.
    
    Since:
    
    5.0
  - add
```
void add(T element)
```
    Adds an element to the property value.
    Contrary to append(Object), if this property has no value, this operation has no effect on the value of this property.
    
    Parameters:
    
    element - The element
    
    See Also:
    
    for a more convenient
  - add
```
void add(Provider<? extends T> provider)
```
    Adds an element to the property value.
    The given provider will be queried when the value of this property is queried.
    Contrary to append(Provider), if this property has no value, this operation has no effect on the value of this property.
    
    Also contrary to append(Provider), this property will have no value when the given provider has no value.
    
    Parameters:
    
    provider - The provider of an element
  - addAll
```
void addAll(T... elements)
```
    Adds zero or more elements to the property value.
    Contrary to appendAll(Object[]), if this property has no value, this operation has no effect on the value of this property.
    
    Parameters:
    
    elements - The elements to add
    
    Since:
    
    4.10
  - addAll
```
void addAll(java.lang.Iterable<? extends T> elements)
```
    Adds zero or more elements to the property value.
    The given iterable will be queried when the value of this property is queried.
    Contrary to appendAll(Iterable), if this property has no value, this operation has no effect on the value of this property.
    
    Parameters:
    
    elements - The elements to add.
    
    Since:
    
    4.10
  - addAll
```
void addAll(Provider<? extends java.lang.Iterable<? extends T>> provider)
```
    Adds zero or more elements to the property value.
    The given provider will be queried when the value of this property is queried.
    Contrary to appendAll(Provider), if this property has no value, this operation has no effect on the value of this property.
    
    Also contrary to appendAll(Provider), this property will have no value when the given provider has no value.
    
    Parameters:
    
    provider - Provider of elements
  - append
```
@Incubating
void append(T element)
```
    Adds an element to the property value.
    When invoked on a property with no value, this method first sets the value of the property to its current convention value, if set, or an empty collection.
    
    Parameters:
    
    element - The element
    
    Since:
    
    8.7
  - append
```
@Incubating
void append(Provider<? extends T> provider)
```
    Adds an element to the property value.
    The given provider will be queried when the value of this property is queried.
    When invoked on a property with no value, this method first sets the value of the property to its current convention value, if set, or an empty collection.
    
    Even if the given provider has no value, after this method is invoked, the actual value of this property is guaranteed to be present.
    
    Parameters:
    
    provider - The provider of an element
    
    Since:
    
    8.7
  - appendAll
```
@Incubating
void appendAll(T... elements)
```
    Adds zero or more elements to the property value.
    When invoked on a property with no value, this method first sets the value of the property to its current convention value, if set, or an empty collection.
    
    Parameters:
    
    elements - The elements to add
    
    Since:
    
    8.7
  - appendAll
```
@Incubating
void appendAll(java.lang.Iterable<? extends T> elements)
```
    Adds zero or more elements to the property value.
    The given iterable will be queried when the value of this property is queried.
    When invoked on a property with no value, this method first sets the value of the property to its current convention value, if set, or an empty collection.
    
    Parameters:
    
    elements - The elements to add.
    
    Since:
    
    8.7
  - appendAll
```
@Incubating
void appendAll(Provider<? extends java.lang.Iterable<? extends T>> provider)
```
    Adds zero or more elements to the property value.
    The given provider will be queried when the value of this property is queried.
    When invoked on a property with no value, this method first sets the value of the property to its current convention value, if set, or an empty collection.
    
    Even if the given provider has no value, after this method is invoked, the actual value of this property is guaranteed to be present.
    
    Parameters:
    
    provider - Provider of elements
    
    Since:
    
    8.7
  - convention
```
HasMultipleValues<T> convention(@Nullable
                                java.lang.Iterable<? extends T> elements)
```
    Specifies the value to use as the convention for this property. The convention is used when no value has been set for this property.
    
    Parameters:
    
    elements - The elements, or null when the convention is that the property has no value.
    
    Returns:
    
    this
    
    Since:
    
    5.1
  - convention
```
HasMultipleValues<T> convention(Provider<? extends java.lang.Iterable<? extends T>> provider)
```
    Specifies the provider of the value to use as the convention for this property. The convention is used when no value has been set for this property.
    
    Parameters:
    
    provider - The provider of the elements
    
    Returns:
    
    this
    
    Since:
    
    5.1
  - finalizeValue
```
void finalizeValue()
```
    Disallows further changes to the value of this property. Calls to methods that change the value of this property, such as set(Iterable) or add(Object) will fail.
    When this property has elements provided by a Provider, the value of the provider is queried when this method is called and the value of the provider will no longer be tracked.
    
    Note that although the value of the property will not change, the resulting collection may contain mutable objects. Calling this method does not guarantee that the value will become immutable.
    
    Specified by:
    
    finalizeValue in interface HasConfigurableValue
    
    Since:
    
    5.0

Interface HasMultipleValues<T>

Method Summary

Methods inherited from interface org.gradle.api.provider.HasConfigurableValue

Methods inherited from interface org.gradle.api.provider.SupportsConvention

Method Detail

set

set

value

value

empty

add

add

addAll

addAll

addAll

append

append

appendAll

appendAll

appendAll

convention

convention

finalizeValue