me.lucko.luckperms.api.context

Class ImmutableContextSet.Builder

java.lang.Object

me.lucko.luckperms.api.context.ImmutableContextSet.Builder

Enclosing class:

ImmutableContextSet

public static final class ImmutableContextSet.Builder
extends Object

A builder for ImmutableContextSet.

Since:

4.1

Method Summary

Modifier and Type	Method and Description
@NonNull ImmutableContextSet.Builder	add(Map.Entry<String,String> 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.
@NonNull ImmutableContextSet.Builder	addAll(@NonNull Iterable<? extends Map.Entry<String,String>> iterable) Adds the contexts contained in the given Iterable to the set.
@NonNull ImmutableContextSet.Builder	addAll(@NonNull Map<String,String> map) Adds the contexts contained in the given Map to the set.
@NonNull ImmutableContextSet.Builder	addAll(@NonNull Multimap<String,String> multimap) Adds the contexts contained in the given Multimap to the set.
@NonNull ImmutableContextSet	build() Creates a ImmutableContextSet from the values previously added to the builder.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

add

public @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

public @NonNull ImmutableContextSet.Builder add(Map.Entry<String,String> 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(Map.Entry)

addAll

public @NonNull ImmutableContextSet.Builder addAll(@NonNull Iterable<? extends Map.Entry<String,String>> 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

public @NonNull ImmutableContextSet.Builder addAll(@NonNull Map<String,String> map)

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

Parameters:

map - the map to add from

Returns:

the builder

Throws:

NullPointerException - if the map is null

See Also:

MutableContextSet.addAll(Map)

addAll

public @NonNull ImmutableContextSet.Builder addAll(@NonNull Multimap<String,String> multimap)

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

Parameters:

multimap - the multimap to add from

Returns:

the builder

Throws:

NullPointerException - if the map is null

Since:

3.4

See Also:

MutableContextSet.addAll(Multimap)

addAll

public @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

public @NonNull ImmutableContextSet build()

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

Returns:

an ImmutableContextSet from the builder