me.lucko.luckperms.api

Enum StandardNodeEquality

java.lang.Object

java.lang.Enum<StandardNodeEquality>

me.lucko.luckperms.api.StandardNodeEquality

All Implemented Interfaces:

Serializable, Comparable<StandardNodeEquality>, NodeEqualityPredicate

public enum StandardNodeEquality
extends Enum<StandardNodeEquality>
implements NodeEqualityPredicate

Standard NodeEqualityPredicates.

Since:

4.1

Enum Constant Summary

Enum Constants

Enum Constant and Description
EXACT Represents an exact match.
IGNORE_EXPIRY_TIME All attributes must match, except for the expiry time, which is ignored.
IGNORE_EXPIRY_TIME_AND_VALUE All attributes must match, except for value and the expiry time, which are ignored.
IGNORE_VALUE All attributes must match, except for value, which is ignored.
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
static StandardNodeEquality	valueOf(String name) Returns the enum constant of this type with the specified name.
static StandardNodeEquality[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

EXACT

public static final StandardNodeEquality EXACT

Represents an exact match.

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

IGNORE_VALUE

public static final StandardNodeEquality IGNORE_VALUE

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

IGNORE_EXPIRY_TIME

public static final StandardNodeEquality 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

public static final StandardNodeEquality IGNORE_EXPIRY_TIME_AND_VALUE

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

IGNORE_VALUE_OR_IF_TEMPORARY

public static final StandardNodeEquality IGNORE_VALUE_OR_IF_TEMPORARY

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

Method Detail

values

public static StandardNodeEquality[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (StandardNodeEquality c : StandardNodeEquality.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static StandardNodeEquality valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

areEqual

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

Description copied from interface: NodeEqualityPredicate

Returns if the two nodes are equal

Specified by:

areEqual in interface NodeEqualityPredicate

Parameters:

o1 - the first node

o2 - the second node

Returns:

true if equal