me.lucko.luckperms.api

Enum TemporaryMergeBehaviour

java.lang.Object

java.lang.Enum<TemporaryMergeBehaviour>

me.lucko.luckperms.api.TemporaryMergeBehaviour

All Implemented Interfaces:

Serializable, Comparable<TemporaryMergeBehaviour>

public enum TemporaryMergeBehaviour
extends Enum<TemporaryMergeBehaviour>

Controls how the implementation should behave when new temporary nodes are set that would otherwise conflict with existing entries.

The default behaviour of PermissionHolder.setPermission(Node) is to return a result of DataMutateResult.ALREADY_HAS when an equivalent node is found. This can be replicated using FAIL_WITH_ALREADY_HAS.

However, the PermissionHolder.setPermission(Node, TemporaryMergeBehaviour) method allows this behaviour to be customized for temporary permissions.

Since:

4.3

Enum Constant Summary

Enum Constants

Enum Constant and Description
ADD_NEW_DURATION_TO_EXISTING Expiry durations will be added to the existing expiry time of a permission.
FAIL_WITH_ALREADY_HAS The operation will fail if an existing temporary node is present.
REPLACE_EXISTING_IF_DURATION_LONGER Expiry durations will be replaced if the new duration is longer than the current one.

Method Summary

Modifier and Type	Method and Description
static TemporaryMergeBehaviour	valueOf(String name) Returns the enum constant of this type with the specified name.
static TemporaryMergeBehaviour[]	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

ADD_NEW_DURATION_TO_EXISTING

public static final TemporaryMergeBehaviour ADD_NEW_DURATION_TO_EXISTING

Expiry durations will be added to the existing expiry time of a permission.

REPLACE_EXISTING_IF_DURATION_LONGER

public static final TemporaryMergeBehaviour REPLACE_EXISTING_IF_DURATION_LONGER

Expiry durations will be replaced if the new duration is longer than the current one.

FAIL_WITH_ALREADY_HAS

public static final TemporaryMergeBehaviour FAIL_WITH_ALREADY_HAS

The operation will fail if an existing temporary node is present.

Method Detail

values

public static TemporaryMergeBehaviour[] 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 (TemporaryMergeBehaviour c : TemporaryMergeBehaviour.values())
    System.out.println(c);

Returns:

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

valueOf

public static TemporaryMergeBehaviour 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