me.lucko.luckperms.api.context

Class ImmutableContextSet

java.lang.Object

me.lucko.luckperms.api.context.ImmutableContextSet

All Implemented Interfaces:

Iterable<Map.Entry<String,String>>, ContextSet

@Immutable
public final class ImmutableContextSet
extends Object
implements ContextSet

An immutable implementation of ContextSet.

Since:

2.16

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ImmutableContextSet.Builder A builder for ImmutableContextSet.

Method Summary

Modifier and Type	Method and Description
protected SetMultimap<String,String>	backing()
static ImmutableContextSet.Builder	builder() Creates an ImmutableContextSet.Builder.
boolean	containsKey(String key) Returns if the ContextSet contains at least one value for the given key.
protected void	copyTo(SetMultimap<String,String> other)
static ImmutableContextSet	empty() Returns an empty ImmutableContextSet.
boolean	equals(Object o)
static ImmutableContextSet	fromEntries(Iterable<? extends Map.Entry<String,String>> iterable) Creates an ImmutableContextSet from an existing Iterable of Map.Entrys.
static ImmutableContextSet	fromMap(Map<String,String> map) Creates an ImmutableContextSet from an existing Map.
static ImmutableContextSet	fromMultimap(Multimap<String,String> multimap) Creates an ImmutableContextSet from an existing Multimap.
static ImmutableContextSet	fromSet(ContextSet contextSet) Creates an new ImmutableContextSet from an existing Set.
Set<String>	getValues(String key) Returns a Set of the values mapped to the given key.
boolean	has(String key, String value) Returns if the ContextSet contains a given context pairing.
int	hashCode()
boolean	isEmpty() Returns if the ContextSet is empty.
boolean	isImmutable() Gets if this ContextSet is immutable.
Iterator<Map.Entry<String,String>>	iterator() Returns an Iterator over each of the context pairs in this set.
ImmutableContextSet	makeImmutable() Deprecated.
MutableContextSet	mutableCopy() Creates a mutable copy of this ContextSet.
static ImmutableContextSet	of(String key1, String value1, String key2, String value2) Creates an ImmutableContextSet from two context pairs.
static ImmutableContextSet	singleton(String key, String value) Creates an ImmutableContextSet from a context pair.
int	size() Gets the number of context pairs in the ContextSet.
Spliterator<Map.Entry<String,String>>	spliterator()
Map<String,String>	toMap() Deprecated.
Multimap<String,String>	toMultimap() Returns a Multimap representing the current state of this ContextSet.
Set<Map.Entry<String,String>>	toSet() Returns a Set of Map.Entrys representing the current state of this ContextSet.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface me.lucko.luckperms.api.context.ContextSet

containsKey, getAnyValue, getValues, has, has, isEmpty, isSatisfiedBy, size

Methods inherited from interface java.lang.Iterable

forEach

Method Detail

builder

@Nonnull
public static ImmutableContextSet.Builder builder()

Creates an ImmutableContextSet.Builder.

Returns:

a new ImmutableContextSet builder

Since:

4.1

singleton

@Nonnull
public static ImmutableContextSet singleton(@Nonnull
                                                      String key,
                                                      @Nonnull
                                                      String value)

Creates an ImmutableContextSet from a context pair.

Specified by:

singleton in interface ContextSet

Parameters:

key - the key

value - the value

Returns:

a new ImmutableContextSet containing one context pair

Throws:

NullPointerException - if key or value is null

of

@Nonnull
public static ImmutableContextSet of(@Nonnull
                                               String key1,
                                               @Nonnull
                                               String value1,
                                               @Nonnull
                                               String key2,
                                               @Nonnull
                                               String value2)

Creates an ImmutableContextSet from two context pairs.

Specified by:

of in interface ContextSet

Parameters:

key1 - the first key

value1 - the first value

key2 - the second key

value2 - the second value

Returns:

a new ImmutableContextSet containing the two pairs

Throws:

NullPointerException - if any of the keys or values are null

Since:

3.1

fromEntries

@Nonnull
public static ImmutableContextSet fromEntries(@Nonnull
                                                        Iterable<? extends Map.Entry<String,String>> iterable)

Creates an ImmutableContextSet from an existing Iterable of Map.Entrys.

Specified by:

fromEntries in interface ContextSet

Parameters:

iterable - the iterable to copy from

Returns:

a new ImmutableContextSet representing the pairs in the iterable

Throws:

NullPointerException - if the iterable is null

fromMap

@Nonnull
public static ImmutableContextSet fromMap(@Nonnull
                                                    Map<String,String> map)

Creates an ImmutableContextSet from an existing Map.

Specified by:

fromMap in interface ContextSet

Parameters:

map - the map to copy from

Returns:

a new ImmutableContextSet representing the pairs from the map

Throws:

NullPointerException - if the map is null

fromMultimap

@Nonnull
public static ImmutableContextSet fromMultimap(@Nonnull
                                                         Multimap<String,String> multimap)

Creates an ImmutableContextSet from an existing Multimap.

Specified by:

fromMultimap in interface ContextSet

Parameters:

multimap - the multimap to copy from

Returns:

a new ImmutableContextSet representing the pairs in the multimap

Throws:

NullPointerException - if the multimap is null

Since:

2.16

fromSet

@Nonnull
public static ImmutableContextSet fromSet(@Nonnull
                                                    ContextSet contextSet)

Creates an new ImmutableContextSet from an existing Set.

Only really useful for converting between mutable and immutable types.

Specified by:

fromSet in interface ContextSet

Parameters:

contextSet - the context set to copy from

Returns:

a new ImmutableContextSet with the same content and the one provided

Throws:

NullPointerException - if contextSet is null

empty

@Nonnull
public static ImmutableContextSet empty()

Returns an empty ImmutableContextSet.

Specified by:

empty in interface ContextSet

Returns:

an empty ImmutableContextSet

backing

protected SetMultimap<String,String> backing()

copyTo

protected void copyTo(SetMultimap<String,String> other)

isImmutable

public boolean isImmutable()

Description copied from interface: ContextSet

Gets if this ContextSet is immutable.

The state of immutable instances will never change.

Specified by:

isImmutable in interface ContextSet

Returns:

true if the set is immutable

makeImmutable

@Nonnull
 @Deprecated
public ImmutableContextSet makeImmutable()

Deprecated.

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:

makeImmutable in interface ContextSet

Returns:

an immutable representation of this set

mutableCopy

@Nonnull
public MutableContextSet mutableCopy()

Description copied from interface: ContextSet

Creates a mutable copy of this ContextSet.

A new copy is returned regardless of the mutability of this set.

Specified by:

mutableCopy in interface ContextSet

Returns:

a mutable ContextSet

toSet

@Nonnull
public Set<Map.Entry<String,String>> toSet()

Description copied from interface: ContextSet

Returns a Set of Map.Entrys representing the current state of this ContextSet.

The returned set is immutable, and is a copy of the current set. (will not update live)

Specified by:

toSet in interface ContextSet

Returns:

an immutable set

toMap

@Nonnull
 @Deprecated
public Map<String,String> toMap()

Deprecated.

Description copied from interface: ContextSet

Returns a Map loosely representing the current state of this ContextSet.

The returned map is immutable, and is a copy of the current set. (will not update live)

As a single context key can be mapped to multiple values, this method may not be a true representation of the set.

If you need a representation of the set in a Java collection instance, use ContextSet.toSet() or ContextSet.toMultimap() followed by Multimap.asMap().

Specified by:

toMap in interface ContextSet

Returns:

an immutable map

toMultimap

@Nonnull
public Multimap<String,String> toMultimap()

Description copied from interface: ContextSet

Returns a Multimap representing the current state of this ContextSet.

The returned multimap is immutable, and is a copy of the current set. (will not update live)

Specified by:

toMultimap in interface ContextSet

Returns:

a multimap

iterator

@Nonnull
public Iterator<Map.Entry<String,String>> iterator()

Description copied from interface: ContextSet

Returns an Iterator over each of the context pairs in this set.

The returned iterator represents the state of the set at the time of creation. It is not updated as the set changes.

The iterator does not support Iterator.remove() calls.

Specified by:

iterator in interface Iterable<Map.Entry<String,String>>

Specified by:

iterator in interface ContextSet

Returns:

an iterator

spliterator

public Spliterator<Map.Entry<String,String>> spliterator()

Specified by:

spliterator in interface Iterable<Map.Entry<String,String>>

hashCode

public int hashCode()

toString

public String toString()

Overrides:

toString in class Object

containsKey

public boolean containsKey(@Nonnull
                           String key)

Description copied from interface: ContextSet

Returns if the ContextSet contains at least one value for the given key.

Specified by:

containsKey in interface ContextSet

Parameters:

key - the key to check for

Returns:

true if the set contains a value for the key

getValues

@Nonnull
public Set<String> getValues(@Nonnull
                                       String key)

Description copied from interface: ContextSet

Returns a Set of the values mapped to the given key.

The returned set is immutable, and only represents the current state of the ContextSet. (will not update live)

Specified by:

getValues in interface ContextSet

Parameters:

key - the key to get values for

Returns:

a set of values

has

public boolean has(@Nonnull
                   String key,
                   @Nonnull
                   String value)

Description copied from interface: ContextSet

Returns if the ContextSet contains a given context pairing.

Specified by:

has in interface ContextSet

Parameters:

key - the key to look for

value - the value to look for

Returns:

true if the set contains the context pair

isEmpty

public boolean isEmpty()

Description copied from interface: ContextSet

Returns if the ContextSet is empty.

Specified by:

isEmpty in interface ContextSet

Returns:

true if the set is empty

size

public int size()

Description copied from interface: ContextSet

Gets the number of context pairs in the ContextSet.

Specified by:

size in interface ContextSet

Returns:

the size of the set

equals

public boolean equals(Object o)

Overrides:

equals in class Object