net.luckperms.api.context

Interface ImmutableContextSet

All Superinterfaces:

ContextSet, Iterable<Context>

public interface ImmutableContextSet
extends ContextSet

An immutable implementation of ContextSet.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ImmutableContextSet.Builder A builder for ImmutableContextSet.

Method Summary

Modifier and Type	Method and Description
static @NonNull ImmutableContextSet.Builder	builder() Creates an ImmutableContextSet.Builder.
static @NonNull ImmutableContextSet	empty() Returns an empty ImmutableContextSet.
@NonNull ImmutableContextSet	immutableCopy() Deprecated. Already immutable!
static @NonNull ImmutableContextSet	of(@NonNull String key, @NonNull String value) Creates an ImmutableContextSet from 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 an ImmutableContextSet.Builder.

Returns:

a new ImmutableContextSet builder

empty

static @NonNull ImmutableContextSet empty()

Returns an empty ImmutableContextSet.

Returns:

an empty ImmutableContextSet

of

static @NonNull ImmutableContextSet of(@NonNull String key,
                                       @NonNull String value)

Creates an ImmutableContextSet from a context pair.

Parameters:

key - the key

value - the value

Returns:

a new ImmutableContextSet containing one context pair

Throws:

NullPointerException - if key or value is null

immutableCopy

@Deprecated
@NonNull ImmutableContextSet immutableCopy()

Deprecated. Already immutable!

Description copied from interface: ContextSet

Returns an immutable representation of this ContextSet.

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:

immutableCopy in interface ContextSet

Returns:

an immutable representation of this set