net.luckperms.api.context

Interface ImmutableContextSet.Builder

Enclosing interface:

ImmutableContextSet

public static interface ImmutableContextSet.Builder

A builder for ImmutableContextSet.

Method Summary

Modifier and Type	Method and Description
default @NonNull ImmutableContextSet.Builder	add(@NonNull Context entry) Adds a context to the set.
@NonNull ImmutableContextSet.Builder	add(@NonNull String key, @NonNull String value) Adds a context to the set.
@NonNull ImmutableContextSet.Builder	addAll(@NonNull ContextSet contextSet) Adds of of the contexts in another ContextSet to the set.
default @NonNull ImmutableContextSet.Builder	addAll(@NonNull Iterable<Context> iterable) Adds the contexts contained in the given Iterable to the set.
@NonNull ImmutableContextSet	build() Creates a ImmutableContextSet from the values previously added to the builder.

Method Detail

add

@NonNull ImmutableContextSet.Builder add(@NonNull String key,
                                         @NonNull String value)

Adds a context to the set.

Parameters:

key - the key to add

value - the value to add

Returns:

the builder

Throws:

NullPointerException - if the key or value is null

See Also:

MutableContextSet.add(String, String)

add

default @NonNull ImmutableContextSet.Builder add(@NonNull Context entry)

Adds a context to the set.

Parameters:

entry - the entry to add

Returns:

the builder

Throws:

NullPointerException - if the entry is null

See Also:

MutableContextSet.add(Context)

addAll

default @NonNull ImmutableContextSet.Builder addAll(@NonNull Iterable<Context> iterable)

Adds the contexts contained in the given Iterable to the set.

Parameters:

iterable - an iterable of key value context pairs

Returns:

the builder

Throws:

NullPointerException - if iterable is null

See Also:

MutableContextSet.addAll(Iterable)

addAll

@NonNull ImmutableContextSet.Builder addAll(@NonNull ContextSet contextSet)

Adds of of the contexts in another ContextSet to the set.

Parameters:

contextSet - the set to add from

Returns:

the builder

Throws:

NullPointerException - if the contextSet is null

See Also:

MutableContextSet.addAll(ContextSet)

build

@NonNull ImmutableContextSet build()

Creates a ImmutableContextSet from the values previously added to the builder.

Returns:

an ImmutableContextSet from the builder