Package org.spongepowered.api.data.value
Interface SetValue.Immutable<E>
-
- Type Parameters:
E- The type of elements supported
- All Superinterfaces:
CollectionValue<E,Set<E>>,CollectionValue.Immutable<E,Set<E>,SetValue.Immutable<E>,SetValue.Mutable<E>>,Iterable<E>,SetValue<E>,Value<Set<E>>,Value.Immutable<Set<E>>
public static interface SetValue.Immutable<E> extends SetValue<E>, CollectionValue.Immutable<E,Set<E>,SetValue.Immutable<E>,SetValue.Mutable<E>>
Represents a type ofCollectionValue.Immutablebacked by aSet. The reasoning is that aSetretains 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 Collection<E>,I extends CollectionValue.Immutable<E,C,I,M>,M extends CollectionValue.Mutable<E,C,M,I>>, CollectionValue.Mutable<E,C extends 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
All Methods Instance Methods Abstract Methods Default Methods 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
-
-
-
-
Method Detail
-
asMutable
SetValue.Mutable<E> asMutable()
Description copied from interface:ValueRetrieves a mutable form of this value. Due to the vague nature of the value itself, some cases can already provide aValue.Mutableinstance where this would simply return itself. In other cases, where the retrieved value is anValue.Immutableinstance, a new mutable value is created with the same key and values.- Specified by:
asMutablein interfaceCollectionValue<E,Set<E>>- Specified by:
asMutablein interfaceCollectionValue.Immutable<E,Set<E>,SetValue.Immutable<E>,SetValue.Mutable<E>>- Specified by:
asMutablein interfaceSetValue<E>- Specified by:
asMutablein interfaceValue<E>- Specified by:
asMutablein interfaceValue.Immutable<E>- Returns:
- A mutable value
-
asMutableCopy
default SetValue.Mutable<E> asMutableCopy()
Description copied from interface:ValueRetrieves a copy in the mutable form of this value. The new is created with the same key and values.- Specified by:
asMutableCopyin interfaceCollectionValue<E,Set<E>>- Specified by:
asMutableCopyin interfaceCollectionValue.Immutable<E,Set<E>,SetValue.Immutable<E>,SetValue.Mutable<E>>- Specified by:
asMutableCopyin interfaceSetValue<E>- Specified by:
asMutableCopyin interfaceValue<E>- Specified by:
asMutableCopyin interfaceValue.Immutable<E>- Returns:
- A mutable value
-
asImmutable
default SetValue.Immutable<E> asImmutable()
Description copied from interface:ValueRetrieves an immutable form of this value. Due to the vague nature of the value itself, some cases can already provide aValue.Immutableinstance where this would simply return itself. In other cases, where the retrieved value is aValue.Mutableinstance, a new immutable value is created with the same key and values.- Specified by:
asImmutablein interfaceCollectionValue<E,Set<E>>- Specified by:
asImmutablein interfaceCollectionValue.Immutable<E,Set<E>,SetValue.Immutable<E>,SetValue.Mutable<E>>- Specified by:
asImmutablein interfaceSetValue<E>- Specified by:
asImmutablein interfaceValue<E>- Specified by:
asImmutablein interfaceValue.Immutable<E>- Returns:
- An immutable value
-
-