me.lucko.luckperms.api.metastacking

Interface MetaStackDefinition

@Immutable
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.

Since:

2.3

Method Summary

Modifier and Type	Method and Description
List<MetaStackElement>	getElements() Gets an immutable list of the elements in this stack definition
String	getEndSpacer() Gets the spacer added after any stack elements
String	getMiddleSpacer() Gets the spacer added between stack elements
String	getStartSpacer() Gets the spacer string added before any stack elements

Method Detail

getElements

@Nonnull
List<MetaStackElement> getElements()

Gets an immutable list of the elements in this stack definition

Returns:

the elements in this stack

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