Type Parameters:

E - The type of element

C - The type of collection, for chaining

M - The type of CollectionValue.Mutable

I - The type of CollectionValue.Immutable

All Superinterfaces:

CollectionValue<E,C>, java.lang.Iterable<E>, Value<C>, Value.Mutable<C>

All Known Subinterfaces:

ListValue.Mutable<E>, SetValue.Mutable<E>, WeightedCollectionValue.Mutable<E>

Enclosing interface:

CollectionValue<E,C extends java.util.Collection<E>>
```
public static interface CollectionValue.Mutable<E,C extends java.util.Collection<E>,M extends CollectionValue.Mutable<E,C,M,I>,I extends CollectionValue.Immutable<E,C,I,M>>
extends Value.Mutable<C>, CollectionValue<E,C>, java.lang.Iterable<E>
```
Represents a Value.Mutable that is backed by a Collection of elements.

Nested Class Summary
- Nested classes/interfaces inherited from interface org.spongepowered.api.data.value.CollectionValue
  CollectionValue.Immutable<E,C extends java.util.Collection<E>,I extends CollectionValue.Immutable<E,C,I,M>,M extends CollectionValue.Mutable<E,C,M,I>>, CollectionValue.Mutable<E,C extends java.util.Collection<E>,M extends CollectionValue.Mutable<E,C,M,I>,I extends CollectionValue.Immutable<E,C,I,M>>
- Nested classes/interfaces inherited from interface org.spongepowered.api.data.value.Value
  Value.Factory, Value.Immutable<E>, Value.Mutable<E>

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`M`	`add(E element)`	Adds the given `element` to this `CollectionValue.Mutable`.
`M`	`addAll(java.lang.Iterable<E> elements)`	Adds all the given `Iterable` `elements` to the underlying `Collection`.
`I`	`asImmutable()`	Gets the `Value.Immutable` version of this `Value.Mutable` such that all data is duplicated across to the new `Value.Immutable`.
`default M`	`asMutable()`	Retrieves a mutable form of this value.
`default M`	`asMutableCopy()`	Retrieves a copy in the mutable form of this value.
`M`	`copy()`	Makes an independent copy of this `Value.Mutable` with the same initial data.
`M`	`remove(E element)`	Removes the given `element` from the backed `Collection`.
`M`	`removeAll(java.lang.Iterable<E> elements)`	Removes all elements from the `Iterable` from the backed `Collection`.
`M`	`removeAll(java.util.function.Predicate<E> predicate)`	Iterates over all existing elements and removes any elements that `Predicate.test(Object)` returns `true`.
`M`	`set(C value)`	Sets the underlying value to the provided `value`.
`M`	`transform(java.util.function.Function<C,C> function)`	Attempts to transform the underlying value based on the provided `Function` such that the result of `Function.apply(Object)` will replace the underlying value.

Methods inherited from interface org.spongepowered.api.data.value.CollectionValue
all, contains, containsAll, isEmpty, size

Methods inherited from interface java.lang.Iterable
forEach, iterator, spliterator

Methods inherited from interface org.spongepowered.api.data.value.Value
get, key

- Method Detail
  - add
```
M add(E element)
```
    Adds the given element to this CollectionValue.Mutable.
    
    Parameters:
    
    element - The element to add
    
    Returns:
    
    This value, for chaining
  - addAll
```
M addAll(java.lang.Iterable<E> elements)
```
    Adds all the given Iterable elements to the underlying Collection.
    
    Parameters:
    
    elements - The elements to add
    
    Returns:
    
    This value, for chaining
    
    See Also:
    
    Collection.addAll(Collection)
  - remove
```
M remove(E element)
```
    Removes the given element from the backed Collection.
    
    Parameters:
    
    element - The element to remove
    
    Returns:
    
    This value, for chaining
  - removeAll
```
M removeAll(java.lang.Iterable<E> elements)
```
    Removes all elements from the Iterable from the backed Collection.
    
    Parameters:
    
    elements - The elements to remove
    
    Returns:
    
    This value, for chaining
  - removeAll
```
M removeAll(java.util.function.Predicate<E> predicate)
```
    Iterates over all existing elements and removes any elements that Predicate.test(Object) returns true.
    
    Parameters:
    
    predicate - The predicate to remove elements
    
    Returns:
    
    This value, for chaining
  - set
```
M set(C value)
```
    Description copied from interface: Value.Mutable
    
    Sets the underlying value to the provided value.
    
    Specified by:
    
    set in interface Value.Mutable<E>
    
    Parameters:
    
    value - The value to set
    
    Returns:
    
    The owning ValueContainer
  - transform
```
M transform(java.util.function.Function<C,C> function)
```
    Description copied from interface: Value.Mutable
    
    Attempts to transform the underlying value based on the provided Function such that the result of Function.apply(Object) will replace the underlying value.
    
    Specified by:
    
    transform in interface Value.Mutable<E>
    
    Parameters:
    
    function - The function to apply on the existing value
    
    Returns:
    
    The owning ValueContainer
  - copy
```
M copy()
```
    Description copied from interface: Value.Mutable
    
    Makes an independent copy of this Value.Mutable with the same initial data. Both this value and the new value will refer to the same object initially.
    
    Specified by:
    
    copy in interface Value.Mutable<E>
    
    Returns:
    
    A new copy of this Value.Mutable
  - asMutableCopy
```
default M asMutableCopy()
```
    Description copied from interface: Value
    
    Retrieves a copy in the mutable form of this value. The new is created with the same key and values.
    
    Specified by:
    
    asMutableCopy in interface CollectionValue<E,C extends java.util.Collection<E>>
    
    Specified by:
    
    asMutableCopy in interface Value<E>
    
    Specified by:
    
    asMutableCopy in interface Value.Mutable<E>
    
    Returns:
    
    A mutable value
  - asMutable
```
default M asMutable()
```
    Description copied from interface: Value
    
    Retrieves a mutable form of this value. Due to the vague nature of the value itself, some cases can already provide a Value.Mutable instance where this would simply return itself. In other cases, where the retrieved value is an Value.Immutable instance, a new mutable value is created with the same key and values.
    
    Specified by:
    
    asMutable in interface CollectionValue<E,C extends java.util.Collection<E>>
    
    Specified by:
    
    asMutable in interface Value<E>
    
    Specified by:
    
    asMutable in interface Value.Mutable<E>
    
    Returns:
    
    A mutable value
  - asImmutable
```
I asImmutable()
```
    Description copied from interface: Value.Mutable
    
    Gets the Value.Immutable version of this Value.Mutable such that all data is duplicated across to the new Value.Immutable. Note that once created, the Value.Immutable is not going to change.
    
    Specified by:
    
    asImmutable in interface CollectionValue<E,C extends java.util.Collection<E>>
    
    Specified by:
    
    asImmutable in interface Value<E>
    
    Specified by:
    
    asImmutable in interface Value.Mutable<E>
    
    Returns:
    
    A new Value.Immutable instance

Interface CollectionValue.Mutable<E,​C extends java.util.Collection<E>,​M extends CollectionValue.Mutable<E,​C,​M,​I>,​I extends CollectionValue.Immutable<E,​C,​I,​M>>

Nested Class Summary

Nested classes/interfaces inherited from interface org.spongepowered.api.data.value.CollectionValue

Nested classes/interfaces inherited from interface org.spongepowered.api.data.value.Value

Method Summary

Methods inherited from interface org.spongepowered.api.data.value.CollectionValue

Methods inherited from interface java.lang.Iterable

Methods inherited from interface org.spongepowered.api.data.value.Value

Method Detail

add

addAll

remove

removeAll

removeAll

set

transform

copy

asMutableCopy

asMutable

asImmutable

Interface CollectionValue.Mutable<E,C extends java.util.Collection<E>,M extends CollectionValue.Mutable<E,C,M,I>,I extends CollectionValue.Immutable<E,C,I,M>>