ContextSet (luckperms-api 4.3 API)

All Superinterfaces:

Iterable<Map.Entry<String,String>>

All Known Implementing Classes:

ImmutableContextSet, MutableContextSet
```
public interface ContextSet
extends Iterable<Map.Entry<String,String>>
```
A set of contexts.
Context in the most basic sense simply means the circumstances where something will apply.

A single "context" consists of a key and a value, both strings. The key represents the type of context, and the value represents the setting of the context key.

Contexts can be combined with each other to form so called "context sets" - simply a collection of context pairs.

Context keys and values are case-insensitive, and will be converted to lowercase by all implementations.

Context keys and values may not be null or empty. A key/value will be deemed empty if it's length is zero, or if it consists of only space characters.

Two default ContextSet implementations are provided. MutableContextSet allows the addition and removal of context keys after construction, and ImmutableContextSet does not.

Since:

2.13

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`containsKey(@NonNull String key)` Returns if the `ContextSet` contains at least one value for the given key.
`static @NonNull ImmutableContextSet`	`empty()` Returns an empty `ImmutableContextSet`.
`static @NonNull ImmutableContextSet`	`fromEntries(@NonNull Iterable<? extends Map.Entry<String,String>> iterable)` Creates an `ImmutableContextSet` from an existing `Iterable` of `Map.Entry`s.
`static @NonNull ImmutableContextSet`	`fromMap(@NonNull Map<String,String> map)` Creates an `ImmutableContextSet` from an existing `Map`.
`static @NonNull ImmutableContextSet`	`fromMultimap(@NonNull Multimap<String,String> multimap)` Creates an `ImmutableContextSet` from an existing `Multimap`.
`static @NonNull ImmutableContextSet`	`fromSet(@NonNull ContextSet contextSet)` Creates an new `ImmutableContextSet` from an existing `Set`.
`default @NonNull Optional<String>`	`getAnyValue(@NonNull String key)` Returns any value from this `ContextSet` matching the key, if present.
`@NonNull Set<String>`	`getValues(@NonNull String key)` Returns a `Set` of the values mapped to the given key.
`default boolean`	`has(Map.Entry<String,String> entry)` Returns if the `ContextSet` contains a given context pairing.
`boolean`	`has(@NonNull String key, @NonNull String value)` Returns if the `ContextSet` contains a given context pairing.
`boolean`	`isEmpty()` Returns if the `ContextSet` is empty.
`boolean`	`isImmutable()` Gets if this `ContextSet` is immutable.
`default boolean`	`isSatisfiedBy(@NonNull ContextSet other)` Returns if this `ContextSet` is fully "satisfied" by another set.
`@NonNull Iterator<Map.Entry<String,String>>`	`iterator()` Returns an `Iterator` over each of the context pairs in this set.
`@NonNull ImmutableContextSet`	`makeImmutable()` Returns an immutable representation of this `ContextSet`.
`@NonNull MutableContextSet`	`mutableCopy()` Creates a mutable copy of this `ContextSet`.
`static @NonNull ImmutableContextSet`	`of(@NonNull String key1, @NonNull String value1, @NonNull String key2, @NonNull String value2)` Creates an `ImmutableContextSet` from two context pairs.
`static @NonNull ImmutableContextSet`	`singleton(@NonNull String key, @NonNull String value)` Creates an `ImmutableContextSet` from a context pair.
`int`	`size()` Gets the number of context pairs in the `ContextSet`.
`@NonNull Map<String,String>`	`toMap()` Deprecated. because the resultant map may not contain all data in the ContextSet
`@NonNull Multimap<String,String>`	`toMultimap()` Returns a `Multimap` representing the current state of this `ContextSet`.
`@NonNull Set<Map.Entry<String,String>>`	`toSet()` Returns a `Set` of `Map.Entry`s representing the current state of this `ContextSet`.

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Method Detail
  - singleton
```
static @NonNull ImmutableContextSet singleton(@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
  - of
```
static @NonNull ImmutableContextSet of(@NonNull String key1,
                                       @NonNull String value1,
                                       @NonNull String key2,
                                       @NonNull String value2)
```
    Creates an ImmutableContextSet from two context pairs.
    
    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
```
static @NonNull ImmutableContextSet fromEntries(@NonNull Iterable<? extends Map.Entry<String,String>> iterable)
```
    Creates an ImmutableContextSet from an existing Iterable of Map.Entrys.
    
    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
```
static @NonNull ImmutableContextSet fromMap(@NonNull Map<String,String> map)
```
    Creates an ImmutableContextSet from an existing Map.
    
    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
```
static @NonNull ImmutableContextSet fromMultimap(@NonNull Multimap<String,String> multimap)
```
    Creates an ImmutableContextSet from an existing Multimap.
    
    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
```
static @NonNull ImmutableContextSet fromSet(@NonNull ContextSet contextSet)
```
    Creates an new ImmutableContextSet from an existing Set.
    Only really useful for converting between mutable and immutable types.
    
    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
```
static @NonNull ImmutableContextSet empty()
```
    Returns an empty ImmutableContextSet.
    
    Returns:
    
    an empty ImmutableContextSet
  - isImmutable
```
boolean isImmutable()
```
    Gets if this ContextSet is immutable.
    The state of immutable instances will never change.
    
    Returns:
    
    true if the set is immutable
  - makeImmutable
```
@NonNull ImmutableContextSet makeImmutable()
```
    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.
    
    Returns:
    
    an immutable representation of this set
  - mutableCopy
```
@NonNull MutableContextSet mutableCopy()
```
    Creates a mutable copy of this ContextSet.
    A new copy is returned regardless of the mutability of this set.
    
    Returns:
    
    a mutable ContextSet
    
    Since:
    
    2.16
  - toSet
```
@NonNull Set<Map.Entry<String,String>> toSet()
```
    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)
    
    Returns:
    
    an immutable set
  - toMap
```
@Deprecated
@NonNull Map<String,String> toMap()
```
    Deprecated. because the resultant map may not contain all data in the 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 toSet() or toMultimap() followed by Multimap.asMap().
    
    Returns:
    
    an immutable map
  - toMultimap
```
@NonNull Multimap<String,String> toMultimap()
```
    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)
    
    Returns:
    
    a multimap
    
    Since:
    
    2.16
  - iterator
```
@NonNull Iterator<Map.Entry<String,String>> iterator()
```
    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>>
    
    Returns:
    
    an iterator
  - containsKey
```
boolean containsKey(@NonNull String key)
```
    Returns if the ContextSet contains at least one value for the given key.
    
    Parameters:
    
    key - the key to check for
    
    Returns:
    
    true if the set contains a value for the key
    
    Throws:
    
    NullPointerException - if the key is null
  - getValues
```
@NonNull Set<String> getValues(@NonNull String key)
```
    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)
    
    Parameters:
    
    key - the key to get values for
    
    Returns:
    
    a set of values
    
    Throws:
    
    NullPointerException - if the key is null
  - getAnyValue
```
default @NonNull Optional<String> getAnyValue(@NonNull String key)
```
    Returns any value from this ContextSet matching the key, if present.
    Note that context keys can be mapped to multiple values. Use getValues(String) to retrieve all associated values.
    
    Parameters:
    
    key - the key to find values for
    
    Returns:
    
    an optional containing any match
    
    Since:
    
    3.1
  - has
```
boolean has(@NonNull String key,
            @NonNull String value)
```
    Returns if the ContextSet contains a given context pairing.
    
    Parameters:
    
    key - the key to look for
    
    value - the value to look for
    
    Returns:
    
    true if the set contains the context pair
    
    Throws:
    
    NullPointerException - if the key or value is null
  - has
```
default boolean has(Map.Entry<String,String> entry)
```
    Returns if the ContextSet contains a given context pairing.
    
    Parameters:
    
    entry - the entry to look for
    
    Returns:
    
    true if the set contains the context pair
    
    Throws:
    
    NullPointerException - if the key or value is null
  - isSatisfiedBy
```
default boolean isSatisfiedBy(@NonNull ContextSet other)
```
    Returns if this ContextSet is fully "satisfied" by another set.
    For a context set to "satisfy" another, it must itself contain all of the context pairings in the other set.
    
    Mathematically, this method returns true if this set is a subset of the other.
    
    Parameters:
    
    other - the other set to check
    
    Returns:
    
    true if all entries in this set are also in the other set
    
    Since:
    
    3.1
  - isEmpty
```
boolean isEmpty()
```
    Returns if the ContextSet is empty.
    
    Returns:
    
    true if the set is empty
  - size
```
int size()
```
    Gets the number of context pairs in the ContextSet.
    
    Returns:
    
    the size of the set

Interface ContextSet

Method Summary

Methods inherited from interface java.lang.Iterable

Method Detail

singleton

of

fromEntries

fromMap

fromMultimap

fromSet

empty

isImmutable

makeImmutable

mutableCopy

toSet

toMap

toMultimap

iterator

containsKey

getValues

getAnyValue

has

has

isSatisfiedBy

isEmpty

size