Package net.luckperms.api.node

Interface NodeType<T extends Node>

public interface NodeType<T extends Node>

Represents a type of Node.

Field Summary

Fields

Modifier and Type	Field	Description
static final NodeType<ChatMetaNode<?,?>>	CHAT_META	Node type for ChatMetaNode.
static final NodeType<DisplayNameNode>	DISPLAY_NAME	Node type for DisplayNameNode.
static final NodeType<InheritanceNode>	INHERITANCE	Node type for InheritanceNode.
static final NodeType<MetaNode>	META	Node type for MetaNode.
static final NodeType<Node>	META_OR_CHAT_META	Node type for ChatMetaNode or MetaNode.
static final NodeType<PermissionNode>	PERMISSION	Node type for PermissionNode.
static final NodeType<PrefixNode>	PREFIX	Node type for PrefixNode.
static final NodeType<RegexPermissionNode>	REGEX_PERMISSION	Node type for RegexPermissionNode.
static final NodeType<SuffixNode>	SUFFIX	Node type for SuffixNode.
static final NodeType<WeightNode>	WEIGHT	Node type for WeightNode.

Method Summary

Modifier and Type	Method	Description
@NonNull T	cast(@NonNull Node node)	Casts the given Node to the type defined by the NodeType.
boolean	matches(@NonNull Node node)	Returns if the passed node matches the type
@NonNull String	name()	Gets a name for the node type.
default @NonNull Predicate<Node>	predicate()	Returns a Predicate, returning whether a Node matches this type.
default @NonNull Predicate<Node>	predicate(@NonNull Predicate<? super T> and)	Returns a Predicate, returning whether a Node matches this type, and passes the given and Predicate.
default @NonNull Optional<T>	tryCast(@NonNull Node node)	Attempts to cast the given Node to the type defined by the NodeType.

Field Details

PERMISSION

static final NodeType<PermissionNode> PERMISSION

Node type for PermissionNode.

REGEX_PERMISSION

static final NodeType<RegexPermissionNode> REGEX_PERMISSION

Node type for RegexPermissionNode.

INHERITANCE

static final NodeType<InheritanceNode> INHERITANCE

Node type for InheritanceNode.

PREFIX

static final NodeType<PrefixNode> PREFIX

Node type for PrefixNode.

SUFFIX

static final NodeType<SuffixNode> SUFFIX

Node type for SuffixNode.

META

static final NodeType<MetaNode> META

Node type for MetaNode.

WEIGHT

static final NodeType<WeightNode> WEIGHT

Node type for WeightNode.

DISPLAY_NAME

static final NodeType<DisplayNameNode> DISPLAY_NAME

Node type for DisplayNameNode.

CHAT_META

static final NodeType<ChatMetaNode<?,?>> CHAT_META

Node type for ChatMetaNode.

This is an abstract type, and therefore will never be returned from Node.getType().

META_OR_CHAT_META

static final NodeType<Node> META_OR_CHAT_META

Node type for ChatMetaNode or MetaNode.

This is an abstract type, and therefore will never be returned from Node.getType().

Method Details

name

@NonNull String name()

Gets a name for the node type.

Returns:

a name

matches

boolean matches(@NonNull Node node)

Returns if the passed node matches the type

Parameters:

node - the node to test

Returns:

true if the node has the same type

cast

@NonNull T cast(@NonNull Node node)

Casts the given Node to the type defined by the NodeType.

An IllegalArgumentException is thrown if the node to cast does not match the type.

Parameters:

node - the node to cast

Returns:

the casted node

Throws:

IllegalArgumentException - if the node to cast does not match the type

tryCast

default @NonNull Optional<T> tryCast(@NonNull Node node)

Attempts to cast the given Node to the type defined by the NodeType.

Returns an empty optional if the node to cast does not match the type.

Parameters:

node - the node to cast

Returns:

an optional, possibly containing a casted node

predicate

default @NonNull Predicate<Node> predicate()

Returns a Predicate, returning whether a Node matches this type.

Returns:

a predicate for the matches(Node) method.

predicate

default @NonNull Predicate<Node> predicate(@NonNull Predicate<? super T> and)

Returns a Predicate, returning whether a Node matches this type, and passes the given and Predicate.

Parameters:

and - a predicate to AND with the result of the type match check

Returns:

a matching predicate, ANDed with the given predicate parameter