me.lucko.luckperms.api.metastacking

Interface MetaStackFactory

public interface MetaStackFactory

Factory to create meta stack elements and definitions.

Since:

3.2

Method Summary

Modifier and Type	Method and Description
MetaStackDefinition	createDefinition(List<MetaStackElement> elements, String startSpacer, String middleSpacer, String endSpacer) Creates a new MetaStackDefinition with the given properties.
Optional<MetaStackElement>	fromString(String definition) Parses a standard MetaStackElement from string, using the pre-defined elements in the plugin.
List<MetaStackElement>	fromStrings(List<String> definitions) Parses a list of MetaStackElements from string, using the pre-defined elements in the plugin.

Method Detail

fromString

@Nonnull
Optional<MetaStackElement> fromString(@Nonnull
                                                String definition)

Parses a standard MetaStackElement from string, using the pre-defined elements in the plugin.

Parameters:

definition - the definition

Returns:

the parsed element, if present

fromStrings

@Nonnull
List<MetaStackElement> fromStrings(@Nonnull
                                             List<String> definitions)

Parses a list of MetaStackElements from string, using the pre-defined elements in the plugin.

If an element cannot be parsed, it will not be included in the resultant list.

Parameters:

definitions - the definition strings

Returns:

a list of parsed elements

createDefinition

@Nonnull
MetaStackDefinition createDefinition(@Nonnull
                                               List<MetaStackElement> elements,
                                               @Nonnull
                                               String startSpacer,
                                               @Nonnull
                                               String middleSpacer,
                                               @Nonnull
                                               String endSpacer)

Creates a new MetaStackDefinition with the given properties.

Parameters:

elements - the elements to be included in the stack.

startSpacer - the spacer to be included at the start of the stacks output

middleSpacer - the spacer to be included between stack elements

endSpacer - the spacer to be included at the end of the stacks output

Returns:

the new stack definition instance