Package net.luckperms.api.metastacking

Interface MetaStackDefinition

public interface MetaStackDefinition

Represents a meta stack model, consisting of a chain of elements, separated by spacers.

The resultant string is constructed as: [start spacer] [element] [middle spacer] [element] [middle spacer] [element] [end spacer]

Definitions can be passed to a users UserData instance using MetaContexts, and the result of this stack can be retrieved from the returned MetaData instance.

Field Summary

Fields

Modifier and Type	Field	Description
static final OptionKey<MetaStackDefinition>	PREFIX_STACK_KEY	The OptionKey for the prefix MetaStackDefinition.
static final OptionKey<MetaStackDefinition>	SUFFIX_STACK_KEY	The OptionKey for the suffix MetaStackDefinition.

Method Summary

Modifier and Type	Method	Description
@NonNull DuplicateRemovalFunction	getDuplicateRemovalFunction()	Gets the duplicate removal function, applied to the entries before formatting takes place.
@NonNull @Unmodifiable List<MetaStackElement>	getElements()	Gets an immutable list of the elements in this stack definition
@NonNull String	getEndSpacer()	Gets the spacer added after any stack elements
@NonNull String	getMiddleSpacer()	Gets the spacer added between stack elements
@NonNull String	getStartSpacer()	Gets the spacer string added before any stack elements

Field Details

PREFIX_STACK_KEY

static final OptionKey<MetaStackDefinition> PREFIX_STACK_KEY

The OptionKey for the prefix MetaStackDefinition.

SUFFIX_STACK_KEY

static final OptionKey<MetaStackDefinition> SUFFIX_STACK_KEY

The OptionKey for the suffix MetaStackDefinition.

Method Details

getElements

@NonNull @Unmodifiable List<MetaStackElement> getElements()

Gets an immutable list of the elements in this stack definition

Returns:

the elements in this stack

getDuplicateRemovalFunction

@NonNull DuplicateRemovalFunction getDuplicateRemovalFunction()

Gets the duplicate removal function, applied to the entries before formatting takes place.

Returns:

the duplicate removal function

getStartSpacer

@NonNull String getStartSpacer()

Gets the spacer string added before any stack elements

Returns:

the start spacer

getMiddleSpacer

@NonNull String getMiddleSpacer()

Gets the spacer added between stack elements

Returns:

the middle spacer

getEndSpacer

@NonNull String getEndSpacer()

Gets the spacer added after any stack elements

Returns:

the end spacer