Package org.spongepowered.api.data.value

Interface SetValue.Immutable<E>

Type Parameters:

E - The type of elements supported

All Superinterfaces:

CollectionValue<E,java.util.Set<E>>, CollectionValue.Immutable<E,java.util.Set<E>,SetValue.Immutable<E>,SetValue.Mutable<E>>, java.lang.Iterable<E>, SetValue<E>, Value<java.util.Set<E>>, Value.Immutable<java.util.Set<E>>

Enclosing interface:

SetValue<E>

public static interface SetValue.Immutable<E>
extends SetValue<E>, CollectionValue.Immutable<E,java.util.Set<E>,SetValue.Immutable<E>,SetValue.Mutable<E>>

Represents a type of CollectionValue.Immutable backed by a Set. The reasoning is that a Set retains no ordering of the elements it contains.

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.SetValue

SetValue.Immutable<E>, SetValue.Mutable<E>

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 SetValue.Immutable<E>	asImmutable()	Retrieves an immutable form of this value.
SetValue.Mutable<E>	asMutable()	Retrieves a mutable form of this value.
default SetValue.Mutable<E>	asMutableCopy()	Retrieves a copy in the mutable form of this value.

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

all, contains, containsAll, isEmpty, size

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

transform, with, withAll, withElement, without, withoutAll, withoutAll

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

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

key

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

get

Method Detail

asMutable

SetValue.Mutable<E> 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,java.util.Set<E>>

Specified by:

asMutable in interface CollectionValue.Immutable<E,java.util.Set<E>,SetValue.Immutable<E>,SetValue.Mutable<E>>

Specified by:

asMutable in interface SetValue<E>

Specified by:

asMutable in interface Value<E>

Specified by:

asMutable in interface Value.Immutable<E>

Returns:

A mutable value

asMutableCopy

default SetValue.Mutable<E> 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,java.util.Set<E>>

Specified by:

asMutableCopy in interface CollectionValue.Immutable<E,java.util.Set<E>,SetValue.Immutable<E>,SetValue.Mutable<E>>

Specified by:

asMutableCopy in interface SetValue<E>

Specified by:

asMutableCopy in interface Value<E>

Specified by:

asMutableCopy in interface Value.Immutable<E>

Returns:

A mutable value

asImmutable

default SetValue.Immutable<E> 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,java.util.Set<E>>

Specified by:

asImmutable in interface CollectionValue.Immutable<E,java.util.Set<E>,SetValue.Immutable<E>,SetValue.Mutable<E>>

Specified by:

asImmutable in interface SetValue<E>

Specified by:

asImmutable in interface Value<E>

Specified by:

asImmutable in interface Value.Immutable<E>

Returns:

An immutable value