Package org.spongepowered.api.data.value

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

Type Parameters:

E - The type of element

C - The type of collection

All Superinterfaces:

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

All Known Subinterfaces:

CollectionValue.Immutable<E,C,I,M>, CollectionValue.Mutable<E,C,M,I>, ListValue<E>, ListValue.Immutable<E>, ListValue.Mutable<E>, SetValue<E>, SetValue.Immutable<E>, SetValue.Mutable<E>, WeightedCollectionValue<E>, WeightedCollectionValue.Immutable<E>, WeightedCollectionValue.Mutable<E>

public interface CollectionValue<E,C extends java.util.Collection<E>>
extends Value<C>, java.lang.Iterable<E>

A Collection based Value type. Since some collections are complex, or can be empty, this exposes some of the common methods found in Collection and it itself is Iterable. This is the base class for the common collections, like ListValue and SetValue.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
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>>	A Value.Immutable type that handles a Collection of elements type E.
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>>	Represents a Value.Mutable that is backed by a Collection of elements.

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

Value.Factory

Method Summary

Modifier and Type	Method	Description
C	all()	Creates a new Collection of the proper type C with all elements copied to the new collection.
CollectionValue.Immutable<E,C,?,?>	asImmutable()	Retrieves an immutable form of this value.
CollectionValue.Mutable<E,C,?,?>	asMutable()	Retrieves a mutable form of this value.
CollectionValue.Mutable<E,C,?,?>	asMutableCopy()	Retrieves a copy in the mutable form of this value.
boolean	contains(E element)	Checks if the given E element is contained within the backed Collection.
boolean	containsAll(java.lang.Iterable<E> iterable)	Checks if all of the given elements in the provided Iterable are contained within the backed Collection.
boolean	isEmpty()	Checks if the backed Collection is empty.
int	size()	Gets the size of the underlying collection of elements.

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

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

get, key

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

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(java.lang.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

all

C all()

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

Returns:

A new collection with all elements copied

asMutable

CollectionValue.Mutable<E,C,?,?> 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 Value<E>

Returns:

A mutable value

asMutableCopy

CollectionValue.Mutable<E,C,?,?> 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 Value<E>

Returns:

A mutable value

asImmutable

CollectionValue.Immutable<E,C,?,?> 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 Value<E>

Returns:

An immutable value