NodeEqualityPredicate (LuckPerms API (v5.2))

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
```
An equality test for determining if two nodes are to be considered equal.
Recall that Nodes have 4 key attributes: key, value, context, expiry.

In the default Node.equals(Object) implementation (equivalent to EXACT), all 4 of these key attributes are considered. However, there are occasions where such strict equality checking is not desired, hence the use of this class.

NodeEqualityPredicates can either be used inline, by directly calling the areEqual(Node, Node) method, or can be passed as a parameter to the Node.equals(Node, NodeEqualityPredicate) method. Either approach is valid, and both will result in the same result.

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 `has an expiry`, which are ignored.
`static NodeEqualityPredicate`	`ONLY_KEY` Only the `key`s need match, all other attributes are ignored.

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
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.
    Returns true if: (and)
    - key = key
    - value = value
    - context = context
    - expiry = expiry
    All 4 attributes of the nodes must match to be considered equal.
    
    This is the default form of equality, used by Node.equals(Object).
  - ONLY_KEY
```
static final NodeEqualityPredicate ONLY_KEY
```
    Only the keys need match, all other attributes are ignored.
  - IGNORE_VALUE
```
static final NodeEqualityPredicate IGNORE_VALUE
```
    All attributes must match, except for value, which is ignored.
    Returns true if: (and)
    - key = key
    - context = context
    - expiry = expiry
  - 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 has an expiry or not is still considered.
    
    Returns true if: (and)
    - key = key
    - value = value
    - context = context
    - has expiry = has expiry
  - 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.
    Note that with this setting, whether a node has an expiry or not is still considered.
    
    Returns true if: (and)
    - key = key
    - context = context
    - has expiry = has expiry
  - 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 has an expiry, which are ignored.
    Effectively only considers the key and the context.
    
    Returns true if: (and)
    - key = key
    - context = context
- 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

Interface NodeEqualityPredicate

Field Summary

Method Summary

Field Detail

EXACT

ONLY_KEY

IGNORE_VALUE

IGNORE_EXPIRY_TIME

IGNORE_EXPIRY_TIME_AND_VALUE

IGNORE_VALUE_OR_IF_TEMPORARY

Method Detail

areEqual

equalTo