org.spongepowered.api.data.value.mutable

Interface CollectionValue<E,C extends Collection<E>,V extends CollectionValue<E,C,V,I>,I extends ImmutableCollectionValue<E,C,I,V>>

Type Parameters:

E - The type of element

C - The type of collection, for chaining

V - The type of CollectionValue

I - The type of ImmutableCollectionValue

All Superinterfaces:

BaseValue<C>, Iterable<E>, Value<C>

All Known Subinterfaces:

ListValue<E>, PatternListValue, SetValue<E>, WeightedCollectionValue<E>

public interface CollectionValue<E,C extends Collection<E>,V extends CollectionValue<E,C,V,I>,I extends ImmutableCollectionValue<E,C,I,V>>
extends Value<C>, Iterable<E>

Represents a Value that is backed by a Collection of elements.

Method Summary

Modifier and Type	Method and Description
V	add(E element) Adds the given element to this CollectionValue.
V	addAll(Iterable<E> elements) Adds all the given Iterable elements to the underlying Collection.
I	asImmutable() Gets the ImmutableValue version of this Value such that all data is duplicated across to the new ImmutableValue.
boolean	contains(E element) Checks if the given E element is contained within the backed Collection.
boolean	containsAll(Collection<E> iterable) Checks if all of the given Iterable elements are contained within the backed Collection.
V	copy() Makes an independent copy of this Value with the same initial data.
V	filter(Predicate<? super E> predicate) Applies a Predicate to filter the underlying elements in the backed Collection to create a new CollectionValue separate from this CollectionValue.
C	getAll() Creates a new Collection of the proper type C with all elements copied to the new collection.
boolean	isEmpty() Checks if the backed Collection is empty.
V	remove(E element) Removes the given element from the backed Collection.
V	removeAll(Iterable<E> elements) Removes all elements from the Iterable from the backed Collection.
V	removeAll(Predicate<E> predicate) Iterates over all existing elements and removes any elements that Predicate.test(Object) returns true.
V	set(C value) Sets the underlying value to the provided value.
int	size() Gets the size of the underlying collection of elements.
V	transform(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.BaseValue

exists, get, getDefault, getDirect, getKey

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Detail

set

V set(C value)

Description copied from interface: Value

Sets the underlying value to the provided value.

Specified by:

set in interface Value<C extends Collection<E>>

Parameters:

value - The value to set

Returns:

The owning ValueContainer

transform

V transform(Function<C,C> function)

Description copied from interface: Value

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<C extends Collection<E>>

Parameters:

function - The function to apply on the existing value

Returns:

The owning ValueContainer

size

int size()

Gets the size of the underlying collection of elements.

Returns:

The size

isEmpty

boolean isEmpty()

Checks if the backed Collection is empty.

Returns:

True if the collection is empty

See Also:

Collection.isEmpty()

add

V add(E element)

Adds the given element to this CollectionValue.

Parameters:

element - The element to add

Returns:

This value, for chaining

addAll

V addAll(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

V remove(E element)

Removes the given element from the backed Collection.

Parameters:

element - The element to remove

Returns:

This value, for chaining

removeAll

V removeAll(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

V removeAll(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

contains

boolean contains(E element)

Checks if the given E element is contained within the backed Collection.

Parameters:

element - The element to check

Returns:

True if the element is contained in this collection

containsAll

boolean containsAll(Collection<E> iterable)

Checks if all of the given Iterable elements are contained within the backed Collection.

Parameters:

iterable - The iterable elements

Returns:

True if all elements are contained in this value

filter

V filter(Predicate<? super E> predicate)

Applies a Predicate to filter the underlying elements in the backed Collection to create a new CollectionValue separate from this CollectionValue. This value is not modified, nor is the underlying Collection. Elements that return true from Predicate.test(Object) are kept, and those that return false are excluded.

Parameters:

predicate - The predicate to filter

Returns:

This value, for chaining

getAll

C getAll()

Creates a new Collection of the proper type C with all elements copied to the new collection. Any modifications to the new collection are not reflected to this CollectionValue. Likewise, no modifications to this CollectionValue are reflected to the returned Collection.

Returns:

A new collection with all elements copied

asImmutable

I asImmutable()

Description copied from interface: Value

Gets the ImmutableValue version of this Value such that all data is duplicated across to the new ImmutableValue. Note that once created, the ImmutableValue is not going to change.

Specified by:

asImmutable in interface Value<C extends Collection<E>>

Returns:

A new ImmutableValue instance

copy

V copy()

Description copied from interface: Value

Makes an independent copy of this Value 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<C extends Collection<E>>

Returns:

A new copy of this Value