net.luckperms.api.node

Interface NodeEqualityPredicate

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface NodeEqualityPredicate

A rule for determining if two nodes are equal.

Generally, implementations of this interface should fulfil the same requirements as the Object.equals(Object) contract.

Field Summary

Fields

Modifier and Type	Field and Description
static NodeEqualityPredicate	EXACT Represents an exact match.
static NodeEqualityPredicate	IGNORE_EXPIRY_TIME All attributes must match, except for the expiry time, which is ignored.
static NodeEqualityPredicate	IGNORE_EXPIRY_TIME_AND_VALUE All attributes must match, except for value and the expiry time, which are ignored.
static NodeEqualityPredicate	IGNORE_VALUE All attributes must match, except for value, which is ignored.
static NodeEqualityPredicate	IGNORE_VALUE_OR_IF_TEMPORARY All attributes must match, except for value and the if the node is temporary, which are ignored.

Method Summary

Modifier and Type	Method and Description
boolean	areEqual(@NonNull Node o1, @NonNull Node o2) Returns if the two nodes are equal.
default Predicate<Node>	equalTo(Node node) Returns a Predicate, returning true if the tested node is equal to the one given, according to the NodeEqualityPredicate.

Field Detail

EXACT

static final NodeEqualityPredicate EXACT

Represents an exact match.

All attributes of the nodes must match for them to be considered equal.

IGNORE_VALUE

static final NodeEqualityPredicate IGNORE_VALUE

All attributes must match, except for value, which is ignored.

IGNORE_EXPIRY_TIME

static final NodeEqualityPredicate IGNORE_EXPIRY_TIME

All attributes must match, except for the expiry time, which is ignored.

Note that with this setting, whether a node is temporary or not is still considered.

IGNORE_EXPIRY_TIME_AND_VALUE

static final NodeEqualityPredicate IGNORE_EXPIRY_TIME_AND_VALUE

All attributes must match, except for value and the expiry time, which are ignored.

IGNORE_VALUE_OR_IF_TEMPORARY

static final NodeEqualityPredicate IGNORE_VALUE_OR_IF_TEMPORARY

All attributes must match, except for value and the if the node is temporary, which are ignored.

Method Detail

areEqual

boolean areEqual(@NonNull Node o1,
                 @NonNull Node o2)

Returns if the two nodes are equal.

This method should avoid making calls to Node.equals(Node, NodeEqualityPredicate) with this as the second argument, directly or otherwise.

Parameters:

o1 - the first node

o2 - the second node

Returns:

true if equal

equalTo

default Predicate<Node> equalTo(Node node)

Returns a Predicate, returning true if the tested node is equal to the one given, according to the NodeEqualityPredicate.

Parameters:

node - the given node

Returns:

a predicate