net.luckperms.api.node.types

Interface InheritanceNode

All Superinterfaces:

Node, ScopedNode<InheritanceNode,InheritanceNode.Builder>

public interface InheritanceNode
extends ScopedNode<InheritanceNode,InheritanceNode.Builder>

A sub-type of Node used to mark that the holder of the node should inherit from another group.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	InheritanceNode.Builder A InheritanceNode builder.

Method Summary

Modifier and Type	Method and Description
static @NonNull InheritanceNode.Builder	builder() Creates a InheritanceNode builder.
static @NonNull InheritanceNode.Builder	builder(@NonNull Group group) Sets the name of group to inherit.
static @NonNull InheritanceNode.Builder	builder(@NonNull String group) Creates a InheritanceNode builder.
@NonNull String	getGroupName() Gets the name of the group to be inherited.
default @NonNull NodeType<InheritanceNode>	getType() Gets the type of the node.

Methods inherited from interface net.luckperms.api.node.ScopedNode

toBuilder

Methods inherited from interface net.luckperms.api.node.Node

equals, equals, getContexts, getExpiry, getExpiryDuration, getKey, getMetadata, getValue, hasExpired, hasExpiry, isNegated, metadata, resolveShorthand

Method Detail

getType

default @NonNull NodeType<InheritanceNode> getType()

Description copied from interface: Node

Gets the type of the node.

Specified by:

getType in interface Node

Specified by:

getType in interface ScopedNode<InheritanceNode,InheritanceNode.Builder>

Returns:

the node type

getGroupName

@NonNull String getGroupName()

Gets the name of the group to be inherited.

This is no guarantee that this group exists.

Returns:

the name of the group

builder

static @NonNull InheritanceNode.Builder builder()

Creates a InheritanceNode builder.

Returns:

the builder

builder

static @NonNull InheritanceNode.Builder builder(@NonNull String group)

Creates a InheritanceNode builder.

Specified by:

builder in interface Node

Parameters:

group - the group to set

Returns:

the builder

builder

static @NonNull InheritanceNode.Builder builder(@NonNull Group group)

Sets the name of group to inherit.

Parameters:

group - the group name

Returns:

the builder