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 NodeType<ChatMetaNode<?,?>>	CHAT_META	Node type for ChatMetaNode.
static NodeType<DisplayNameNode>	DISPLAY_NAME	Node type for DisplayNameNode.
static NodeType<InheritanceNode>	INHERITANCE	Node type for InheritanceNode.
static NodeType<MetaNode>	META	Node type for MetaNode.
static NodeType<Node>	META_OR_CHAT_META	Node type for ChatMetaNode or MetaNode.
static NodeType<PermissionNode>	PERMISSION	Node type for PermissionNode.
static NodeType<PrefixNode>	PREFIX	Node type for PrefixNode.
static NodeType<RegexPermissionNode>	REGEX_PERMISSION	Node type for RegexPermissionNode.
static NodeType<SuffixNode>	SUFFIX	Node type for SuffixNode.
static NodeType<WeightNode>	WEIGHT	Node type for WeightNode.

Method Summary

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

Field Detail

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.

META_OR_CHAT_META

static final NodeType<Node> META_OR_CHAT_META

Node type for ChatMetaNode or MetaNode.

Method Detail

name

String name()

Gets a name for the node type.

Returns:

a name

matches

boolean matches(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

T cast(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 Optional<T> tryCast(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 Predicate<Node> predicate()

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

Returns:

a predicate for the matches(Node) method.

predicate

default Predicate<Node> predicate(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