org.spongepowered.api.data.value.immutable

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

Type Parameters:

E - The type of element

C - The type of Collection

I - The extended ImmutableCollectionValue for self referencing

M - The mutable CollectionValue counterpart for asMutable()

All Superinterfaces:

BaseValue<C>, ImmutableValue<C>

All Known Subinterfaces:

ImmutableListValue<E>, ImmutablePatternListValue, ImmutableSetValue<E>, ImmutableWeightedCollectionValue<E>

public interface ImmutableCollectionValue<E,C extends Collection<E>,I extends ImmutableCollectionValue<E,C,I,M>,M extends CollectionValue<E,C,M,I>>
extends ImmutableValue<C>

A ImmutableValue 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.

Method Summary

Modifier and Type	Method and Description
M	asMutable() Creates a mutable Value for this ImmutableValue.
boolean	contains(E element) Checks if the given E element is contained within the backed Collection.
boolean	containsAll(Iterable<E> iterable) Checks if all of the given elements in the provided Iterable are contained within the backed Collection.
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.
int	size() Gets the size of the underlying collection of elements.
I	transform(Function<C,C> function) Retrieves the underlying value for this ImmutableValue and applies the given Function onto that value, after which, the product is sent to a new ImmutableValue replacing this one.
I	with(C collection) Creates a new ImmutableValue 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 ImmutableValue.
I	withAll(Iterable<E> elements) Creates a new ImmutableCollectionValue with the given elements along with any pre-existing values within this value.
I	withElement(E elements) Creates a new ImmutableCollectionValue with the given values along with any pre-existing values within this value.
I	without(E element) Creates a new ImmutableCollectionValue without the given E element.
I	withoutAll(Iterable<E> elements) Creates a new ImmutableCollectionValue without the given elements of the provided Iterable.
I	withoutAll(Predicate<E> predicate) Creates a new ImmutableCollectionValue 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 ImmutableCollectionValue.

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

exists, get, getDefault, getDirect, getKey

Method Detail

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

with

I with(C collection)

Description copied from interface: ImmutableValue

Creates a new ImmutableValue 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 ImmutableValue.

Specified by:

with in interface ImmutableValue<C extends Collection<E>>

Parameters:

collection - The value to replace

Returns:

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

withElement

I withElement(E elements)

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

Parameters:

elements - The values to add

Returns:

The new value

transform

I transform(Function<C,C> function)

Description copied from interface: ImmutableValue

Retrieves the underlying value for this ImmutableValue and applies the given Function onto that value, after which, the product is sent to a new ImmutableValue 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 ImmutableValue<C extends Collection<E>>

Parameters:

function - The function to apply onto the existing value

Returns:

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

withAll

I withAll(Iterable<E> elements)

Creates a new ImmutableCollectionValue 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 ImmutableCollectionValue without the given E element.

Parameters:

element - The element to exclude

Returns:

The new value

withoutAll

I withoutAll(Iterable<E> elements)

Creates a new ImmutableCollectionValue without the given elements of the provided Iterable.

Parameters:

elements - The elements to exclude

Returns:

The new value

withoutAll

I withoutAll(Predicate<E> predicate)

Creates a new ImmutableCollectionValue 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 ImmutableCollectionValue.

Parameters:

predicate - The predicte to apply

Returns:

The new value

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, false if not

containsAll

boolean containsAll(Iterable<E> iterable)

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

Parameters:

iterable - The iterable elements

Returns:

True if all elements are contained within the backed collection

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 ImmutableCollectionValue. Likewise, no modifications to this ImmutableCollectionValue are reflected to the returned Collection.

Returns:

A new collection with all elements copied

asMutable

M asMutable()

Description copied from interface: ImmutableValue

Creates a mutable Value for this ImmutableValue.

Specified by:

asMutable in interface ImmutableValue<C extends Collection<E>>

Returns:

A mutable value