Package org.spongepowered.api.data.value

Interface 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>>

Type Parameters:

E - The type of element

C - The type of Collection

I - The extended CollectionValue.Immutable for self referencing

M - The mutable CollectionValue.Mutable counterpart for asMutable()

All Superinterfaces:

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

All Known Subinterfaces:

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

Enclosing interface:

CollectionValue<E,C extends java.util.Collection<E>>

public static interface 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>>
extends Value.Immutable<C>, CollectionValue<E,C>

A Value.Immutable type that handles a Collection of elements type E. All of the methods provided for modification return new instances of the same type. Likewise, the underlying ValueContainer is not modified.

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

Modifier and Type	Method	Description
default I	asImmutable()	Retrieves an immutable form of this value.
M	asMutable()	Creates a mutable Value.Mutable for this Value.Immutable.
default M	asMutableCopy()	Retrieves a copy in the mutable form of this value.
I	transform(java.util.function.Function<C,C> function)	Retrieves the underlying value for this Value.Immutable and applies the given Function onto that value, after which, the product is sent to a new Value.Immutable replacing this one.
I	with(C value)	Creates a new Value.Immutable with the given E typed value, such that if the owning ValueContainer is immutable, the ValueContainer too is recreated as a new instance with the new Value.Immutable.
I	withAll(java.lang.Iterable<E> elements)	Creates a new CollectionValue.Immutable with the given elements along with any pre-existing values within this value.
I	withElement(E element)	Creates a new CollectionValue.Immutable with the given values along with any pre-existing values within this value.
I	without(E element)	Creates a new CollectionValue.Immutable without the given E element.
I	withoutAll(java.lang.Iterable<E> elements)	Creates a new CollectionValue.Immutable without the given elements of the provided Iterable.
I	withoutAll(java.util.function.Predicate<E> predicate)	Creates a new CollectionValue.Immutable with elements that when the given Predicate is Predicate.test(Object) on the element and true is returned, the element will remain in the new CollectionValue.Immutable.

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

withElement

I withElement(E element)

Creates a new CollectionValue.Immutable with the given values along with any pre-existing values within this value.

Parameters:

element - The element to add

Returns:

The new value

withAll

I withAll(java.lang.Iterable<E> elements)

Creates a new CollectionValue.Immutable with the given elements along with any pre-existing values within this value.

Parameters:

elements - The elements to add

Returns:

The new value

See Also:

Collection.addAll(Collection)

without

I without(E element)

Creates a new CollectionValue.Immutable without the given E element.

Parameters:

element - The element to exclude

Returns:

The new value

withoutAll

I withoutAll(java.lang.Iterable<E> elements)

Creates a new CollectionValue.Immutable without the given elements of the provided Iterable.

Parameters:

elements - The elements to exclude

Returns:

The new value

withoutAll

I withoutAll(java.util.function.Predicate<E> predicate)

Creates a new CollectionValue.Immutable with elements that when the given Predicate is Predicate.test(Object) on the element and true is returned, the element will remain in the new CollectionValue.Immutable.

Parameters:

predicate - The predicate to apply

Returns:

The new value

with

I with(C value)

Description copied from interface: Value.Immutable

Creates a new Value.Immutable with the given E typed value, such that if the owning ValueContainer is immutable, the ValueContainer too is recreated as a new instance with the new Value.Immutable.

Specified by:

with in interface Value.Immutable<E>

Parameters:

value - The value to replace

Returns:

The owning ValueContainer, a new instance if it too is immutable

transform

I transform(java.util.function.Function<C,C> function)

Description copied from interface: Value.Immutable

Retrieves the underlying value for this Value.Immutable and applies the given Function onto that value, after which, the product is sent to a new Value.Immutable replacing this one.

If the ValueContainer too is immutable, a new instance of the ValueContainer may be created. If the ValueContainer is mutable, the same instance of the ValueContainer is retained.

Specified by:

transform in interface Value.Immutable<E>

Parameters:

function - The function to apply onto the existing value

Returns:

The owning ValueContainer, a new instance if it too is immutable

asMutable

M asMutable()

Description copied from interface: Value.Immutable

Creates a mutable Value.Mutable for this Value.Immutable.

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.Immutable<E>

Returns:

A mutable value

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.Immutable<E>

Returns:

A mutable value

asImmutable

default I asImmutable()

Description copied from interface: Value

Retrieves an immutable form of this value. Due to the vague nature of the value itself, some cases can already provide a Value.Immutable instance where this would simply return itself. In other cases, where the retrieved value is a Value.Mutable instance, a new immutable value is created with the same key and values.

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.Immutable<E>

Returns:

An immutable value