net.luckperms.api.node.types

Interface DisplayNameNode

All Superinterfaces:

Node, ScopedNode<DisplayNameNode,DisplayNameNode.Builder>

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

A sub-type of Node used to mark the display name of the node's holder.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static @NonNull DisplayNameNode.Builder	builder() Creates a DisplayNameNode builder.
static @NonNull DisplayNameNode.Builder	builder(@NonNull String displayName) Creates a DisplayNameNode builder.
@NonNull String	getDisplayName() Gets the display name.
default @NonNull NodeType<DisplayNameNode>	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<DisplayNameNode> getType()

Description copied from interface: Node

Gets the type of the node.

Specified by:

getType in interface Node

Specified by:

getType in interface ScopedNode<DisplayNameNode,DisplayNameNode.Builder>

Returns:

the node type

getDisplayName

@NonNull String getDisplayName()

Gets the display name.

Returns:

the display name

builder

static @NonNull DisplayNameNode.Builder builder()

Creates a DisplayNameNode builder.

Returns:

the builder

builder

static @NonNull DisplayNameNode.Builder builder(@NonNull String displayName)

Creates a DisplayNameNode builder.

Specified by:

builder in interface Node

Parameters:

displayName - the display name to set

Returns:

the builder