net.luckperms.api.cacheddata

Interface CachedMetaData

All Superinterfaces:

CachedData

public interface CachedMetaData
extends CachedData

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

Method Summary

Modifier and Type	Method and Description
@NonNull Map<String,List<String>>	getMeta() Gets an immutable copy of the meta this holder has.
@Nullable String	getMetaValue(String key) Gets a value for the given meta key.
@Nullable String	getPrefix() Gets the holder's highest priority prefix, or null if the holder has no prefixes
@NonNull SortedMap<Integer,String>	getPrefixes() Gets an immutable sorted map of all of the prefixes the holder has, whereby the first value is the highest priority prefix.
@NonNull MetaStackDefinition	getPrefixStackDefinition() Gets the definition used for the prefix stack
@Nullable String	getPrimaryGroup() Gets the name of the holders primary group.
@Nullable String	getSuffix() Gets the holder's highest priority suffix, or null if the holder has no suffixes
@NonNull SortedMap<Integer,String>	getSuffixes() Gets an immutable sorted map of all of the suffixes the holder 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 net.luckperms.api.cacheddata.CachedData

getQueryOptions

Method Detail

getMetaValue

@Nullable String getMetaValue(String key)

Gets a value for the given meta key.

Parameters:

key - the key

Returns:

the value

getPrefix

@Nullable String getPrefix()

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

Returns:

a prefix string, or null

getSuffix

@Nullable String getSuffix()

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

Returns:

a suffix string, or null

getMeta

@NonNull Map<String,List<String>> getMeta()

Gets an immutable copy of the meta this holder has.

Returns:

an immutable map of meta

getPrefixes

@NonNull SortedMap<Integer,String> getPrefixes()

Gets an immutable sorted map of all of the prefixes the holder 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 holder has, whereby the first value is the highest priority suffix.

Returns:

a sorted map of suffixes

getPrimaryGroup

@Nullable String getPrimaryGroup()

Gets the name of the holders primary group.

Will return null for Group holder types.

Returns:

the name of the primary group

Since:

5.1

getPrefixStackDefinition

@NonNull MetaStackDefinition getPrefixStackDefinition()

Gets the definition used for the prefix stack

Returns:

the definition used for the prefix stack

getSuffixStackDefinition

@NonNull MetaStackDefinition getSuffixStackDefinition()

Gets the definition used for the suffix stack

Returns:

the definition used for the suffix stack