me.lucko.luckperms.api

Interface NodeFactory

public interface NodeFactory

Assists with constructing Node instances.

Since:

2.17

Method Summary

Modifier and Type	Method and Description
Node.Builder	makeChatMetaNode(@NonNull ChatMetaType type, int priority, @NonNull String value) Creates a node builder for the given chat meta type
Node.Builder	makeGroupNode(@NonNull Group group) Creates a node builder from a group
Node.Builder	makeGroupNode(@NonNull String groupName) Creates a node builder from a group
Node.Builder	makeMetaNode(@NonNull String key, @NonNull String value) Creates a node builder from a key value pair
Node.Builder	makePrefixNode(int priority, @NonNull String prefix) Creates a node builder from a prefix string and priority
Node.Builder	makeSuffixNode(int priority, @NonNull String suffix) Creates a node builder from a prefix string and priority
Node.Builder	newBuilder(@NonNull String permission) Creates a new node builder from a given base permission string
Node.Builder	newBuilderFromExisting(@NonNull Node other) Creates a node builder instance from an existing node

Method Detail

newBuilder

Node.Builder newBuilder(@NonNull String permission)

Creates a new node builder from a given base permission string

Parameters:

permission - the permission

Returns:

a node builder instance

Throws:

NullPointerException - if the permission is null

newBuilderFromExisting

Node.Builder newBuilderFromExisting(@NonNull Node other)

Creates a node builder instance from an existing node

Parameters:

other - the other node

Returns:

a node builder instance

Throws:

NullPointerException - if the other node is null

makeGroupNode

Node.Builder makeGroupNode(@NonNull Group group)

Creates a node builder from a group

Parameters:

group - the group

Returns:

a node builder instance

Throws:

NullPointerException - if the group is null

IllegalStateException - if the group instance was not obtained from LuckPerms.

Since:

3.1

makeGroupNode

Node.Builder makeGroupNode(@NonNull String groupName)

Creates a node builder from a group

Parameters:

groupName - the name of the group

Returns:

a node builder instance

Throws:

NullPointerException - if the groupName is null

Since:

4.0

makeMetaNode

Node.Builder makeMetaNode(@NonNull String key,
                          @NonNull String value)

Creates a node builder from a key value pair

Parameters:

key - the key

value - the value

Returns:

a node builder instance

Throws:

NullPointerException - if the key or value is null

makeChatMetaNode

Node.Builder makeChatMetaNode(@NonNull ChatMetaType type,
                              int priority,
                              @NonNull String value)

Creates a node builder for the given chat meta type

Parameters:

type - the type

priority - the priority

value - the value for the prefix/suffix

Returns:

a node builder instance

Throws:

NullPointerException - if the type or value is null

Since:

3.2

makePrefixNode

Node.Builder makePrefixNode(int priority,
                            @NonNull String prefix)

Creates a node builder from a prefix string and priority

Parameters:

priority - the priority

prefix - the prefix string

Returns:

a node builder instance

Throws:

NullPointerException - if the prefix is null

makeSuffixNode

Node.Builder makeSuffixNode(int priority,
                            @NonNull String suffix)

Creates a node builder from a prefix string and priority

Parameters:

priority - the priority

suffix - the suffix string

Returns:

a node builder instance

Throws:

NullPointerException - if the suffix is null