me.lucko.luckperms.api.caching

Interface MetaData

All Superinterfaces:

CachedDataContainer

public interface MetaData
extends CachedDataContainer

Holds cached meta lookup data for a specific set of contexts.

Since:

2.13

Method Summary

Modifier and Type	Method and Description
@NonNull Map<String,String>	getMeta() Gets an immutable copy of the meta this user has.
@NonNull MetaContexts	getMetaContexts() Gets the contexts this container is holding data for.
@NonNull ListMultimap<String,String>	getMetaMultimap() Gets an immutable copy of the meta this user has.
@Nullable String	getPrefix() Gets the user's highest priority prefix, or null if the user has no prefixes
@NonNull SortedMap<Integer,String>	getPrefixes() Gets an immutable sorted map of all of the prefixes the user has, whereby the first value is the highest priority prefix.
@NonNull MetaStackDefinition	getPrefixStackDefinition() Gets the definition used for the prefix stack
@Nullable String	getSuffix() Gets the user's highest priority suffix, or null if the user has no suffixes
@NonNull SortedMap<Integer,String>	getSuffixes() Gets an immutable sorted map of all of the suffixes the user has, whereby the first value is the highest priority suffix.
@NonNull MetaStackDefinition	getSuffixStackDefinition() Gets the definition used for the suffix stack

Methods inherited from interface me.lucko.luckperms.api.caching.CachedDataContainer

getContexts

Method Detail

getMetaContexts

@NonNull MetaContexts getMetaContexts()

Gets the contexts this container is holding data for.

Returns:

the contexts this container is caching

getMetaMultimap

@NonNull ListMultimap<String,String> getMetaMultimap()

Gets an immutable copy of the meta this user has.

A list multimap is used because when inherited values are included, each key can be mapped to multiple values.

The first value to be accumulated (and used to represent the key in getMeta() is at index 0 in the list. Any additional values are stored in order of accumulation.

Returns:

an immutable multimap of meta

Since:

3.3

getMeta

@NonNull Map<String,String> getMeta()

Gets an immutable copy of the meta this user has.

This map is formed by taking the entries in getMetaMultimap(), and mapping each key to the value at index 0 in the corresponding list.

Returns:

an immutable map of meta

getPrefixes

@NonNull SortedMap<Integer,String> getPrefixes()

Gets an immutable sorted map of all of the prefixes the user has, whereby the first value is the highest priority prefix.

Returns:

a sorted map of prefixes

getSuffixes

@NonNull SortedMap<Integer,String> getSuffixes()

Gets an immutable sorted map of all of the suffixes the user has, whereby the first value is the highest priority suffix.

Returns:

a sorted map of suffixes

getPrefix

@Nullable String getPrefix()

Gets the user's highest priority prefix, or null if the user has no prefixes

Returns:

a prefix string, or null

getSuffix

@Nullable String getSuffix()

Gets the user's highest priority suffix, or null if the user has no suffixes

Returns:

a suffix string, or null

getPrefixStackDefinition

@NonNull MetaStackDefinition getPrefixStackDefinition()

Gets the definition used for the prefix stack

Returns:

the definition used for the prefix stack

Since:

3.2

getSuffixStackDefinition

@NonNull MetaStackDefinition getSuffixStackDefinition()

Gets the definition used for the suffix stack

Returns:

the definition used for the suffix stack

Since:

3.2