Package net.luckperms.api.context
Interface ImmutableContextSet
-
- All Superinterfaces:
ContextSet,Iterable<Context>
public interface ImmutableContextSet extends ContextSet
An immutable implementation ofContextSet.
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static interfaceImmutableContextSet.BuilderA builder forImmutableContextSet.
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description static @NonNull ImmutableContextSet.Builderbuilder()Creates anImmutableContextSet.Builder.static @NonNull ImmutableContextSetempty()Returns an emptyImmutableContextSet.@NonNull ImmutableContextSetimmutableCopy()Deprecated.This context set is already immutable!static @NonNull ImmutableContextSetof(@NonNull String key, @NonNull String value)Creates anImmutableContextSetfrom a context pair.-
Methods inherited from interface net.luckperms.api.context.ContextSet
contains, contains, containsAny, containsKey, getAnyValue, getValues, isEmpty, isImmutable, isSatisfiedBy, isSatisfiedBy, iterator, mutableCopy, size, toFlattenedMap, toMap, toSet
-
Methods inherited from interface java.lang.Iterable
forEach, spliterator
-
-
-
-
Method Detail
-
builder
static @NonNull ImmutableContextSet.Builder builder()
Creates anImmutableContextSet.Builder.- Returns:
- a new ImmutableContextSet builder
-
empty
static @NonNull ImmutableContextSet empty()
Returns an emptyImmutableContextSet.- Returns:
- an empty ImmutableContextSet
-
of
static @NonNull ImmutableContextSet of(@NonNull String key, @NonNull String value)
Creates anImmutableContextSetfrom a context pair.- Parameters:
key- the keyvalue- the value- Returns:
- a new ImmutableContextSet containing one context pair
- Throws:
NullPointerException- if key or value is null
-
immutableCopy
@Deprecated @NonNull ImmutableContextSet immutableCopy()
Deprecated.This context set is already immutable!Description copied from interface:ContextSetReturns an immutable representation of thisContextSet.If the set is already immutable, the same object will be returned. If the set is mutable, an immutable copy will be made.
- Specified by:
immutableCopyin interfaceContextSet- Returns:
- an immutable representation of this set
-
-