Package net.luckperms.api.node.matcher

Interface NodeMatcherFactory

@Internal
public interface NodeMatcherFactory

A factory which creates NodeMatchers.

Since:

5.1

Method Summary

Modifier and Type	Method	Description
<T extends Node> @NonNull NodeMatcher<T>	equals(@NonNull T other, @NonNull NodeEqualityPredicate equalityPredicate)	Gets a NodeMatcher which matches nodes which are equal to the given other node according to the NodeEqualityPredicate.
@NonNull NodeMatcher<Node>	key(@NonNull String key)	Gets a NodeMatcher which matches nodes with the same key.
<T extends Node> @NonNull NodeMatcher<T>	key(@NonNull T node)	Gets a NodeMatcher which matches nodes with the same key.
@NonNull NodeMatcher<Node>	keyStartsWith(@NonNull String startingWith)	Gets a NodeMatcher which matches nodes with a key starting with the given string.
@NonNull NodeMatcher<MetaNode>	metaKey(@NonNull String metaKey)	Gets a NodeMatcher which matches MetaNodes with the same meta key.
<T extends Node> @NonNull NodeMatcher<T>	type(NodeType<? extends T> type)	Gets a NodeMatcher which matches Nodes with the same type as the given NodeType.

Method Detail

key

@NonNull NodeMatcher<Node> key(@NonNull String key)

Gets a NodeMatcher which matches nodes with the same key.

The String.equalsIgnoreCase(String) method is used to test key equality.

Prefer using the NodeMatcher.key(String) accessor.

Parameters:

key - the key

Returns:

the matcher

key

<T extends Node> @NonNull NodeMatcher<T> key(@NonNull T node)

Gets a NodeMatcher which matches nodes with the same key.

The String.equalsIgnoreCase(String) method is used to test key equality.

Prefer using the NodeMatcher.key(Node) accessor.

Type Parameters:

T - the node type

Parameters:

node - the node to use for the key

Returns:

the matcher

keyStartsWith

@NonNull NodeMatcher<Node> keyStartsWith(@NonNull String startingWith)

Gets a NodeMatcher which matches nodes with a key starting with the given string.

Prefer using the NodeMatcher.keyStartsWith(String) accessor.

Parameters:

startingWith - the string to match

Returns:

the matcher

equals

<T extends Node> @NonNull NodeMatcher<T> equals(@NonNull T other,
                                                @NonNull NodeEqualityPredicate equalityPredicate)

Gets a NodeMatcher which matches nodes which are equal to the given other node according to the NodeEqualityPredicate.

Prefer using the NodeMatcher.equals(Node, NodeEqualityPredicate) accessor.

Type Parameters:

T - the node type

Parameters:

other - the other node to test against

equalityPredicate - the equality predicate

Returns:

the matcher

metaKey

@NonNull NodeMatcher<MetaNode> metaKey(@NonNull String metaKey)

Gets a NodeMatcher which matches MetaNodes with the same meta key.

The String.equalsIgnoreCase(String) method is used to test key equality.

Prefer using the NodeMatcher.metaKey(String) accessor.

Parameters:

metaKey - the meta key

Returns:

the matcher

type

<T extends Node> @NonNull NodeMatcher<T> type(NodeType<? extends T> type)

Gets a NodeMatcher which matches Nodes with the same type as the given NodeType.

NodeType.PERMISSION, NodeType.CHAT_META and NodeType.META_OR_CHAT_META are not supported by this method.

Prefer using the NodeMatcher.type(NodeType) accessor.

Type Parameters:

T - the node type

Parameters:

type - the node type

Returns:

the matcher