Implement luckiness calculator

3rd time lucky...

.github/FUNDING.yml

@@ -0,0 +1,2 @@
+github: lucko
+patreon: luckdev

.github/ISSUE_TEMPLATE/bug-report.md

@@ -0,0 +1,40 @@
+---
+name: 🐛 ​ Bug report
+about: Report an issue or problem with the way LuckPerms is functioning.
+title: ''
+labels: 'type: issue'
+assignees: ''
+
+---
+
+<!-- Before going any further, please check to see if your problem is fixed by updating to a newer version. The latest development builds can be obtained from https://luckperms.net/download -->
+
+### Description
+<!-- Please provide a short description of the issue in the space below. -->
+
+
+### Reproduction steps
+<!-- Please provide a clear list of steps we should follow in order to reproduce your issue in the space below. -->
+
+1. Open the config.yml file and set example to true.
+2. Restart the server
+3. Run /lp user example permission set x from the console
+4. See error
+
+
+### Expected behaviour
+<!-- Please provide a description of what you expected to happen. -->
+
+
+### Environment details
+<!-- Please provide details of your server environment in the space below. -->
+
+* Server type/version: `ExampleSpigot` running version `1.12.2` build `???`
+* LuckPerms version: `v???`
+
+<!-- If you think it would be helpful, please also include a "pastebin" of any relevant config files or log output. You should use https://gist.github.com/ to upload, then include the link below. -->
+
+
+### Any other relevant details
+<!-- Please include any other relevant details in the space below. -->
+

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,5 @@
+blank_issues_enabled: false
+contact_links:
+  - name: 💬 ​ Ask a question
+    url: https://discord.gg/luckperms
+    about: We use Discord to provide support for the project. If you have a question, need help, or aren't sure if you've found a bug or not, please come and talk to us there!

.github/ISSUE_TEMPLATE/suggestion.md

@@ -0,0 +1,16 @@
+---
+name: 💡 ​ Suggestion
+about: Suggest an idea for an improvement or change to LuckPerms.
+title: ''
+labels: 'type: suggestion'
+assignees: ''
+
+---
+
+### Description
+<!-- Please provide a short description of the suggestion in the space below. -->
+
+
+### Proposed behaviour
+<!-- Please provide a short explanation of how the feature should work / be changed, and how this will effect the project. -->
+

.gitignore

@@ -1,10 +1,12 @@
-### Intellij ###
-.idea/
-*.iws
-/out/
+### Gradle & IntelliJ ###
+.gradle/
+/.idea/
+build/
+out/
+run/
 *.iml
 .idea_modules/
-atlassian-ide-plugin.xml
+
 
 ### Eclipse ###
 .metadata
@@ -26,6 +28,7 @@ local.properties
 .project
 .classpath
 
+
 ### Linux ###
 *~
 .fuse_hidden*
@@ -33,6 +36,7 @@ local.properties
 .Trash-*
 .nfs*
 
+
 ### macOS ###
 .DS_Store
 .AppleDouble
@@ -52,6 +56,7 @@ Network Trash Folder
 Temporary Items
 .apdisk
 
+
 ### NetBeans ###
 nbproject/private/
 build/
@@ -60,6 +65,7 @@ dist/
 nbdist/
 .nb-gradle/
 
+
 ### Windows ###
 # Windows thumbnail cache files
 Thumbs.db
@@ -69,11 +75,3 @@ ehthumbs_vista.db
 [Dd]esktop.ini
 $RECYCLE.BIN/
 *.lnk
-
-### Gradle ###
-.gradle
-/build/
-/out/
-gradle-app.setting
-!gradle-wrapper.jar
-.gradletasknamecache

CONTRIBUTING.md

@@ -1,6 +1,6 @@
 ### :speech_balloon: Looking for support?
 
-Details about support for the project can be found [here, on the Wiki Homepage](https://github.com/lucko/LuckPerms/wiki#support).
+Details about support for the project can be found [here, on the Wiki Homepage](https://luckperms.net/wiki/Home#support).
 
 ### :bug: Reporting bugs?
 
@@ -16,11 +16,11 @@ If you make any changes or improvements to the plugin which you think would be b
 
 LuckPerms loosely follows the [Google Java Style Guide](https://google.github.io/styleguide/javaguide.html). Generally, try to copy the style of code found in the class you're editing. 
 
-If you're considering submitting a substantial pull request, please open an issue so we can discuss the change before starting work on the contribution. Most pull requests are happily accepted, but larger changes may have an inpact on the maintainability of the project, and require more consideration. 
+If you're considering submitting a substantial pull request, please open an issue so we can discuss the change before starting work on the contribution. Most pull requests are happily accepted, but larger changes may have an impact on the maintainability of the project, and require more consideration. 
 
 #### Project Layout
-The project is split up into a few seperate modules.
+The project is split up into a few separate modules.
 
 * **API** - The public, semantically versioned API used by other plugins wishing to integrate with and retrieve data from LuckPerms. This module (for the most part) does not contain any implementation itself, and is provided by the plugin.
 * **Common** - The common module contains most of the code which implements the respective LuckPerms plugins. This abstract module reduces duplicated code throughout the project.
-* **Bukkit, BungeeCord, Sponge, Nukkit & Velocity** - Each use the common module to implement plugins on the respective server platforms.
+* **Bukkit, BungeeCord, Sponge, Nukkit, Velocity & Fabric** - Each use the common module to implement plugins on the respective server platforms.

README.md

@@ -1,21 +1,24 @@
-![alt text](https://i.imgur.com/ToguFkQ.png "Banner")
+![](https://i.imgur.com/ToguFkQ.png "Banner")
 # LuckPerms
 [![Build Status](https://ci.lucko.me/job/LuckPerms/badge/icon)](https://ci.lucko.me/job/LuckPerms/)
-[![Javadocs](https://javadoc.io/badge/me.lucko.luckperms/luckperms-api.svg)](https://javadoc.io/doc/me.lucko.luckperms/luckperms-api)
-[![Maven Central](https://img.shields.io/maven-metadata/v/https/repo1.maven.org/maven2/me/lucko/luckperms/luckperms-api/maven-metadata.xml.svg?label=maven%20central&colorB=brightgreen)](https://search.maven.org/artifact/me.lucko.luckperms/luckperms-api)
-[![Discord](https://img.shields.io/discord/241667244927483904.svg?logo=discord&label=)](https://discord.gg/luckperms)
+[![javadoc](https://javadoc.io/badge2/net.luckperms/api/javadoc.svg)](https://javadoc.io/doc/net.luckperms/api)
+[![Maven Central](https://img.shields.io/maven-metadata/v/https/repo1.maven.org/maven2/net/luckperms/api/maven-metadata.xml.svg?label=maven%20central&colorB=brightgreen)](https://search.maven.org/artifact/net.luckperms/api)
+[![Discord](https://img.shields.io/discord/241667244927483904.svg?label=discord&logo=discord)](https://discord.gg/luckperms)
 
-LuckPerms is an advanced permissions implementation aiming to be a fast, reliable and flexible alternative to existing permission plugins. The project's main goals are centered around high performance and a wide feature set, filling the gaps of functionality and building upon existing features found in other plugins.
+LuckPerms is a permissions plugin for Minecraft servers. It allows server admins to control what features players can use by creating groups and assigning permissions.
 
-LuckPerms also includes an extensive API for developers, and support for a variety of Minecraft server software & data storage options.
+The latest downloads, wiki & other useful links can be found on the project homepage at [luckperms.net](https://luckperms.net/).
 
-Still not convinced? More information can be found on the wiki, under: [Why LuckPerms?](https://github.com/lucko/LuckPerms/wiki/Why-LuckPerms)
+It is:
 
-## Useful Links
+* **fast** - written with performance and scalability in mind.
+* **reliable** - trusted by thousands of server admins, and the largest of server networks.
+* **easy to use** - setup permissions using commands, directly in config files, or using the web editor.
+* **flexible** - supports a variety of data storage options, and works on lots of different server types.
+* **extensive** - a plethora of customization options and settings which can be changed to suit your server.
+* **free** - available for download and usage at no cost, and permissively licensed so it can remain free forever.
 
-The latest **downloads** can be found on the [project's homepage](https://luckperms.github.io/).
-
-More information about the project & how to use the plugin can be found in the [wiki](https://github.com/lucko/LuckPerms/wiki).
+For more information, see the wiki article on [Why LuckPerms?](https://luckperms.net/wiki/Why-LuckPerms)
 
 ## Building
 LuckPerms uses Gradle to handle dependencies & building.
@@ -31,7 +34,7 @@ cd LuckPerms/
 ./gradlew build
 ```
 
-You can find the output jars in the `build/libs` directories.
+You can find the output jars in the `loader/build/libs` or `build/libs` directories.
 
 ## Contributing
 #### Pull Requests
@@ -44,7 +47,7 @@ The project is split up into a few separate modules.
 
 * **API** - The public, semantically versioned API used by other plugins wishing to integrate with and retrieve data from LuckPerms. This module (for the most part) does not contain any implementation itself, and is provided by the plugin.
 * **Common** - The common module contains most of the code which implements the respective LuckPerms plugins. This abstract module reduces duplicated code throughout the project.
-* **Bukkit, BungeeCord, Sponge, Nukkit & Velocity** - Each use the common module to implement plugins on the respective server platforms.
+* **Bukkit, BungeeCord, Sponge, Fabric, Nukkit & Velocity** - Each use the common module to implement plugins on the respective server platforms.
 
 ## License
 LuckPerms is licensed under the permissive MIT license. Please see [`LICENSE.txt`](https://github.com/lucko/LuckPerms/blob/master/LICENSE.txt) for more info.

api/build.gradle

@@ -1,8 +1,9 @@
-project.version = '4.4'
+group = 'net.luckperms'
+project.version = '5.3'
 
 dependencies {
-    compileOnly 'com.google.guava:guava:19.0'
-    compileOnly 'org.checkerframework:checker-qual:2.5.5'
+    compileOnly 'org.checkerframework:checker-qual:3.8.0'
+    compileOnly 'org.jetbrains:annotations:20.1.0'
 }
 
 // Only used occasionally for deployment - not needed for normal builds.
@@ -11,11 +12,14 @@ if (project.hasProperty('sonatypeUsername') && project.hasProperty('sonatypePass
     apply plugin: 'signing'
 
     javadoc {
+        title = 'LuckPerms API (v' + project.ext.apiVersion + ')'
+        options.overview = 'javadoc/overview.html'
         options.encoding = 'UTF-8'
         options.charSet = 'UTF-8'
         options.links(
-                'https://google.github.io/guava/releases/21.0/api/docs/',
-                'https://docs.oracle.com/javase/8/docs/api/'
+                'https://docs.oracle.com/javase/8/docs/api/',
+                'https://checkerframework.org/api/',
+                'https://javadoc.io/static/org.jetbrains/annotations/20.1.0/'
         )
         options.addStringOption('Xdoclint:none', '-quiet')
     }
@@ -56,8 +60,8 @@ if (project.hasProperty('sonatypeUsername') && project.hasProperty('sonatypePass
                 pom {
                     project {
                         name 'LuckPerms API'
-                        description 'An advanced permissions plugin for Bukkit/Spigot, BungeeCord, Sponge, Nukkit and Velocity.'
-                        url 'https://luckperms.github.io'
+                        description 'A permissions plugin for Minecraft servers.'
+                        url 'https://luckperms.net'
 
                         licenses {
                             license {
@@ -68,9 +72,10 @@ if (project.hasProperty('sonatypeUsername') && project.hasProperty('sonatypePass
 
                         developers {
                             developer {
+                                id 'lucko'
                                 name 'Luck'
+                                url 'https://lucko.me'
                                 email 'git@lucko.me'
-                                url 'https://github.com/lucko'
                             }
                         }
 

api/javadoc/overview.html

@@ -0,0 +1,19 @@
+<body>
+<p>
+    LuckPerms is a permissions plugin for Minecraft servers. It allows server admins to control what
+    features players can use by creating groups and assigning permissions.
+</p>
+<h4>Useful Links</h4>
+<ul>
+    <li><a target="_top" href="https://luckperms.net">Project Website</a></li>
+    <li><a target="_top" href="https://luckperms.net/wiki/Developer-API">Wiki - API Introduction</a></li>
+    <li><a target="_top" href="https://luckperms.net/wiki/Developer-API-Usage">Wiki - API Usage</a></li>
+</ul>
+<h4>Maven</h4>
+<p>
+    The API artifact is deployed to Maven Central under
+    <a target="_top" href="https://search.maven.org/artifact/net.luckperms/api">
+        group id: <b><code>net.luckperms</code></b>, artifact id: <b><code>api</code></b>.
+    </a>
+</p>
+</body>

api/src/main/java/me/lucko/luckperms/LuckPerms.java

@@ -1,92 +0,0 @@
-/*
- * This file is part of LuckPerms, licensed under the MIT License.
- *
- *  Copyright (c) lucko (Luck) <luck@lucko.me>
- *  Copyright (c) contributors
- *
- *  Permission is hereby granted, free of charge, to any person obtaining a copy
- *  of this software and associated documentation files (the "Software"), to deal
- *  in the Software without restriction, including without limitation the rights
- *  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- *  copies of the Software, and to permit persons to whom the Software is
- *  furnished to do so, subject to the following conditions:
- *
- *  The above copyright notice and this permission notice shall be included in all
- *  copies or substantial portions of the Software.
- *
- *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- *  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- *  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- *  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- *  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- *  SOFTWARE.
- */
-
-package me.lucko.luckperms;
-
-import me.lucko.luckperms.api.LuckPermsApi;
-
-import org.checkerframework.checker.nullness.qual.NonNull;
-
-import java.util.Optional;
-
-/**
- * Provides static access to the {@link LuckPermsApi}.
- *
- * <p>Ideally, the ServiceManager for the platform should be used to obtain an instance,
- * however, this provider can be used if you need static access.</p>
- */
-public final class LuckPerms {
-    private static LuckPermsApi instance = null;
-
-    /**
-     * Gets an instance of the {@link LuckPermsApi},
-     * throwing {@link IllegalStateException} if an instance is not yet loaded.
-     *
-     * <p>Will never return null.</p>
-     *
-     * @return an api instance
-     * @throws IllegalStateException if the api is not loaded
-     */
-    public static @NonNull LuckPermsApi getApi() {
-        if (instance == null) {
-            throw new IllegalStateException("API is not loaded.");
-        }
-        return instance;
-    }
-
-    /**
-     * Gets an instance of {@link LuckPermsApi}, if it is loaded.
-     *
-     * <p>Unlike {@link LuckPerms#getApi}, this method will not throw an
-     * {@link IllegalStateException} if an instance is not yet loaded, rather return
-     * an empty {@link Optional}.
-     *
-     * @return an optional api instance
-     */
-    public static @NonNull Optional<LuckPermsApi> getApiSafe() {
-        return Optional.ofNullable(instance);
-    }
-
-    /**
-     * Registers an instance of the {@link LuckPermsApi} with this provider.
-     *
-     * @param instance the instance
-     */
-    static void registerProvider(LuckPermsApi instance) {
-        LuckPerms.instance = instance;
-    }
-
-    /**
-     * Removes the current instance from this provider.
-     */
-    static void unregisterProvider() {
-        LuckPerms.instance = null;
-    }
-
-    private LuckPerms() {
-        throw new UnsupportedOperationException("This class cannot be instantiated.");
-    }
-
-}

api/src/main/java/me/lucko/luckperms/api/ChatMetaType.java

@@ -1,126 +0,0 @@
-/*
- * This file is part of LuckPerms, licensed under the MIT License.
- *
- *  Copyright (c) lucko (Luck) <luck@lucko.me>
- *  Copyright (c) contributors
- *
- *  Permission is hereby granted, free of charge, to any person obtaining a copy
- *  of this software and associated documentation files (the "Software"), to deal
- *  in the Software without restriction, including without limitation the rights
- *  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- *  copies of the Software, and to permit persons to whom the Software is
- *  furnished to do so, subject to the following conditions:
- *
- *  The above copyright notice and this permission notice shall be included in all
- *  copies or substantial portions of the Software.
- *
- *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- *  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- *  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- *  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- *  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- *  SOFTWARE.
- */
-
-package me.lucko.luckperms.api;
-
-import org.checkerframework.checker.nullness.qual.NonNull;
-
-import java.util.Map;
-import java.util.Objects;
-import java.util.Optional;
-
-/**
- * Represents a type of chat meta
- *
- * @since 3.2
- */
-public enum ChatMetaType {
-
-    /**
-     * Represents a prefix
-     */
-    PREFIX("prefix") {
-        @Override
-        public boolean matches(@NonNull Node node) {
-            return Objects.requireNonNull(node, "node").isPrefix();
-        }
-
-        @Override
-        public Map.@NonNull Entry<Integer, String> getEntry(@NonNull Node node) {
-            return Objects.requireNonNull(node, "node").getPrefix();
-        }
-    },
-
-    /**
-     * Represents a suffix
-     */
-    SUFFIX("suffix") {
-        @Override
-        public boolean matches(@NonNull Node node) {
-            return Objects.requireNonNull(node, "node").isSuffix();
-        }
-
-        @Override
-        public Map.@NonNull Entry<Integer, String> getEntry(@NonNull Node node) {
-            return Objects.requireNonNull(node, "node").getSuffix();
-        }
-    };
-
-    private final String str;
-
-    ChatMetaType(String str) {
-        this.str = str;
-    }
-
-    /**
-     * Returns if the passed node matches the type
-     *
-     * @param node the node to test
-     * @return true if the node has the same type
-     */
-    public abstract boolean matches(@NonNull Node node);
-
-    /**
-     * Returns if the passed node should be ignored when searching for meta of this type
-     *
-     * @param node the node to test
-     * @return true if the node does not share the same type
-     */
-    public boolean shouldIgnore(@NonNull Node node) {
-        return !matches(node);
-    }
-
-    /**
-     * Maps the corresponding entry from the given node
-     *
-     * @param node the node to retrieve the entry from
-     * @return the entry
-     * @throws IllegalStateException if the node does not share the same type
-     */
-    public abstract Map.@NonNull Entry<Integer, String> getEntry(@NonNull Node node);
-
-    @Override
-    public String toString() {
-        return this.str;
-    }
-
-    /**
-     * Parses a ChatMetaType from the given node.
-     *
-     * @param node the node
-     * @return the parsed chat meta type
-     * @since 3.4
-     */
-    public static @NonNull Optional<ChatMetaType> ofNode(@NonNull Node node) {
-        if (node.isPrefix()) {
-            return Optional.of(PREFIX);
-        } else if (node.isSuffix()) {
-            return Optional.of(SUFFIX);
-        } else {
-            return Optional.empty();
-        }
-    }
-
-}

api/src/main/java/me/lucko/luckperms/api/Contexts.java

@@ -1,357 +0,0 @@
-/*
- * This file is part of LuckPerms, licensed under the MIT License.
- *
- *  Copyright (c) lucko (Luck) <luck@lucko.me>
- *  Copyright (c) contributors
- *
- *  Permission is hereby granted, free of charge, to any person obtaining a copy
- *  of this software and associated documentation files (the "Software"), to deal
- *  in the Software without restriction, including without limitation the rights
- *  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- *  copies of the Software, and to permit persons to whom the Software is
- *  furnished to do so, subject to the following conditions:
- *
- *  The above copyright notice and this permission notice shall be included in all
- *  copies or substantial portions of the Software.
- *
- *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- *  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- *  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- *  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- *  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- *  SOFTWARE.
- */
-
-package me.lucko.luckperms.api;
-
-import me.lucko.luckperms.api.context.ContextSet;
-import me.lucko.luckperms.api.context.ImmutableContextSet;
-
-import org.checkerframework.checker.nullness.qual.NonNull;
-
-import java.util.Objects;
-import java.util.Set;
-
-/**
- * Encapsulates the {@link ContextSet contexts} and {@link LookupSetting settings} for
- * a permission or meta lookup.
- *
- * <p>This class is immutable.</p>
- *
- * @since 2.11
- */
-public class Contexts {
-
-    /**
-     * The context key used to denote the subjects server
-     */
-    public static final String SERVER_KEY = "server";
-
-    /**
-     * The context key used to denote the subjects world
-     */
-    public static final String WORLD_KEY = "world";
-
-    /**
-     * The default {@link LookupSetting}s as a flag.
-     */
-    private static final byte DEFAULT_SETTINGS_FLAG = LookupSetting.createFlag(
-            LookupSetting.INCLUDE_NODES_SET_WITHOUT_SERVER,
-            LookupSetting.INCLUDE_NODES_SET_WITHOUT_WORLD,
-            LookupSetting.RESOLVE_INHERITANCE,
-            LookupSetting.APPLY_PARENTS_SET_WITHOUT_SERVER,
-            LookupSetting.APPLY_PARENTS_SET_WITHOUT_WORLD
-    );
-
-    /**
-     * A 'global' or default contexts instance.
-     *
-     * <p>Formed of an empty {@link ContextSet} and all inclusion and
-     * inheritance {@link LookupSetting}s applied.</p>
-     */
-    private static final Contexts GLOBAL = new Contexts(ImmutableContextSet.empty(), DEFAULT_SETTINGS_FLAG);
-
-    /**
-     * Gets the {@link FullySatisfiedContexts} instance.
-     *
-     * @return a context that will satisfy all contextual requirements.
-     */
-    public static @NonNull Contexts allowAll() {
-        return FullySatisfiedContexts.getInstance();
-    }
-
-    /**
-     * Returns a 'global' or default contexts instance.
-     *
-     * <p>Formed of an empty {@link ContextSet} and all inclusion and
-     * inheritance {@link LookupSetting}s applied.</p>
-     *
-     * @return the global contexts
-     * @since 3.3
-     */
-    public static @NonNull Contexts global() {
-        return GLOBAL;
-    }
-
-    /**
-     * Creates a new {@link Contexts} instance.
-     *
-     * @param contextSet the context set
-     * @param includeNodesSetWithoutServer the value of {@link LookupSetting#INCLUDE_NODES_SET_WITHOUT_SERVER}
-     * @param includeNodesSetWithoutWorld the value of {@link LookupSetting#INCLUDE_NODES_SET_WITHOUT_WORLD}
-     * @param resolveInheritance the value of {@link LookupSetting#RESOLVE_INHERITANCE}
-     * @param applyParentsWithoutServer the value of {@link LookupSetting#APPLY_PARENTS_SET_WITHOUT_SERVER}
-     * @param applyParentsWithoutWorld the value of {@link LookupSetting#APPLY_PARENTS_SET_WITHOUT_WORLD}
-     * @param isOp the value of {@link LookupSetting#IS_OP}
-     * @return a new instance
-     */
-    public static @NonNull Contexts of(@NonNull ContextSet contextSet, boolean includeNodesSetWithoutServer, boolean includeNodesSetWithoutWorld, boolean resolveInheritance, boolean applyParentsWithoutServer, boolean applyParentsWithoutWorld, boolean isOp) {
-        Objects.requireNonNull(contextSet, "contextSet");
-        byte settingsFlag = LookupSetting.createFlag(
-                includeNodesSetWithoutServer,
-                includeNodesSetWithoutWorld,
-                resolveInheritance,
-                applyParentsWithoutServer,
-                applyParentsWithoutWorld,
-                isOp
-        );
-        if (contextSet.isEmpty() && DEFAULT_SETTINGS_FLAG == settingsFlag) {
-            return GLOBAL;
-        }
-        return new Contexts(contextSet.makeImmutable(), settingsFlag);
-    }
-
-    /**
-     * Creates a new {@link Contexts} instance.
-     *
-     * @param contextSet the context set
-     * @param settings the settings
-     * @return a new instance
-     */
-    public static Contexts of(@NonNull ContextSet contextSet, @NonNull Set<LookupSetting> settings) {
-        Objects.requireNonNull(contextSet, "contextSet");
-        Objects.requireNonNull(settings, "settings");
-
-        byte settingsFlag = LookupSetting.createFlag(settings);
-        if (contextSet.isEmpty() && DEFAULT_SETTINGS_FLAG == settingsFlag) {
-            return GLOBAL;
-        }
-
-        return new Contexts(contextSet.makeImmutable(), settingsFlag);
-    }
-
-    /**
-     * The contexts that apply for this lookup
-     */
-    private final ImmutableContextSet contextSet;
-
-    /**
-     * The settings for this lookup
-     */
-    private final byte settingsFlag;
-
-    // cache hashcode - this class is immutable, and is used as an index in the permission cache.
-    private final int hashCode;
-
-    /**
-     * Creates a new {@link Contexts} instance.
-     *
-     * @param contextSet the context set
-     * @param includeNodesSetWithoutServer the value of {@link LookupSetting#INCLUDE_NODES_SET_WITHOUT_SERVER}
-     * @param includeNodesSetWithoutWorld the value of {@link LookupSetting#INCLUDE_NODES_SET_WITHOUT_WORLD}
-     * @param resolveInheritance the value of {@link LookupSetting#RESOLVE_INHERITANCE}
-     * @param applyParentsWithoutServer the value of {@link LookupSetting#APPLY_PARENTS_SET_WITHOUT_SERVER}
-     * @param applyParentsWithoutWorld the value of {@link LookupSetting#APPLY_PARENTS_SET_WITHOUT_WORLD}
-     * @param isOp the value of {@link LookupSetting#IS_OP}
-     * @deprecated in favour of {@link #of(ContextSet, boolean, boolean, boolean, boolean, boolean, boolean)}
-     */
-    @Deprecated
-    public Contexts(@NonNull ContextSet contextSet, boolean includeNodesSetWithoutServer, boolean includeNodesSetWithoutWorld, boolean resolveInheritance, boolean applyParentsWithoutServer, boolean applyParentsWithoutWorld, boolean isOp) {
-        this.contextSet = Objects.requireNonNull(contextSet, "contextSet").makeImmutable();
-        this.settingsFlag = LookupSetting.createFlag(
-                includeNodesSetWithoutServer,
-                includeNodesSetWithoutWorld,
-                resolveInheritance,
-                applyParentsWithoutServer,
-                applyParentsWithoutWorld,
-                isOp
-        );
-        this.hashCode = calculateHashCode();
-    }
-
-    protected Contexts(@NonNull ImmutableContextSet contextSet, byte settingsFlag) {
-        this.contextSet = contextSet;
-        this.settingsFlag = settingsFlag;
-        this.hashCode = calculateHashCode();
-    }
-
-    /**
-     * Gets the {@link ContextSet set of context pairs} for this {@link Contexts} instance.
-     *
-     * @return an immutable context from this instance
-     * @since 2.13
-     */
-    public @NonNull ContextSet getContexts() {
-        return this.contextSet;
-    }
-
-    /**
-     * Gets the set of {@link LookupSetting}s for this {@link Contexts} instance.
-     *
-     * @return the settings
-     * @since 4.2
-     */
-    public @NonNull Set<LookupSetting> getSettings() {
-        return LookupSetting.createSetFromFlag(this.settingsFlag);
-    }
-
-    /**
-     * Creates a copy of this {@link Contexts} instance, but with the
-     * {@link ContextSet set of context pairs} replaced by the given set.
-     *
-     * @param contextSet the context set
-     * @return a new contexts instance representing the new settings
-     * @since 4.4
-     */
-    public @NonNull Contexts setContexts(@NonNull ContextSet contextSet) {
-        ImmutableContextSet cs = Objects.requireNonNull(contextSet, "contextSet").makeImmutable();
-        if (this.contextSet.equals(cs)) {
-            return this;
-        }
-        return new Contexts(cs, this.settingsFlag);
-    }
-
-    /**
-     * Creates a copy of this {@link Contexts} instance, but with the
-     * {@link LookupSetting}s replaced by the given settings.
-     *
-     * @param settings the lookup settings
-     * @return a new contexts instance representing the new settings
-     * @since 4.4
-     */
-    public @NonNull Contexts setSettings(@NonNull Set<LookupSetting> settings) {
-        Objects.requireNonNull(settings, "settings");
-
-        byte settingsFlag = LookupSetting.createFlag(settings);
-        if (this.settingsFlag == settingsFlag) {
-            return this;
-        }
-        if (DEFAULT_SETTINGS_FLAG == settingsFlag && this.contextSet.isEmpty()) {
-            return GLOBAL;
-        }
-
-        return new Contexts(this.contextSet, settingsFlag);
-    }
-
-    /**
-     * Gets if the given {@link LookupSetting} is set.
-     *
-     * @param setting the setting
-     * @return the value
-     * @since 4.2
-     */
-    public boolean hasSetting(@NonNull LookupSetting setting) {
-        return LookupSetting.isSet(this.settingsFlag, setting);
-    }
-
-    /**
-     * Gets the value of {@link LookupSetting#IS_OP}.
-     *
-     * @return the value
-     * @see LookupSetting#IS_OP
-     * @deprecated in favour of {@link #hasSetting(LookupSetting)}
-     */
-    @Deprecated
-    public boolean isOp() {
-        return hasSetting(LookupSetting.IS_OP);
-    }
-
-    /**
-     * Gets the value of {@link LookupSetting#INCLUDE_NODES_SET_WITHOUT_SERVER}.
-     *
-     * @return the value
-     * @see LookupSetting#INCLUDE_NODES_SET_WITHOUT_SERVER
-     * @deprecated in favour of {@link #hasSetting(LookupSetting)}
-     */
-    @Deprecated
-    public boolean isIncludeGlobal() {
-        return hasSetting(LookupSetting.INCLUDE_NODES_SET_WITHOUT_SERVER);
-    }
-
-    /**
-     * Gets the value of {@link LookupSetting#INCLUDE_NODES_SET_WITHOUT_WORLD}.
-     *
-     * @return the value
-     * @see LookupSetting#INCLUDE_NODES_SET_WITHOUT_WORLD
-     * @deprecated in favour of {@link #hasSetting(LookupSetting)}
-     */
-    @Deprecated
-    public boolean isIncludeGlobalWorld() {
-        return hasSetting(LookupSetting.INCLUDE_NODES_SET_WITHOUT_WORLD);
-    }
-
-    /**
-     * Gets the value of {@link LookupSetting#RESOLVE_INHERITANCE}.
-     *
-     * @return the value
-     * @see LookupSetting#RESOLVE_INHERITANCE
-     * @deprecated in favour of {@link #hasSetting(LookupSetting)}
-     */
-    @Deprecated
-    public boolean isApplyGroups() {
-        return hasSetting(LookupSetting.RESOLVE_INHERITANCE);
-    }
-
-    /**
-     * Gets the value of {@link LookupSetting#APPLY_PARENTS_SET_WITHOUT_SERVER}.
-     *
-     * @return the value
-     * @see LookupSetting#APPLY_PARENTS_SET_WITHOUT_SERVER
-     * @deprecated in favour of {@link #hasSetting(LookupSetting)}
-     */
-    @Deprecated
-    public boolean isApplyGlobalGroups() {
-        return hasSetting(LookupSetting.APPLY_PARENTS_SET_WITHOUT_SERVER);
-    }
-
-    /**
-     * Gets the value of {@link LookupSetting#APPLY_PARENTS_SET_WITHOUT_WORLD}.
-     *
-     * @return the value
-     * @see LookupSetting#APPLY_PARENTS_SET_WITHOUT_WORLD
-     * @deprecated in favour of {@link #hasSetting(LookupSetting)}
-     */
-    @Deprecated
-    public boolean isApplyGlobalWorldGroups() {
-        return hasSetting(LookupSetting.APPLY_PARENTS_SET_WITHOUT_WORLD);
-    }
-
-    @Override
-    public @NonNull String toString() {
-        return "Contexts(contextSet=" + this.contextSet + ", settings=" + LookupSetting.createSetFromFlag(this.settingsFlag) + ")";
-    }
-
-    @Override
-    public boolean equals(Object o) {
-        if (o == this) return true;
-        if (o == allowAll()) return false;
-        if (!(o instanceof Contexts)) return false;
-        final Contexts that = (Contexts) o;
-        return this.contextSet.equals(that.contextSet) && this.settingsFlag == that.settingsFlag;
-    }
-
-    private int calculateHashCode() {
-        final int PRIME = 59;
-        int result = 1;
-        result = result * PRIME + this.contextSet.hashCode();
-        result = result * PRIME + this.settingsFlag;
-        return result;
-    }
-
-    @Override
-    public int hashCode() {
-        return this.hashCode;
-    }
-
-}

api/src/main/java/me/lucko/luckperms/api/FullySatisfiedContexts.java

@@ -1,79 +0,0 @@
-/*
- * This file is part of LuckPerms, licensed under the MIT License.
- *
- *  Copyright (c) lucko (Luck) <luck@lucko.me>
- *  Copyright (c) contributors
- *
- *  Permission is hereby granted, free of charge, to any person obtaining a copy
- *  of this software and associated documentation files (the "Software"), to deal
- *  in the Software without restriction, including without limitation the rights
- *  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- *  copies of the Software, and to permit persons to whom the Software is
- *  furnished to do so, subject to the following conditions:
- *
- *  The above copyright notice and this permission notice shall be included in all
- *  copies or substantial portions of the Software.
- *
- *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- *  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- *  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- *  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- *  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- *  SOFTWARE.
- */
-
-package me.lucko.luckperms.api;
-
-import me.lucko.luckperms.api.caching.CachedData;
-import me.lucko.luckperms.api.caching.MetaContexts;
-import me.lucko.luckperms.api.context.ImmutableContextSet;
-
-import org.checkerframework.checker.nullness.qual.NonNull;
-
-/**
- * A special instance of {@link Contexts}, which when passed to:
- *
- * <p></p>
- * <ul>
- *     <li>{@link CachedData#getPermissionData(Contexts)}</li>
- *     <li>{@link CachedData#getMetaData(Contexts)}</li>
- *     <li>{@link CachedData#getMetaData(MetaContexts)}</li>
- * </ul>
- *
- * <p>... will always satisfy all contextual requirements.</p>
- *
- * <p>This effectively allows you to do lookups which ignore context.</p>
- *
- * @since 3.3
- */
-public final class FullySatisfiedContexts extends Contexts {
-
-    // singleton
-    private static final FullySatisfiedContexts INSTANCE = new FullySatisfiedContexts();
-
-    public static @NonNull Contexts getInstance() {
-        return INSTANCE;
-    }
-
-    private FullySatisfiedContexts() {
-        super(ImmutableContextSet.empty(), LookupSetting.createFlag(Contexts.global().getSettings()));
-    }
-
-    @Override
-    public @NonNull String toString() {
-        return "FullySatisfiedContexts()";
-    }
-
-    @Override
-    public boolean equals(Object o) {
-        // this class is a singleton, so we can use object comparison to check equality.
-        return o == this;
-    }
-
-    @Override
-    public int hashCode() {
-        // just use the system hashcode - we need to override the hashcode impl in super
-        return System.identityHashCode(this);
-    }
-}

api/src/main/java/me/lucko/luckperms/api/LPConfiguration.java

@@ -1,117 +0,0 @@
-/*
- * This file is part of LuckPerms, licensed under the MIT License.
- *
- *  Copyright (c) lucko (Luck) <luck@lucko.me>
- *  Copyright (c) contributors
- *
- *  Permission is hereby granted, free of charge, to any person obtaining a copy
- *  of this software and associated documentation files (the "Software"), to deal
- *  in the Software without restriction, including without limitation the rights
- *  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- *  copies of the Software, and to permit persons to whom the Software is
- *  furnished to do so, subject to the following conditions:
- *
- *  The above copyright notice and this permission notice shall be included in all
- *  copies or substantial portions of the Software.
- *
- *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- *  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- *  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- *  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- *  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- *  SOFTWARE.
- */
-
-package me.lucko.luckperms.api;
-
-import org.checkerframework.checker.nullness.qual.NonNull;
-
-import java.util.Map;
-
-/**
- * Wrapper around parts of the LuckPerms configuration file
- */
-public interface LPConfiguration {
-
-    /**
-     * Gets the name of this server
-     *
-     * @return the name of this server
-     */
-    @NonNull String getServer();
-
-    /**
-     * Gets if the users on this server will have their global permissions applied
-     *
-     * @return if the users on this server will have their global permissions applied
-     */
-    boolean getIncludeGlobalPerms();
-
-    /**
-     * Gets if the users on this server will have their global world permissions applied
-     *
-     * @return if the users on this server will have their global world permissions applied
-     * @since 2.9
-     */
-    boolean getIncludeGlobalWorldPerms();
-
-    /**
-     * Gets if the platform is applying global groups
-     *
-     * @return true if the platform is applying global groups
-     * @since 2.9
-     */
-    boolean getApplyGlobalGroups();
-
-    /**
-     * Gets if the platform is applying global world groups
-     *
-     * @return true if the platform is applying global world groups
-     * @since 2.9
-     */
-    boolean getApplyGlobalWorldGroups();
-
-    /**
-     * Gets the storage method string from the configuration
-     *
-     * @return the storage method string from the configuration
-     */
-    @NonNull String getStorageMethod();
-
-    /**
-     * Gets true if split storage is enabled
-     *
-     * @return true if split storage is enabled
-     * @since 2.7
-     */
-    boolean getSplitStorage();
-
-    /**
-     * Gets a map of split storage options
-     *
-     * @return a map of split storage options, where the key is the storage section, and the value is the storage
-     * method. For example: key = user, value = json
-     * @since 2.7
-     */
-    @NonNull Map<String, String> getSplitStorageOptions();
-
-    @NonNull Unsafe unsafe();
-
-    interface Unsafe {
-
-        /**
-         * Gets an Object from the config.
-         *
-         * <p>This method is nested under {@link Unsafe} because the keys
-         * and return types may change between versions without warning.</p>
-         *
-         * @param key the key, as defined as a field name in
-         *            the "ConfigKeys" class.
-         * @return the corresponding object, if one is present
-         * @throws IllegalArgumentException if the key isn't known
-         */
-        @NonNull Object getObject(String key);
-    }
-
-}

api/src/main/java/me/lucko/luckperms/api/LogEntry.java

@@ -1,238 +0,0 @@
-/*
- * This file is part of LuckPerms, licensed under the MIT License.
- *
- *  Copyright (c) lucko (Luck) <luck@lucko.me>
- *  Copyright (c) contributors
- *
- *  Permission is hereby granted, free of charge, to any person obtaining a copy
- *  of this software and associated documentation files (the "Software"), to deal
- *  in the Software without restriction, including without limitation the rights
- *  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- *  copies of the Software, and to permit persons to whom the Software is
- *  furnished to do so, subject to the following conditions:
- *
- *  The above copyright notice and this permission notice shall be included in all
- *  copies or substantial portions of the Software.
- *
- *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- *  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- *  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- *  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- *  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- *  SOFTWARE.
- */
-
-package me.lucko.luckperms.api;
-
-import org.checkerframework.checker.nullness.qual.NonNull;
-import org.checkerframework.checker.nullness.qual.Nullable;
-
-import java.util.Optional;
-import java.util.UUID;
-
-/**
- * Represents a logged action.
- *
- * @see ActionLogger#newEntryBuilder() for creating an instance
- */
-public interface LogEntry extends Comparable<LogEntry> {
-
-    /**
-     * Gets the time in unix seconds when the action occurred.
-     *
-     * @return the timestamp
-     */
-    long getTimestamp();
-
-    /**
-     * Gets the id of the object which performed the action.
-     *
-     * <p>This is the players uuid in most cases.</p>
-     *
-     * @return the actor id
-     */
-    @NonNull UUID getActor();
-
-    /**
-     * Gets the name describing the actor.
-     *
-     * @return the name of the actor
-     */
-    @NonNull String getActorName();
-
-    /**
-     * Gets the type of action.
-     *
-     * @return the action type
-     */
-    @NonNull Type getType();
-
-    /**
-     * Gets the uuid of the object which was acted upon.
-     *
-     * <p>Will only return a value for {@link Type#USER} entries.</p>
-     *
-     * @return the uuid of acted object
-     */
-    @NonNull Optional<UUID> getActed();
-
-    /**
-     * Gets the name describing the object which was acted upon
-     *
-     * @return the name of the acted object
-     */
-    @NonNull String getActedName();
-
-    /**
-     * Returns a string describing the action which took place.
-     *
-     * <p>In most instances, this returns a variation of the command string which caused
-     * the change.</p>
-     *
-     * @return the action
-     */
-    @NonNull String getAction();
-
-    /**
-     * Represents the type of a {@link LogEntry}.
-     *
-     * @since 3.3
-     */
-    enum Type {
-        USER('U'), GROUP('G'), TRACK('T');
-
-        /**
-         * Parses a {@link Type} from a string.
-         *
-         * @param type the string
-         * @return a type
-         * @throws IllegalArgumentException if a type could not be parsed
-         * @since 4.4
-         */
-        public static @NonNull Type parse(String type) {
-            try {
-                return valueOf(type);
-            } catch (IllegalArgumentException e) {
-                // ignore
-            }
-            try {
-                return valueOf(type.charAt(0));
-            } catch (IllegalArgumentException e) {
-                // ignore
-            }
-            throw new IllegalArgumentException("Unknown type: " + type);
-        }
-
-        /**
-         * Returns a {@link Type} by its code.
-         *
-         * @param code the code - see {@link Type#getCode()}.
-         * @return a type
-         * @throws IllegalArgumentException if a type could not be resolved
-         */
-        public static @NonNull Type valueOf(char code) {
-            switch (code) {
-                case 'U':
-                case 'u':
-                    return USER;
-                case 'G':
-                case 'g':
-                    return GROUP;
-                case 'T':
-                case 't':
-                    return TRACK;
-                default:
-                    throw new IllegalArgumentException("Unknown code: " + code);
-            }
-        }
-
-        private final char code;
-
-        Type(char code) {
-            this.code = code;
-        }
-
-        public char getCode() {
-            return this.code;
-        }
-    }
-
-    /**
-     * Builds a LogEntry instance
-     */
-    interface Builder {
-
-        /**
-         * Sets the timestamp of the entry.
-         *
-         * @param timestamp the timestamp
-         * @return the builder
-         * @see LogEntry#getTimestamp()
-         */
-        @NonNull Builder setTimestamp(long timestamp);
-
-        /**
-         * Sets the actor of the entry.
-         *
-         * @param actor the actor
-         * @return the builder
-         * @see LogEntry#getActor()
-         */
-        @NonNull Builder setActor(@NonNull UUID actor);
-
-        /**
-         * Sets the actor name of the entry.
-         *
-         * @param actorName the actor name
-         * @return the builder
-         * @see LogEntry#getActorName()
-         */
-        @NonNull Builder setActorName(@NonNull String actorName);
-
-        /**
-         * Sets the type of the entry.
-         *
-         * @param type the type
-         * @return the builder
-         * @see LogEntry#getType()
-         */
-        @NonNull Builder setType(@NonNull Type type);
-
-        /**
-         * Sets the acted object for the entry.
-         *
-         * @param acted the acted object
-         * @return the builder
-         * @see LogEntry#getActed()
-         */
-        @NonNull Builder setActed(@Nullable UUID acted);
-
-        /**
-         * Sets the acted name for the entry.
-         *
-         * @param actedName the acted name
-         * @return the builder
-         * @see LogEntry#getActedName()
-         */
-        @NonNull Builder setActedName(@NonNull String actedName);
-
-        /**
-         * Sets the action of the entry.
-         *
-         * @param action the action
-         * @return the builder
-         * @see LogEntry#getAction()
-         */
-        @NonNull Builder setAction(@NonNull String action);
-
-        /**
-         * Creates a {@link LogEntry} instance from the builder.
-         *
-         * @return a new log entry instance
-         */
-        @NonNull LogEntry build();
-
-    }
-
-}

api/src/main/java/me/lucko/luckperms/api/LookupSetting.java

@@ -1,124 +0,0 @@
-/*
- * This file is part of LuckPerms, licensed under the MIT License.
- *
- *  Copyright (c) lucko (Luck) <luck@lucko.me>
- *  Copyright (c) contributors
- *
- *  Permission is hereby granted, free of charge, to any person obtaining a copy
- *  of this software and associated documentation files (the "Software"), to deal
- *  in the Software without restriction, including without limitation the rights
- *  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- *  copies of the Software, and to permit persons to whom the Software is
- *  furnished to do so, subject to the following conditions:
- *
- *  The above copyright notice and this permission notice shall be included in all
- *  copies or substantial portions of the Software.
- *
- *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- *  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- *  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- *  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- *  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- *  SOFTWARE.
- */
-
-package me.lucko.luckperms.api;
-
-import java.util.EnumSet;
-import java.util.Set;
-
-/**
- * The various lookup setting flags for {@link Contexts}.
- *
- * @since 4.2
- */
-public enum LookupSetting {
-
-    /**
-     * If the target subject is OP
-     */
-    IS_OP,
-
-    /**
-     * If global or non-server-specific nodes should be applied
-     */
-    INCLUDE_NODES_SET_WITHOUT_SERVER,
-
-    /**
-     * If global or non-world-specific nodes should be applied
-     */
-    INCLUDE_NODES_SET_WITHOUT_WORLD,
-
-    /**
-     * If parent groups should be resolved
-     */
-    RESOLVE_INHERITANCE,
-
-    /**
-     * If global or non-server-specific group memberships should be applied
-     */
-    APPLY_PARENTS_SET_WITHOUT_SERVER,
-
-    /**
-     * If global or non-world-specific group memberships should be applied
-     */
-    APPLY_PARENTS_SET_WITHOUT_WORLD;
-
-
-
-    /* bitwise utility methods */
-
-    static boolean isSet(byte b, LookupSetting setting) {
-        return ((b >> setting.ordinal()) & 1) == 1;
-    }
-
-    static byte createFlag(LookupSetting... settings) {
-        byte b = 0;
-        for (LookupSetting setting : settings) {
-            b |= (1 << setting.ordinal());
-        }
-        return b;
-    }
-
-    static byte createFlag(Set<LookupSetting> settings) {
-        byte b = 0;
-        for (LookupSetting setting : settings) {
-            b |= (1 << setting.ordinal());
-        }
-        return b;
-    }
-
-    static Set<LookupSetting> createSetFromFlag(byte b) {
-        EnumSet<LookupSetting> settings = EnumSet.noneOf(LookupSetting.class);
-        for (LookupSetting setting : LookupSetting.values()) {
-            if (((b >> setting.ordinal()) & 1) == 1) {
-                settings.add(setting);
-            }
-        }
-        return settings;
-    }
-
-    static byte createFlag(boolean includeNodesSetWithoutServer, boolean includeNodesSetWithoutWorld, boolean resolveInheritance, boolean applyParentsWithoutServer, boolean applyParentsWithoutWorld, boolean isOp) {
-        byte b = 0;
-        if (includeNodesSetWithoutServer) {
-            b |= (1 << LookupSetting.INCLUDE_NODES_SET_WITHOUT_SERVER.ordinal());
-        }
-        if (includeNodesSetWithoutWorld) {
-            b |= (1 << LookupSetting.INCLUDE_NODES_SET_WITHOUT_WORLD.ordinal());
-        }
-        if (resolveInheritance) {
-            b |= (1 << LookupSetting.RESOLVE_INHERITANCE.ordinal());
-        }
-        if (applyParentsWithoutServer) {
-            b |= (1 << LookupSetting.APPLY_PARENTS_SET_WITHOUT_SERVER.ordinal());
-        }
-        if (applyParentsWithoutWorld) {
-            b |= (1 << LookupSetting.APPLY_PARENTS_SET_WITHOUT_WORLD.ordinal());
-        }
-        if (isOp) {
-            b |= (1 << LookupSetting.IS_OP.ordinal());
-        }
-        return b;
-    }
-}

api/src/main/java/me/lucko/luckperms/api/LuckPermsApi.java

@@ -1,486 +0,0 @@
-/*
- * This file is part of LuckPerms, licensed under the MIT License.
- *
- *  Copyright (c) lucko (Luck) <luck@lucko.me>
- *  Copyright (c) contributors
- *
- *  Permission is hereby granted, free of charge, to any person obtaining a copy
- *  of this software and associated documentation files (the "Software"), to deal
- *  in the Software without restriction, including without limitation the rights
- *  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- *  copies of the Software, and to permit persons to whom the Software is
- *  furnished to do so, subject to the following conditions:
- *
- *  The above copyright notice and this permission notice shall be included in all
- *  copies or substantial portions of the Software.
- *
- *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- *  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- *  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- *  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- *  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- *  SOFTWARE.
- */
-
-package me.lucko.luckperms.api;
-
-import me.lucko.luckperms.LuckPerms;
-import me.lucko.luckperms.api.context.ContextCalculator;
-import me.lucko.luckperms.api.context.ContextManager;
-import me.lucko.luckperms.api.context.ContextSet;
-import me.lucko.luckperms.api.event.EventBus;
-import me.lucko.luckperms.api.manager.GroupManager;
-import me.lucko.luckperms.api.manager.TrackManager;
-import me.lucko.luckperms.api.manager.UserManager;
-import me.lucko.luckperms.api.messenger.MessengerProvider;
-import me.lucko.luckperms.api.metastacking.MetaStackFactory;
-import me.lucko.luckperms.api.platform.PlatformInfo;
-
-import org.checkerframework.checker.nullness.qual.NonNull;
-import org.checkerframework.checker.nullness.qual.Nullable;
-
-import java.util.Collection;
-import java.util.Optional;
-import java.util.Set;
-import java.util.UUID;
-import java.util.concurrent.CompletableFuture;
-
-/**
- * The LuckPerms API.
- *
- * <p>This interface is the base of the entire API package. All API functions
- * are accessed via this interface.</p>
- *
- * <p>An instance can be obtained via {@link LuckPerms#getApi()}, or the platforms
- * Services Manager.</p>
- */
-public interface LuckPermsApi {
-
-    /**
-     * Gets information about the platform LuckPerms is running on.
-     *
-     * @return the platform info
-     * @since 4.0
-     */
-    @NonNull PlatformInfo getPlatformInfo();
-
-    /**
-     * Gets the {@link UserManager}, responsible for managing
-     * {@link User} instances.
-     *
-     * <p>This manager can be used to retrieve instances of {@link User} by uuid
-     * or name, or query all loaded users.</p>
-     *
-     * <p>The {@link #getStorage() storage} instance should be used to
-     * load/create/save users.</p>
-     *
-     * @return the user manager
-     * @since 4.0
-     */
-    @NonNull UserManager getUserManager();
-
-    /**
-     * Gets the {@link GroupManager}, responsible for managing
-     * {@link Group} instances.
-     *
-     * <p>This manager can be used to retrieve instances of {@link Group} by
-     * name, or query all loaded groups.</p>
-     *
-     * <p>The {@link #getStorage() storage} instance should be used to
-     * load/create/save/delete groups.</p>
-     *
-     * @return the group manager
-     * @since 4.0
-     */
-    @NonNull GroupManager getGroupManager();
-
-    /**
-     * Gets the {@link TrackManager}, responsible for managing
-     * {@link Track} instances.
-     *
-     * <p>This manager can be used to retrieve instances of {@link Track} by
-     * name, or query all loaded tracks.</p>
-     *
-     * <p>The {@link #getStorage() storage} instance should be used to
-     * load/create/save/delete tracks.</p>
-     *
-     * @return the track manager
-     * @since 4.0
-     */
-    @NonNull TrackManager getTrackManager();
-
-    /**
-     * Schedules the execution of an update task, and returns an encapsulation
-     * of the task as a {@link CompletableFuture}.
-     *
-     * <p>The exact actions performed in an update task remains an
-     * implementation detail of the plugin, however, as a minimum, it is
-     * expected to perform a full reload of user, group and track data, and
-     * ensure that any changes are fully applied and propagated.</p>
-     *
-     * @return a future
-     * @since 4.0
-     */
-    @NonNull CompletableFuture<Void> runUpdateTask();
-
-    /**
-     * Gets the {@link EventBus}, used for subscribing to internal LuckPerms
-     * events.
-     *
-     * @return the event bus
-     * @since 3.0
-     */
-    @NonNull EventBus getEventBus();
-
-    /**
-     * Gets a representation of the plugins configuration
-     *
-     * @return the configuration
-     */
-    @NonNull LPConfiguration getConfiguration();
-
-    /**
-     * Gets an object representing the plugins primary {@link Storage} backend.
-     *
-     * <p>The instance propagates calls to the internal DAO (Data Access Object),
-     * and applies any changes to the storage provider.</p>
-     *
-     * @return a storage instance
-     * @since 2.14
-     */
-    @NonNull Storage getStorage();
-
-    /**
-     * Gets the {@link MessagingService}, if present.
-     *
-     * <p>The MessagingService is used to dispatch updates throughout a network
-     * of servers running the plugin.</p>
-     *
-     * <p>Not all instances of LuckPerms will have a messaging service setup and
-     * configured, but it is recommended that all users of the API account for
-     * and make use of this.</p>
-     *
-     * @return the messaging service instance, if present.
-     */
-    @NonNull Optional<MessagingService> getMessagingService();
-
-    /**
-     * Registers a {@link MessengerProvider} for use by the platform.
-     *
-     * <p>Note that the mere action of registering a provider doesn't
-     * necessarily mean that it will be used.</p>
-     *
-     * @param messengerProvider the messenger provider.
-     * @since 4.1
-     */
-    void registerMessengerProvider(@NonNull MessengerProvider messengerProvider);
-
-    /**
-     * Gets the {@link ActionLogger}.
-     *
-     * <p>The action logger is responsible for saving and broadcasting defined
-     * actions occurring on the platform.</p>
-     *
-     * @return the action logger
-     * @since 4.1
-     */
-    @NonNull ActionLogger getActionLogger();
-
-    /**
-     * Gets a {@link UuidCache}.
-     *
-     * <p>The uuid cache provides read access to the internal LuckPerms uuid
-     * mapping system.</p>
-     *
-     * @return the uuid cache
-     * @deprecated this feature is now handled internally - and the API returns a
-     * No-op implementation of this class.
-     */
-    @Deprecated
-    @NonNull UuidCache getUuidCache();
-
-    /**
-     * Gets the {@link ContextManager}.
-     *
-     * <p>The context manager manages {@link ContextCalculator}s, and calculates
-     * applicable contexts for a given type.</p>
-     *
-     * @return the context manager
-     * @since 4.0
-     */
-    @NonNull ContextManager getContextManager();
-
-    /**
-     * Gets a {@link Collection} of all known permission strings.
-     *
-     * @return a collection of the known permissions
-     * @since 4.4
-     */
-    @NonNull Collection<String> getKnownPermissions();
-
-    /**
-     * Gets the {@link NodeFactory}.
-     *
-     * <p>The node factory provides methods for building {@link Node} instances.</p>
-     *
-     * @return the node factory
-     */
-    @NonNull NodeFactory getNodeFactory();
-
-    /**
-     * Gets the {@link MetaStackFactory}.
-     *
-     * <p>The metastack factory provides methods for retrieving
-     * {@link me.lucko.luckperms.api.metastacking.MetaStackElement}s and constructing
-     * {@link me.lucko.luckperms.api.metastacking.MetaStackDefinition}s.</p>
-     *
-     * @return the meta stack factory
-     * @since 3.2
-     */
-    @NonNull MetaStackFactory getMetaStackFactory();
-
-
-
-
-    /*
-     * The following methods are provided only for convenience, and offer no
-     * additional functionality.
-     *
-     * They are implemented as "default" methods, using the manager and factory
-     * instances provided by the methods above.
-     */
-
-
-
-    /**
-     * Gets a wrapped user object from the user storage
-     *
-     * @param uuid the uuid of the user to get
-     * @return a {@link User} object, if one matching the uuid is loaded, or null if not
-     * @throws NullPointerException if the uuid is null
-     */
-    default @Nullable User getUser(@NonNull UUID uuid) {
-        return getUserManager().getUser(uuid);
-    }
-
-    /**
-     * Gets a wrapped user object from the user storage.
-     *
-     * @param uuid the uuid of the user to get
-     * @return an optional {@link User} object
-     * @throws NullPointerException if the uuid is null
-     */
-    default @NonNull Optional<User> getUserSafe(@NonNull UUID uuid) {
-        return getUserManager().getUserOpt(uuid);
-    }
-
-    /**
-     * Gets a wrapped user object from the user storage
-     *
-     * @param name the username of the user to get
-     * @return a {@link User} object, if one matching the uuid is loaded, or null if not
-     * @throws NullPointerException if the name is null
-     */
-    default @Nullable User getUser(@NonNull String name) {
-        return getUserManager().getUser(name);
-    }
-
-    /**
-     * Gets a wrapped user object from the user storage.
-     *
-     * @param name the username of the user to get
-     * @return an optional {@link User} object
-     * @throws NullPointerException if the name is null
-     */
-    default @NonNull Optional<User> getUserSafe(@NonNull String name) {
-        return getUserManager().getUserOpt(name);
-    }
-
-    /**
-     * Gets a set of all loaded users.
-     *
-     * @return a {@link Set} of {@link User} objects
-     */
-    default @NonNull Set<User> getUsers() {
-        return getUserManager().getLoadedUsers();
-    }
-
-    /**
-     * Check if a user is loaded in memory
-     *
-     * @param uuid the uuid to check for
-     * @return true if the user is loaded
-     * @throws NullPointerException if the uuid is null
-     */
-    default boolean isUserLoaded(@NonNull UUID uuid) {
-        return getUserManager().isLoaded(uuid);
-    }
-
-    /**
-     * Unload a user from the internal storage, if they're not currently online.
-     *
-     * @param user the user to unload
-     * @throws NullPointerException if the user is null
-     */
-    default void cleanupUser(@NonNull User user) {
-        getUserManager().cleanupUser(user);
-    }
-
-    /**
-     * Gets a wrapped group object from the group storage
-     *
-     * @param name the name of the group to get
-     * @return a {@link Group} object, if one matching the name exists, or null if not
-     * @throws NullPointerException if the name is null
-     */
-    default @Nullable Group getGroup(@NonNull String name) {
-        return getGroupManager().getGroup(name);
-    }
-
-    /**
-     * Gets a wrapped group object from the group storage.
-     *
-     * <p>This method does not return null, unlike {@link #getGroup}</p>
-     *
-     * @param name the name of the group to get
-     * @return an optional {@link Group} object
-     * @throws NullPointerException if the name is null
-     */
-    default @NonNull Optional<Group> getGroupSafe(@NonNull String name) {
-        return getGroupManager().getGroupOpt(name);
-    }
-
-    /**
-     * Gets a set of all loaded groups.
-     *
-     * @return a {@link Set} of {@link Group} objects
-     */
-    default @NonNull Set<Group> getGroups() {
-        return getGroupManager().getLoadedGroups();
-    }
-
-    /**
-     * Check if a group is loaded in memory
-     *
-     * @param name the name to check for
-     * @return true if the group is loaded
-     * @throws NullPointerException if the name is null
-     */
-    default boolean isGroupLoaded(@NonNull String name) {
-        return getGroupManager().isLoaded(name);
-    }
-
-    /**
-     * Gets a wrapped track object from the track storage
-     *
-     * @param name the name of the track to get
-     * @return a {@link Track} object, if one matching the name exists, or null
-     * if not
-     * @throws NullPointerException if the name is null
-     */
-    default @Nullable Track getTrack(@NonNull String name) {
-        return getTrackManager().getTrack(name);
-    }
-
-    /**
-     * Gets a wrapped track object from the track storage.
-     *
-     * <p>This method does not return null, unlike {@link #getTrack}</p>
-     *
-     * @param name the name of the track to get
-     * @return an optional {@link Track} object
-     * @throws NullPointerException if the name is null
-     */
-    default @NonNull Optional<Track> getTrackSafe(@NonNull String name) {
-        return getTrackManager().getTrackOpt(name);
-    }
-
-    /**
-     * Gets a set of all loaded tracks.
-     *
-     * @return a {@link Set} of {@link Track} objects
-     */
-    default @NonNull Set<Track> getTracks() {
-        return getTrackManager().getLoadedTracks();
-    }
-
-    /**
-     * Check if a track is loaded in memory
-     *
-     * @param name the name to check for
-     * @return true if the track is loaded
-     * @throws NullPointerException if the name is null
-     */
-    default boolean isTrackLoaded(@NonNull String name) {
-        return getTrackManager().isLoaded(name);
-    }
-
-    /**
-     * Returns a new LogEntry Builder instance
-     *
-     * @return a new builder
-     * @since 4.0
-     */
-    default LogEntry.@NonNull Builder newLogEntryBuilder() {
-        return getActionLogger().newEntryBuilder();
-    }
-
-    /**
-     * Returns a permission builder instance
-     *
-     * @param permission the main permission node to build
-     * @return a {@link Node.Builder} instance
-     * @throws IllegalArgumentException if the permission is invalid
-     * @throws NullPointerException     if the permission is null
-     * @since 2.6
-     */
-    default Node.@NonNull Builder buildNode(@NonNull String permission) throws IllegalArgumentException {
-        return getNodeFactory().newBuilder(permission);
-    }
-
-    /**
-     * Register a custom context calculator to the server
-     *
-     * @param calculator the context calculator to register. The type MUST be the player class of the platform.
-     * @throws ClassCastException if the type is not the player class of the platform.
-     */
-    default void registerContextCalculator(@NonNull ContextCalculator<?> calculator) {
-        getContextManager().registerCalculator(calculator);
-    }
-
-    /**
-     * Gets a calculated context instance for the user using the rules of the platform.
-     *
-     * <p> These values are calculated using the options in the configuration, and the provided calculators.
-     *
-     * @param user the user to get contexts for
-     * @return an optional containing contexts. Will return empty if the user is not online.
-     */
-    default @NonNull Optional<Contexts> getContextForUser(@NonNull User user) {
-        return getContextManager().lookupApplicableContexts(user);
-    }
-
-    /**
-     * Gets set of contexts applicable to a player using the platforms {@link ContextCalculator}s.
-     *
-     * @param player the player to calculate for. Must be the player instance for the platform.
-     * @return a set of contexts.
-     * @since 2.17
-     */
-    default @NonNull ContextSet getContextForPlayer(@NonNull Object player) {
-        return getContextManager().getApplicableContext(player);
-    }
-
-    /**
-     * Gets a Contexts instance for the player using the platforms {@link ContextCalculator}s.
-     *
-     * @param player the player to calculate for. Must be the player instance for the platform.
-     * @return a set of contexts.
-     * @since 3.3
-     */
-    default @NonNull Contexts getContextsForPlayer(@NonNull Object player) {
-        return getContextManager().getApplicableContexts(player);
-    }
-
-}

api/src/main/java/me/lucko/luckperms/api/Node.java

@@ -1,670 +0,0 @@
-/*
- * This file is part of LuckPerms, licensed under the MIT License.
- *
- *  Copyright (c) lucko (Luck) <luck@lucko.me>
- *  Copyright (c) contributors
- *
- *  Permission is hereby granted, free of charge, to any person obtaining a copy
- *  of this software and associated documentation files (the "Software"), to deal
- *  in the Software without restriction, including without limitation the rights
- *  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- *  copies of the Software, and to permit persons to whom the Software is
- *  furnished to do so, subject to the following conditions:
- *
- *  The above copyright notice and this permission notice shall be included in all
- *  copies or substantial portions of the Software.
- *
- *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- *  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- *  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- *  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- *  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- *  SOFTWARE.
- */
-
-package me.lucko.luckperms.api;
-
-import com.google.common.base.Preconditions;
-
-import me.lucko.luckperms.api.context.ContextSet;
-import me.lucko.luckperms.api.nodetype.NodeType;
-import me.lucko.luckperms.api.nodetype.NodeTypeKey;
-import me.lucko.luckperms.api.nodetype.types.DisplayNameType;
-import me.lucko.luckperms.api.nodetype.types.InheritanceType;
-import me.lucko.luckperms.api.nodetype.types.MetaType;
-import me.lucko.luckperms.api.nodetype.types.PrefixType;
-import me.lucko.luckperms.api.nodetype.types.SuffixType;
-import me.lucko.luckperms.api.nodetype.types.WeightType;
-
-import org.checkerframework.checker.nullness.qual.NonNull;
-import org.checkerframework.checker.nullness.qual.Nullable;
-
-import java.util.Date;
-import java.util.List;
-import java.util.Map;
-import java.util.Objects;
-import java.util.Optional;
-import java.util.Set;
-import java.util.concurrent.TimeUnit;
-import java.util.stream.Stream;
-
-/**
- * Represents a LuckPerms "node".
- *
- * <p>The {@link Node} class encapsulates more than just permission assignments.
- * Nodes are used to store data about inherited groups, as well as assigned
- * prefixes, suffixes and meta values.</p>
- *
- * <p>Combining these various states into one object (a "node") means that a
- * holder only has to have one type of data set (a set of nodes) in order to
- * take on various properties.</p>
- *
- * <p>It is recommended that users of the API make use of {@link Stream}s
- * to manipulate data and obtain the required information.</p>
- *
- * <p>This interface provides a number of methods to read the attributes of the
- * node, as well as methods to query and extract additional state and properties
- * from these settings.</p>
- *
- * <p>Nodes have the following attributes:</p>
- * <p></p>
- * <ul>
- * <li>{@link #getPermission() permission} - the actual permission string</li>
- * <li>{@link #getValue() value} - the value of the node (false for negated)</li>
- * <li>{@link #isOverride() override} - if the node is marked as having special priority over other nodes</li>
- * <li>{@link #getServer() server} - the specific server where this node should apply</li>
- * <li>{@link #getWorld() world} - the specific world where this node should apply</li>
- * <li>{@link #getContexts() context} - the additional contexts required for this node to apply </li>
- * <li>{@link #getExpiry() expiry} - the time when this node should expire</li>
- * </ul>
- *
- * <p>The 'permission' property of a {@link Node} is also used in some cases to represent state
- * beyond a granted permission. This state is encapsulated by extra {@link NodeType} data which
- * can be obtained from this instance using {@link #getTypeData(NodeTypeKey)}.</p>
- *
- * <p>Type data is mapped by {@link NodeTypeKey}s, which are usually stored as static members of the
- * corresponding {@link NodeType} class under the <code>KEY</code> field.</p>
- *
- * <p>The current types are:</p>
- * <p></p>
- * <ul>
- * <li>normal - just a regular permission</li>
- * <li>{@link InheritanceType} - an "inheritance node" marks that the holder should inherit data from another group</li>
- * <li>{@link PrefixType} - represents an assigned prefix</li>
- * <li>{@link SuffixType} - represents an assigned suffix</li>
- * <li>{@link MetaType} - represents an assigned meta option</li>
- * <li>{@link WeightType} - marks the weight of the object holding this node</li>
- * <li>{@link DisplayNameType} - marks the display name of the object holding this node</li>
- * </ul>
- *
- * <p>The core node state must be immutable in all implementations.</p>
- *
- * @see NodeFactory for obtaining and constructing instances.
- * @since 2.6
- */
-public interface Node {
-
-    /**
-     * Gets the permission string this node encapsulates.
-     *
-     * <p>The exact value of this string may vary for nodes which aren't regular
-     * permission settings.</p>
-     *
-     * @return the actual permission node
-     */
-    @NonNull String getPermission();
-
-    /**
-     * Gets the value of the node.
-     *
-     * <p>A negated setting would result in a value of <code>false</code>.</p>
-     *
-     * @return the nodes value
-     */
-    boolean getValue();
-
-    /**
-     * Gets the value of this node as a {@link Tristate}.
-     *
-     * @return the value of this node as a Tristate
-     */
-    default @NonNull Tristate getTristate() {
-        return Tristate.fromBoolean(getValue());
-    }
-
-    /**
-     * Gets if the node is negated.
-     *
-     * <p>This is the inverse of the {@link #getValue() value}.</p>
-     *
-     * @return true if the node is negated
-     */
-    default boolean isNegated() {
-        return !getValue();
-    }
-
-    /**
-     * Gets if this node is set to override explicitly.
-     *
-     * <p>This value does not persist across saves, and is therefore only
-     * useful for transient nodes.</p>
-     *
-     * @return true if this node is set to override explicitly
-     */
-    boolean isOverride();
-
-    /**
-     * Gets the server this node applies on, if the node is server specific.
-     *
-     * @return an {@link Optional} containing the server, if one is defined
-     */
-    @NonNull Optional<String> getServer();
-
-    /**
-     * Gets the world this node applies on, if the node is world specific.
-     *
-     * @return an {@link Optional} containing the world, if one is defined
-     */
-    @NonNull Optional<String> getWorld();
-
-    /**
-     * Gets if this node is server specific.
-     *
-     * @return true if this node is server specific
-     */
-    boolean isServerSpecific();
-
-    /**
-     * Gets if this node is server specific.
-     *
-     * @return true if this node is server specific
-     */
-    boolean isWorldSpecific();
-
-    /**
-     * Gets if this node applies globally, and therefore has no specific context.
-     *
-     * @return true if this node applies globally, and has no specific context
-     * @since 3.1
-     */
-    boolean appliesGlobally();
-
-    /**
-     * Gets if this node has any specific context in order for it to apply.
-     *
-     * @return true if this node has specific context
-     * @since 3.1
-     */
-    boolean hasSpecificContext();
-
-    /**
-     * Gets if this node should apply in the given context
-     *
-     * @param contextSet the context set
-     * @return true if the node should apply
-     * @since 2.13
-     */
-    boolean shouldApplyWithContext(@NonNull ContextSet contextSet);
-
-    /**
-     * Resolves any shorthand parts of this node and returns the full list of
-     * resolved nodes.
-     *
-     * <p>The list will not contain the exact permission itself.</p>
-     *
-     * @return a list of full nodes
-     */
-    @NonNull List<String> resolveShorthand();
-
-    /**
-     * Gets if this node is assigned temporarily.
-     *
-     * @return true if this node will expire in the future
-     */
-    boolean isTemporary();
-
-    /**
-     * Gets if this node is permanent (will not expire).
-     *
-     * @return true if this node will not expire
-     */
-    default boolean isPermanent() {
-        return !isTemporary();
-    }
-
-    /**
-     * Gets the unix timestamp (in seconds) when this node will expire.
-     *
-     * @return the time in Unix time when this node will expire
-     * @throws IllegalStateException if the node is not temporary
-     */
-    long getExpiryUnixTime() throws IllegalStateException;
-
-    /**
-     * Gets the date when this node will expire.
-     *
-     * @return the {@link Date} when this node will expire
-     * @throws IllegalStateException if the node is not temporary
-     */
-    @NonNull Date getExpiry() throws IllegalStateException;
-
-    /**
-     * Gets the number of seconds until this permission will expire.
-     *
-     * <p>Will return a negative value if the node has already expired.</p>
-     *
-     * @return the number of seconds until this permission will expire
-     * @throws IllegalStateException if the node is not temporary
-     */
-    long getSecondsTilExpiry() throws IllegalStateException;
-
-    /**
-     * Gets if the node has expired.
-     *
-     * <p>This returns false if the node is not temporary.</p>
-     *
-     * @return true if this node has expired
-     */
-    boolean hasExpired();
-
-    /**
-     * Gets the extra contexts required for this node to apply.
-     *
-     * @return the extra contexts required for this node to apply
-     * @since 2.13
-     */
-    @NonNull ContextSet getContexts();
-
-    /**
-     * The same as {@link #getContexts()}, but also includes context pairs for
-     * "server" and "world" keys if present.
-     *
-     * @return the full contexts required for this node to apply
-     * @see Contexts#SERVER_KEY
-     * @see Contexts#WORLD_KEY
-     * @since 3.1
-     */
-    @NonNull ContextSet getFullContexts();
-
-    /**
-     * Gets if this node is a wildcard permission.
-     *
-     * @return true if this node is a wildcard permission
-     */
-    boolean isWildcard();
-
-    /**
-     * Gets the level of this wildcard.
-     *
-     * <p>The node <code>luckperms.*</code> has a wildcard level of 1.</p>
-     * <p>The node <code>luckperms.user.permission.*</code> has a wildcard level of 3.</p>
-     *
-     * <p>Nodes with a higher wildcard level are more specific and have priority over
-     * less specific nodes (nodes with a lower wildcard level).</p>
-     *
-     * @return the wildcard level
-     * @throws IllegalStateException if this is not a wildcard
-     */
-    int getWildcardLevel() throws IllegalStateException;
-
-    /**
-     * Gets if this node has any extra {@link NodeType} data attached to it.
-     *
-     * @return if this node has any type data
-     * @since 4.2
-     */
-    boolean hasTypeData();
-
-    /**
-     * Gets the type data corresponding to the given <code>key</code>, if present.
-     *
-     * @param key the key
-     * @param <T> the {@link NodeType} type
-     * @return the data, if present
-     * @since 4.2
-     */
-    <T extends NodeType> Optional<T> getTypeData(NodeTypeKey<T> key);
-
-    /**
-     * Gets the type data corresponding to the given <code>key</code>, throwing an exception
-     * if no data is present.
-     *
-     * @param key the key
-     * @param <T> the {@link NodeType} type
-     * @return the data
-     * @throws IllegalStateException if data isn't present
-     * @since 4.2
-     */
-    default <T extends NodeType> T typeData(NodeTypeKey<T> key) throws IllegalStateException {
-        return getTypeData(key).orElseThrow(() -> new IllegalStateException("Node '" + getPermission() + "' does not have the '" + key.getTypeName() + "' type."));
-    }
-
-    /**
-     * Gets if this node has {@link InheritanceType} type data.
-     *
-     * @return true if this is a inheritance (group) node.
-     */
-    default boolean isGroupNode() {
-        return getTypeData(InheritanceType.KEY).isPresent();
-    }
-
-    /**
-     * Gets the name of the inherited group if this node has {@link InheritanceType} type data,
-     * throwing an exception if the data is not present.
-     *
-     * @return the name of the group
-     * @throws IllegalStateException if this node doesn't have {@link InheritanceType} data
-     */
-    default @NonNull String getGroupName() throws IllegalStateException {
-        return typeData(InheritanceType.KEY).getGroupName();
-    }
-
-    /**
-     * Gets if this node has {@link MetaType} type data.
-     *
-     * @return true if this is a meta node.
-     */
-    default boolean isMeta() {
-        return getTypeData(MetaType.KEY).isPresent();
-    }
-
-    /**
-     * Gets the meta entry if this node has {@link MetaType} type data,
-     * throwing an exception if the data is not present.
-     *
-     * @return the meta entry
-     * @throws IllegalStateException if this node doesn't have {@link MetaType} data
-     */
-    default Map.@NonNull Entry<String, String> getMeta() throws IllegalStateException {
-        return typeData(MetaType.KEY);
-    }
-
-    /**
-     * Gets if this node has {@link PrefixType} type data.
-     *
-     * @return true if this node is a prefix node
-     */
-    default boolean isPrefix() {
-        return getTypeData(PrefixType.KEY).isPresent();
-    }
-
-    /**
-     * Gets the prefix entry if this node has {@link PrefixType} type data,
-     * throwing an exception if the data is not present.
-     *
-     * @return the meta entry
-     * @throws IllegalStateException if this node doesn't have {@link PrefixType} data
-     */
-    default Map.@NonNull Entry<Integer, String> getPrefix() throws IllegalStateException {
-        return typeData(PrefixType.KEY).getAsEntry();
-    }
-
-    /**
-     * Gets if this node has {@link SuffixType} type data.
-     *
-     * @return true if this node is a suffix node
-     */
-    default boolean isSuffix() {
-        return getTypeData(SuffixType.KEY).isPresent();
-    }
-
-    /**
-     * Gets the suffix entry if this node has {@link SuffixType} type data,
-     * throwing an exception if the data is not present.
-     *
-     * @return the meta entry
-     * @throws IllegalStateException if this node doesn't have {@link SuffixType} data
-     */
-    default Map.@NonNull Entry<Integer, String> getSuffix() throws IllegalStateException {
-        return typeData(SuffixType.KEY).getAsEntry();
-    }
-
-    /**
-     * Gets if this Node is equal to another node.
-     *
-     * @param obj the other node
-     * @return true if this node is equal to the other provided
-     * @see StandardNodeEquality#EXACT
-     */
-    @Override
-    boolean equals(Object obj);
-
-    /**
-     * Gets if this Node is equal to another node as defined by the given
-     * {@link NodeEqualityPredicate}.
-     *
-     * @param other             the other node
-     * @param equalityPredicate the predicate
-     * @return true if this node is considered equal
-     * @since 4.1
-     */
-    boolean equals(Node other, NodeEqualityPredicate equalityPredicate);
-
-    /**
-     * Similar to {@link Node#equals(Object)}, except doesn't take note of the
-     * value.
-     *
-     * @param other the other node
-     * @return true if the two nodes are almost equal
-     * @see StandardNodeEquality#IGNORE_VALUE
-     * @deprecated in favour of {@link #equals(Node, NodeEqualityPredicate)}
-     */
-    @Deprecated
-    default boolean equalsIgnoringValue(@NonNull Node other) {
-        return equals(other, StandardNodeEquality.IGNORE_VALUE);
-    }
-
-    /**
-     * Similar to {@link Node#equals(Object)}, except doesn't take note of the
-     * expiry time or value.
-     *
-     * @param other the other node
-     * @return true if the two nodes are almost equal
-     * @see StandardNodeEquality#IGNORE_EXPIRY_TIME_AND_VALUE
-     * @deprecated in favour of {@link #equals(Node, NodeEqualityPredicate)}
-     */
-    @Deprecated
-    default boolean almostEquals(@NonNull Node other) {
-        return equals(other, StandardNodeEquality.IGNORE_EXPIRY_TIME_AND_VALUE);
-    }
-
-    /**
-     * Similar to {@link Node#equals(Object)}, except doesn't take note of the
-     * value or if the node is temporary.
-     *
-     * @param other the other node
-     * @return true if the two nodes are almost equal
-     * @see StandardNodeEquality#IGNORE_VALUE_OR_IF_TEMPORARY
-     * @since 2.8
-     * @deprecated in favour of {@link #equals(Node, NodeEqualityPredicate)}
-     */
-    @Deprecated
-    default boolean equalsIgnoringValueOrTemp(@NonNull Node other) {
-        return equals(other, StandardNodeEquality.IGNORE_VALUE_OR_IF_TEMPORARY);
-    }
-
-    /**
-     * Constructs a new builder initially containing the current properties of
-     * this node.
-     *
-     * @return a new builder
-     * @since 4.1
-     */
-    Builder toBuilder();
-
-    /**
-     * Builds a Node instance
-     */
-    interface Builder {
-
-        /**
-         * Copies the attributes from the given node and applies them to this
-         * builder.
-         *
-         * <p>Note that this copies all attributes <strong>except</strong> the
-         * permission itself.</p>
-         *
-         * @param node the node to copy from
-         * @return the builder
-         * @since 4.2
-         */
-        Builder copyFrom(@NonNull Node node);
-
-        /**
-         * Sets the value of negated for the node.
-         *
-         * @param negated the value
-         * @return the builder
-         * @see Node#isNegated()
-         */
-        @NonNull Builder setNegated(boolean negated);
-
-        /**
-         * Sets the value of the node.
-         *
-         * @param value the value
-         * @return the builder
-         * @see Node#getValue()
-         */
-        @NonNull Builder setValue(boolean value);
-
-        /**
-         * Sets the override property for the node.
-         *
-         * <p>Warning: this value does not persist, and disappears when the holder is re-loaded.
-         * It is therefore only useful for transient nodes.</p>
-         *
-         * @param override the override state
-         * @return the builder
-         * @see Node#isOverride()
-         */
-        @NonNull Builder setOverride(boolean override);
-
-        /**
-         * Sets the time when the node should expire.
-         *
-         * <p>The parameter passed to this method must be the unix timestamp
-         * (in seconds) when the node should expire.</p>
-         *
-         * @param expiryUnixTimestamp the expiry timestamp (unix seconds)
-         * @return the builder
-         * @see Node#getExpiryUnixTime()
-         */
-        @NonNull Builder setExpiry(long expiryUnixTimestamp);
-
-        /**
-         * Sets the time when the node should expire.
-         *
-         * <p>The expiry timestamp is calculated relative to the current
-         * system time.</p>
-         *
-         * @param duration how long the node should be added for
-         * @param unit     the unit <code>duration</code> is measured in
-         * @return the builder
-         * @since 4.2
-         */
-        default @NonNull Builder setExpiry(long duration, TimeUnit unit) {
-            Preconditions.checkArgument(duration > 0, "duration must be positive");
-            long seconds = Objects.requireNonNull(unit, "unit").toSeconds(duration);
-            long timeNow = System.currentTimeMillis() / 1000L;
-            return setExpiry(timeNow + seconds);
-        }
-
-        /**
-         * Marks that the node being built should never expire.
-         *
-         * @return the builder
-         * @since 4.2
-         */
-        @NonNull Builder clearExpiry();
-
-        /**
-         * Sets the world value for the node.
-         *
-         * @param world the world value
-         * @return the builder
-         * @see Node#getWorld()
-         */
-        @NonNull Builder setWorld(@Nullable String world);
-
-        /**
-         * Sets the server value for the node.
-         *
-         * @param server the world value
-         * @return the builder
-         * @see Node#getServer()
-         */
-        @NonNull Builder setServer(@Nullable String server);
-
-        /**
-         * Appends an extra context onto the node.
-         *
-         * @param key   the context key
-         * @param value the context value
-         * @return the builder
-         * @see ContextSet
-         * @see Node#getContexts()
-         */
-        @NonNull Builder withExtraContext(@NonNull String key, @NonNull String value);
-
-        /**
-         * Appends extra contexts onto the node.
-         *
-         * @param map a map of contexts
-         * @return the builder
-         * @see ContextSet
-         * @see Node#getContexts()
-         */
-        @NonNull Builder withExtraContext(@NonNull Map<String, String> map);
-
-        /**
-         * Appends extra contexts onto the node.
-         *
-         * @param context a set of contexts
-         * @return the builder
-         * @see ContextSet
-         * @see Node#getContexts()
-         */
-        @NonNull Builder withExtraContext(@NonNull Set<Map.Entry<String, String>> context);
-
-        /**
-         * Appends an extra context onto the node.
-         *
-         * @param entry the context
-         * @return the builder
-         * @see ContextSet
-         * @see Node#getContexts()
-         */
-        @NonNull Builder withExtraContext(Map.@NonNull Entry<String, String> entry);
-
-        /**
-         * Appends extra contexts onto the node.
-         *
-         * @param contextSet a context set
-         * @return the builder
-         * @see ContextSet
-         * @see Node#getContexts()
-         */
-        @NonNull Builder withExtraContext(@NonNull ContextSet contextSet);
-
-        /**
-         * Sets the extra contexts for the node.
-         *
-         * @param contextSet a context set
-         * @return the builder
-         * @see ContextSet
-         * @see Node#getContexts()
-         * @since 4.2
-         */
-        @NonNull Builder setExtraContext(@NonNull ContextSet contextSet);
-
-        /**
-         * Creates a {@link Node} instance from the builder.
-         *
-         * @return a new node instance
-         */
-        @NonNull Node build();
-    }
-
-}

api/src/main/java/me/lucko/luckperms/api/NodeEqualityPredicate.java

@@ -1,55 +0,0 @@
-/*
- * This file is part of LuckPerms, licensed under the MIT License.
- *
- *  Copyright (c) lucko (Luck) <luck@lucko.me>
- *  Copyright (c) contributors
- *
- *  Permission is hereby granted, free of charge, to any person obtaining a copy
- *  of this software and associated documentation files (the "Software"), to deal
- *  in the Software without restriction, including without limitation the rights
- *  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- *  copies of the Software, and to permit persons to whom the Software is
- *  furnished to do so, subject to the following conditions:
- *
- *  The above copyright notice and this permission notice shall be included in all
- *  copies or substantial portions of the Software.
- *
- *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- *  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- *  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- *  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- *  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- *  SOFTWARE.
- */
-
-package me.lucko.luckperms.api;
-
-import org.checkerframework.checker.nullness.qual.NonNull;
-
-/**
- * A rule for determining if two nodes are equal.
- *
- * <p>Generally, individual instances of this interface should fulfil the same
- * requirements as the {@link Object#equals(Object)} contract.</p>
- *
- * <p>Some standard implementations are provided by {@link StandardNodeEquality}.</p>
- *
- * @since 4.1
- */
-@FunctionalInterface
-public interface NodeEqualityPredicate {
-
-    /**
-     * Returns if the two nodes are equal.
-     *
-     * <p>This method should avoid making calls to {@link Node#equals(Node, NodeEqualityPredicate)}
-     * with {@code this} as the second argument, directly or otherwise.</p>
-     *
-     * @param o1 the first node
-     * @param o2 the second node
-     * @return true if equal
-     */
-    boolean areEqual(@NonNull Node o1, @NonNull Node o2);
-
-}

api/src/main/java/me/lucko/luckperms/api/NodeFactory.java

@@ -1,119 +0,0 @@
-/*
- * This file is part of LuckPerms, licensed under the MIT License.
- *
- *  Copyright (c) lucko (Luck) <luck@lucko.me>
- *  Copyright (c) contributors
- *
- *  Permission is hereby granted, free of charge, to any person obtaining a copy
- *  of this software and associated documentation files (the "Software"), to deal
- *  in the Software without restriction, including without limitation the rights
- *  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- *  copies of the Software, and to permit persons to whom the Software is
- *  furnished to do so, subject to the following conditions:
- *
- *  The above copyright notice and this permission notice shall be included in all
- *  copies or substantial portions of the Software.
- *
- *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- *  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- *  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- *  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- *  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- *  SOFTWARE.
- */
-
-package me.lucko.luckperms.api;
-
-import org.checkerframework.checker.nullness.qual.NonNull;
-
-/**
- * Assists with constructing {@link Node} instances.
- *
- * @since 2.17
- */
-public interface NodeFactory {
-
-    /**
-     * Creates a new node builder from a given base permission string
-     *
-     * @param permission the permission
-     * @return a node builder instance
-     * @throws NullPointerException if the permission is null
-     */
-    Node.@NonNull Builder newBuilder(@NonNull String permission);
-
-    /**
-     * Creates a node builder instance from an existing node
-     *
-     * @param other the other node
-     * @return a node builder instance
-     * @throws NullPointerException if the other node is null
-     */
-    Node.@NonNull Builder newBuilderFromExisting(@NonNull Node other);
-
-
-    /**
-     * Creates a node builder from a group
-     *
-     * @param group the group
-     * @return a node builder instance
-     * @throws NullPointerException  if the group is null
-     * @throws IllegalStateException if the group instance was not obtained from LuckPerms.
-     * @since 3.1
-     */
-    Node.@NonNull Builder makeGroupNode(@NonNull Group group);
-
-    /**
-     * Creates a node builder from a group
-     *
-     * @param groupName the name of the group
-     * @return a node builder instance
-     * @throws NullPointerException if the groupName is null
-     * @since 4.0
-     */
-    Node.@NonNull Builder makeGroupNode(@NonNull String groupName);
-
-    /**
-     * Creates a node builder from a key value pair
-     *
-     * @param key   the key
-     * @param value the value
-     * @return a node builder instance
-     * @throws NullPointerException if the key or value is null
-     */
-    Node.@NonNull Builder makeMetaNode(@NonNull String key, @NonNull String value);
-
-    /**
-     * Creates a node builder for the given chat meta type
-     *
-     * @param type     the type
-     * @param priority the priority
-     * @param value    the value for the prefix/suffix
-     * @return a node builder instance
-     * @throws NullPointerException if the type or value is null
-     * @since 3.2
-     */
-    Node.@NonNull Builder makeChatMetaNode(@NonNull ChatMetaType type, int priority, @NonNull String value);
-
-    /**
-     * Creates a node builder from a prefix string and priority
-     *
-     * @param priority the priority
-     * @param prefix   the prefix string
-     * @return a node builder instance
-     * @throws NullPointerException if the prefix is null
-     */
-    Node.@NonNull Builder makePrefixNode(int priority, @NonNull String prefix);
-
-    /**
-     * Creates a node builder from a prefix string and priority
-     *
-     * @param priority the priority
-     * @param suffix   the suffix string
-     * @return a node builder instance
-     * @throws NullPointerException if the suffix is null
-     */
-    Node.@NonNull Builder makeSuffixNode(int priority, @NonNull String suffix);
-
-}

api/src/main/java/me/lucko/luckperms/api/PermissionHolder.java

@@ -1,777 +0,0 @@
-/*
- * This file is part of LuckPerms, licensed under the MIT License.
- *
- *  Copyright (c) lucko (Luck) <luck@lucko.me>
- *  Copyright (c) contributors
- *
- *  Permission is hereby granted, free of charge, to any person obtaining a copy
- *  of this software and associated documentation files (the "Software"), to deal
- *  in the Software without restriction, including without limitation the rights
- *  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- *  copies of the Software, and to permit persons to whom the Software is
- *  furnished to do so, subject to the following conditions:
- *
- *  The above copyright notice and this permission notice shall be included in all
- *  copies or substantial portions of the Software.
- *
- *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- *  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- *  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- *  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- *  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- *  SOFTWARE.
- */
-
-package me.lucko.luckperms.api;
-
-import com.google.common.collect.ImmutableSetMultimap;
-import com.google.common.collect.Multimap;
-
-import me.lucko.luckperms.api.caching.CachedData;
-import me.lucko.luckperms.api.context.ContextSet;
-import me.lucko.luckperms.api.context.ImmutableContextSet;
-import me.lucko.luckperms.api.manager.GroupManager;
-import me.lucko.luckperms.api.manager.UserManager;
-import me.lucko.luckperms.api.nodetype.types.MetaType;
-import me.lucko.luckperms.api.nodetype.types.PrefixType;
-import me.lucko.luckperms.api.nodetype.types.SuffixType;
-
-import org.checkerframework.checker.nullness.qual.NonNull;
-
-import java.util.List;
-import java.util.Map;
-import java.util.Set;
-import java.util.SortedSet;
-import java.util.UUID;
-import java.util.concurrent.CompletableFuture;
-import java.util.function.Predicate;
-
-/**
- * Generic superinterface for an object which holds permissions.
- */
-public interface PermissionHolder {
-
-    /**
-     * Gets the objects generic name.
-     *
-     * <p>The result of this method is guaranteed to be a unique identifier for distinct instances
-     * of the same type of object.</p>
-     *
-     * <p>For {@link User}s, this method returns a {@link UUID#toString() string} representation of
-     * the users {@link User#getUuid() unique id}.</p>
-     *
-     * <p>For {@link Group}s, this method returns the {@link Group#getName() group name}.</p>
-     *
-     * <p>The {@link User#getUuid()}, {@link User#getName()} and {@link Group#getName()} methods
-     * define a "tighter" specification for obtaining object identifiers.</p>
-     *
-     * @return the identifier for this object. Either a uuid string or name.
-     */
-    @NonNull String getObjectName();
-
-    /**
-     * Gets a friendly name for this holder, to be displayed in command output, etc.
-     *
-     * <p>This will <strong>always</strong> return a value, eventually falling back to
-     * {@link #getObjectName()} if no other "friendlier" identifiers are present.</p>
-     *
-     * <p>For {@link User}s, this method will attempt to return the {@link User#getName() username},
-     * before falling back to {@link #getObjectName()}.</p>
-     *
-     * <p>For {@link Group}s, this method will attempt to return the groups display name, before
-     * falling back to {@link #getObjectName()}.</p>
-     *
-     * @return a friendly identifier for this holder
-     * @since 3.2
-     */
-    @NonNull String getFriendlyName();
-
-    /**
-     * Gets the holders {@link CachedData} cache.
-     *
-     * @return the holders cached data.
-     * @since 3.2
-     */
-    @NonNull CachedData getCachedData();
-
-    /**
-     * Refreshes and applies any changes to the cached holder data.
-     *
-     * <p>Calling this method is unnecessary in most cases. Cache updates are handled
-     * behind the scenes by the implementation.</p>
-     *
-     * @return the task future
-     * @since 4.0
-     */
-    @NonNull CompletableFuture<Void> refreshCachedData();
-
-    /**
-     * Gets the backing multimap containing every permission this holder has.
-     *
-     * <p>This method <b>does not</b> resolve inheritance rules, and returns a
-     * view of what's 'in the file'.</p>
-     *
-     * @return the holders own permissions
-     * @since 3.3
-     */
-    @NonNull ImmutableSetMultimap<ImmutableContextSet, Node> getNodes();
-
-    /**
-     * Gets the backing multimap containing every transient permission this holder has.
-     *
-     * <p>This method <b>does not</b> resolve inheritance rules.</p>
-     *
-     * <p>Transient permissions only exist for the duration of the session.</p>
-     *
-     * @return the holders own permissions
-     * @since 3.3
-     */
-    @NonNull ImmutableSetMultimap<ImmutableContextSet, Node> getTransientNodes();
-
-    /**
-     * Gets a flattened/squashed view of the holders permissions.
-     *
-     * <p>This list is constructed using the {@link Multimap#values()} method
-     * of both the transient and enduring backing multimaps.</p>
-     *
-     * <p>This means that it <b>may contain</b> duplicate entries.</p>
-     *
-     * <p>Use {@link #getPermissions()} for a view without duplicates.</p>
-     *
-     * <p>This method <b>does not</b> resolve inheritance rules.</p>
-     *
-     * @return a list of the holders own nodes.
-     * @since 3.3
-     */
-    @NonNull List<Node> getOwnNodes();
-
-    /**
-     * Gets a sorted set of all held permissions.
-     *
-     * <p>Effectively a sorted version of {@link #getOwnNodes()}, without duplicates. Use the
-     * aforementioned method if you don't require either of these attributes.</p>
-     *
-     * <p>This method <b>does not</b> resolve inheritance rules.</p>
-     *
-     * <p>Although this method is named getPermissions, it will actually return all types of node.</p>
-     *
-     * @return an immutable set of permissions in priority order
-     * @since 2.6
-     */
-    @NonNull SortedSet<? extends Node> getPermissions();
-
-    /**
-     * Similar to {@link #getPermissions()}, except only including permissions from the enduring
-     * node map. (See {@link #getNodes()})
-     *
-     * <p>Unlike transient permissions, enduring permissions will be saved to storage, and exist
-     * after the session.</p>
-     *
-     * <p>This method <b>does not</b> resolve inheritance rules.</p>
-     *
-     * <p>Although this method is named getEnduringPermissions, it will actually return all types
-     * of node.</p>
-     *
-     * @return a set of nodes
-     * @since 2.6
-     */
-    @NonNull Set<? extends Node> getEnduringPermissions();
-
-    /**
-     * Similar to {@link #getPermissions()}, except only including permissions from the enduring
-     * node map. (See {@link #getTransientNodes()})
-     *
-     * <p>Transient permissions only exist for the duration of the session.</p>
-     *
-     * <p>This method <b>does not</b> resolve inheritance rules.</p>
-     *
-     * <p>Although this method is named getTransientPermissions, it will actually return all types
-     * of node.</p>
-     *
-     * @return a set of nodes
-     * @since 2.6
-     */
-    @NonNull Set<? extends Node> getTransientPermissions();
-
-    /**
-     * A filtered view of this holders nodes, only including permanent entries.
-     *
-     * <p>Data is sourced from {@link #getOwnNodes()}, filtered, and then collected to a set.</p>
-     *
-     * <p>This method <b>does not</b> resolve inheritance rules.</p>
-     *
-     * <p>Although this method is named getPermanentPermissionNodes, it will actually return all types
-     * of node.</p>
-     *
-     * @return a set of permanent nodes
-     * @since 2.6
-     */
-    @NonNull Set<Node> getPermanentPermissionNodes();
-
-    /**
-     * A filtered view of this holders nodes, only including temporary entries.
-     *
-     * <p>Data is sourced from {@link #getOwnNodes()}, filtered, and then collected to a set.</p>
-     *
-     * <p>This method <b>does not</b> resolve inheritance rules.</p>
-     *
-     * <p>Although this method is named getTemporaryPermissionNodes, it will actually return all types
-     * of node.</p>
-     *
-     * @return a set of temporary nodes
-     * @since 2.6
-     */
-    @NonNull Set<Node> getTemporaryPermissionNodes();
-
-    /**
-     * Recursively resolves this holders permissions.
-     *
-     * <p>The returned list will contain every inherited
-     * node the holder has, in the order that they were inherited in.</p>
-     *
-     * <p>This means the list will contain duplicates.</p>
-     *
-     * <p>Inheritance is performed according to the platforms rules, and the order will vary
-     * depending on the accumulation order. By default, the holders own nodes are first in the list,
-     * with the entries from the end of the inheritance tree appearing last.</p>
-     *
-     * @param contexts the contexts for the lookup
-     * @return a list of nodes
-     * @since 3.3
-     */
-    @NonNull List<LocalizedNode> resolveInheritances(@NonNull Contexts contexts);
-
-    /**
-     * Recursively resolves this holders permissions.
-     *
-     * <p>The returned list will contain every inherited
-     * node the holder has, in the order that they were inherited in.</p>
-     *
-     * <p>This means the list will contain duplicates.</p>
-     *
-     * <p>Unlike {@link #resolveInheritances(Contexts)}, this method does not
-     * filter by context, at all.</p>
-     *
-     * <p>Inheritance is performed according to the platforms rules, and the order will vary
-     * depending on the accumulation order. By default, the holders own nodes are first in the list,
-     * with the entries from the end of the inheritance tree appearing last.</p>
-     *
-     * @return a list of nodes
-     * @since 3.3
-     */
-    @NonNull List<LocalizedNode> resolveInheritances();
-
-    /**
-     * Gets a mutable sorted set of the nodes that this object has and inherits, filtered by context
-     *
-     * <p>Unlike {@link #getAllNodesFiltered(Contexts)}, this method will not filter individual
-     * nodes by context. The context is only used to determine which groups should apply.</p>
-     *
-     * <p>Nodes are sorted into priority order. The order of inheritance is only important during
-     * the process of flattening inherited entries.</p>
-     *
-     * @param contexts the context for the lookup
-     * @return an immutable sorted set of permissions
-     * @throws NullPointerException if the context is null
-     * @since 2.11
-     */
-    @NonNull SortedSet<LocalizedNode> getAllNodes(@NonNull Contexts contexts);
-
-    /**
-     * Gets a mutable sorted set of the nodes that this object has and inherits.
-     *
-     * <p>Unlike {@link #getAllNodes(Contexts)}, this method does not filter by context, at all.</p>
-     *
-     * <p>Nodes are sorted into priority order. The order of inheritance is only important during
-     * the process of flattening inherited entries.</p>
-     *
-     * @return an immutable sorted set of permissions
-     * @throws NullPointerException if the context is null
-     * @since 3.3
-     */
-    @NonNull SortedSet<LocalizedNode> getAllNodes();
-
-    /**
-     * Gets a mutable set of the nodes that this object has and inherits, filtered by context.
-     *
-     * <p>Unlike {@link #getAllNodes(Contexts)}, this method WILL filter individual nodes,
-     * and only return ones that fully meet the context provided.</p>
-     *
-     * @param contexts the context for the lookup
-     * @return a mutable set of permissions
-     * @throws NullPointerException if the context is null
-     * @since 2.11
-     */
-    @NonNull Set<LocalizedNode> getAllNodesFiltered(@NonNull Contexts contexts);
-
-    /**
-     * Converts the output of {@link #getAllNodesFiltered(Contexts)} into string and boolean form,
-     * and expands shorthand permissions.
-     *
-     * @param contexts           the context for the lookup
-     * @param convertToLowercase if the keys should be made lowercase whilst being exported
-     * @return a mutable map of permissions
-     */
-    @NonNull Map<String, Boolean> exportNodes(@NonNull Contexts contexts, boolean convertToLowercase);
-
-    /**
-     * Removes any temporary permissions that have expired.
-     *
-     * <p>This method is called periodically by the platform, so it is only necessary to run
-     * if you want to guarentee that the current data is totally up-to-date.</p>
-     */
-    void auditTemporaryPermissions();
-
-    /**
-     * Checks to see if the object has a certain permission.
-     *
-     * <p>Although this method is named hasPermission, it can be used for all node types.</p>
-     *
-     * @param node              the node to check for
-     * @param equalityPredicate how to determine if a node matches
-     * @return a Tristate for the holders permission status for the node
-     * @throws NullPointerException if the node is null
-     * @since 4.1
-     */
-    @NonNull Tristate hasPermission(@NonNull Node node, @NonNull NodeEqualityPredicate equalityPredicate);
-
-    /**
-     * Checks to see if the object has a certain permission.
-     *
-     * <p>Although this method is named hasTransientPermission, it can be used for all node types.</p>
-     *
-     * @param node              the node to check for
-     * @param equalityPredicate how to determine if a node matches
-     * @return a Tristate for the holders permission status for the node
-     * @throws NullPointerException if the node is null
-     * @since 4.1
-     */
-    @NonNull Tristate hasTransientPermission(@NonNull Node node, @NonNull NodeEqualityPredicate equalityPredicate);
-
-    /**
-     * Checks to see if the object inherits a certain permission.
-     *
-     * <p>Although this method is named inheritsPermission, it can be used for all node types.</p>
-     *
-     * @param node              the node to check for
-     * @param equalityPredicate how to determine if a node matches
-     * @return a Tristate for the holders inheritance status for the node
-     * @throws NullPointerException if the node is null
-     * @since 4.1
-     */
-    @NonNull Tristate inheritsPermission(@NonNull Node node, @NonNull NodeEqualityPredicate equalityPredicate);
-
-    /**
-     * Checks to see if the object has a certain permission.
-     *
-     * <p>Although this method is named hasPermission, it can be used for all node types.</p>
-     *
-     * @param node the node to check for
-     * @return a Tristate for the holders permission status for the node
-     * @throws NullPointerException if the node is null
-     * @since 2.6
-     */
-    @NonNull Tristate hasPermission(@NonNull Node node);
-
-    /**
-     * Checks to see if the object has a certain permission.
-     *
-     * <p>Although this method is named hasTransientPermission, it can be used for all node types.</p>
-     *
-     * @param node the node to check for
-     * @return a Tristate for the holders permission status for the node
-     * @throws NullPointerException if the node is null
-     * @since 2.6
-     */
-    @NonNull Tristate hasTransientPermission(@NonNull Node node);
-
-    /**
-     * Checks to see if the object inherits a certain permission.
-     *
-     * <p>Although this method is named inheritsPermission, it can be used for all node types.</p>
-     *
-     * @param node the node to check for
-     * @return a Tristate for the holders inheritance status for the node
-     * @throws NullPointerException if the node is null
-     * @since 2.6
-     */
-    @NonNull Tristate inheritsPermission(@NonNull Node node);
-
-    /**
-     * Check to see if this holder inherits another group in the global context.
-     *
-     * <p>"Global context" simply means an empty context set.</p>
-     *
-     * <p>This method only checks for direct inheritance - one hop up the inheritance tree.</p>
-     *
-     * @param group The group to check membership of
-     * @return true if the group inherits the other group
-     * @throws NullPointerException  if the group is null
-     * @throws IllegalStateException if the group instance was not obtained from LuckPerms.
-     * @since 4.0
-     */
-    boolean inheritsGroup(@NonNull Group group);
-
-    /**
-     * Check to see if this holder inherits another group.
-     *
-     * <p>This method only checks for direct inheritance - one hop up the inheritance tree.</p>
-     *
-     * @param group      The group to check membership of
-     * @param contextSet the context set to filter by
-     * @return true if the group inherits the other group
-     * @throws NullPointerException  if the group is null
-     * @throws IllegalStateException if the group instance was not obtained from LuckPerms.
-     * @since 4.0
-     */
-    boolean inheritsGroup(@NonNull Group group, @NonNull ContextSet contextSet);
-
-    /**
-     * Sets a permission node for the permission holder.
-     *
-     * <p>Although this method is named setPermission, it can be used for all node types.</p>
-     *
-     * <p>The effect of this mutate operation will not persist in storage unless changes are
-     * explicitly saved. If changes are not saved, the effect will only be observed until the next
-     * time the holders permission data is (re)loaded. Changes to {@link User}s should be saved
-     * using {@link UserManager#saveUser(User)}, and changes to {@link Group}s should be saved
-     * using {@link GroupManager#saveGroup(Group)}.</p>
-     *
-     * <p>Before making changes to a user or group, it may be a good idea to load a fresh copy of
-     * the backing data from the storage if you haven't done so already, to avoid overwriting changes
-     * made already. This can be done via {@link UserManager#loadUser(UUID)} or
-     * {@link GroupManager#loadGroup(String)} respectively.</p>
-     *
-     * @param node The node to be set
-     * @return the result of the operation
-     * @throws NullPointerException if the node is null
-     * @since 4.0
-     */
-    @NonNull DataMutateResult setPermission(@NonNull Node node);
-
-    /**
-     * Sets a permission node for the permission holder.
-     *
-     * <p>Although this method is named setPermission, it can be used for all node types.</p>
-     *
-     * <p>The effect of this mutate operation will not persist in storage unless changes are
-     * explicitly saved. If changes are not saved, the effect will only be observed until the next
-     * time the holders permission data is (re)loaded. Changes to {@link User}s should be saved
-     * using {@link UserManager#saveUser(User)}, and changes to {@link Group}s should be saved
-     * using {@link GroupManager#saveGroup(Group)}.</p>
-     *
-     * <p>Before making changes to a user or group, it may be a good idea to load a fresh copy of
-     * the backing data from the storage if you haven't done so already, to avoid overwriting changes
-     * made already. This can be done via {@link UserManager#loadUser(UUID)} or
-     * {@link GroupManager#loadGroup(String)} respectively.</p>
-     *
-     * @param node                    The node to be set
-     * @param temporaryMergeBehaviour The behaviour used to merge temporary permission entries
-     * @return the result of the operation
-     * @throws NullPointerException if the node is null
-     * @since 4.3
-     */
-    @NonNull TemporaryDataMutateResult setPermission(@NonNull Node node, @NonNull TemporaryMergeBehaviour temporaryMergeBehaviour);
-
-    /**
-     * Sets a transient permission for the permission holder.
-     *
-     * <p>A transient node is a permission that does not persist.
-     * Whenever a user logs out of the server, or the server restarts, this permission will
-     * disappear. It is never saved to the datastore, and therefore will not apply on other
-     * servers.</p>
-     *
-     * <p>This is useful if you want to temporarily set a permission for a user while they're
-     * online, but don't want it to persist, and have to worry about removing it when they log
-     * out.</p>
-     *
-     * <p>For unsetting a transient permission, see {@link #unsetTransientPermission(Node)}.</p>
-     *
-     * <p>Although this method is named setTransientPermission, it can be used for all node types.</p>
-     *
-     * @param node The node to be set
-     * @return the result of the operation
-     * @throws NullPointerException if the node is null
-     * @since 4.0
-     */
-    @NonNull DataMutateResult setTransientPermission(@NonNull Node node);
-
-    /**
-     * Sets a transient permission for the permission holder.
-     *
-     * <p>A transient node is a permission that does not persist.
-     * Whenever a user logs out of the server, or the server restarts, this permission will
-     * disappear. It is never saved to the datastore, and therefore will not apply on other
-     * servers.</p>
-     *
-     * <p>This is useful if you want to temporarily set a permission for a user while they're
-     * online, but don't want it to persist, and have to worry about removing it when they log
-     * out.</p>
-     *
-     * <p>For unsetting a transient permission, see {@link #unsetTransientPermission(Node)}.</p>
-     *
-     * <p>Although this method is named setTransientPermission, it can be used for all node types.</p>
-     *
-     * @param node                    The node to be se
-     * @param temporaryMergeBehaviour The behaviour used to merge temporary permission entries
-     * @return the result of the operation
-     * @throws NullPointerException if the node is null
-     * @since 4.3
-     */
-    @NonNull TemporaryDataMutateResult setTransientPermission(@NonNull Node node, @NonNull TemporaryMergeBehaviour temporaryMergeBehaviour);
-
-    /**
-     * Unsets a permission for the permission holder.
-     *
-     * <p>Although this method is named unsetPermission, it can be used for all node types.</p>
-     *
-     * <p>The effect of this mutate operation will not persist in storage unless changes are
-     * explicitly saved. If changes are not saved, the effect will only be observed until the next
-     * time the holders permission data is (re)loaded. Changes to {@link User}s should be saved
-     * using {@link UserManager#saveUser(User)}, and changes to {@link Group}s should be saved
-     * using {@link GroupManager#saveGroup(Group)}.</p>
-     *
-     * <p>Before making changes to a user or group, it may be a good idea to load a fresh copy of
-     * the backing data from the storage if you haven't done so already, to avoid overwriting changes
-     * made already. This can be done via {@link UserManager#loadUser(UUID)} or
-     * {@link GroupManager#loadGroup(String)} respectively.</p>
-     *
-     * @param node The node to be unset
-     * @return the result of the operation
-     * @throws NullPointerException if the node is null
-     * @since 4.0
-     */
-    @NonNull DataMutateResult unsetPermission(@NonNull Node node);
-
-    /**
-     * Unsets a transient permission for the permission holder.
-     *
-     * <p>Although this method is named unsetTransientPermission, it can be used for all node types.</p>
-     *
-     * @param node The node to be unset
-     * @return the result of the operation
-     * @throws NullPointerException if the node is null
-     * @since 4.0
-     */
-    @NonNull DataMutateResult unsetTransientPermission(@NonNull Node node);
-
-    /**
-     * Clears any nodes from the holder which pass the predicate.
-     *
-     * <p>This method only targets enduring data.</p>
-     *
-     * <p>The effect of this mutate operation will not persist in storage unless changes are
-     * explicitly saved. If changes are not saved, the effect will only be observed until the next
-     * time the holders permission data is (re)loaded. Changes to {@link User}s should be saved
-     * using {@link UserManager#saveUser(User)}, and changes to {@link Group}s should be saved
-     * using {@link GroupManager#saveGroup(Group)}.</p>
-     *
-     * <p>Before making changes to a user or group, it may be a good idea to load a fresh copy of
-     * the backing data from the storage if you haven't done so already, to avoid overwriting changes
-     * made already. This can be done via {@link UserManager#loadUser(UUID)} or
-     * {@link GroupManager#loadGroup(String)} respectively.</p>
-     *
-     * @param test the predicate to test for nodes which should be removed
-     * @since 3.2
-     */
-    void clearMatching(@NonNull Predicate<Node> test);
-
-    /**
-     * Clears any transient nodes from the holder which pass the predicate.
-     *
-     * <p>The effect of this mutate operation will not persist in storage unless changes are
-     * explicitly saved. If changes are not saved, the effect will only be observed until the next
-     * time the holders permission data is (re)loaded. Changes to {@link User}s should be saved
-     * using {@link UserManager#saveUser(User)}, and changes to {@link Group}s should be saved
-     * using {@link GroupManager#saveGroup(Group)}.</p>
-     *
-     * <p>Before making changes to a user or group, it may be a good idea to load a fresh copy of
-     * the backing data from the storage if you haven't done so already, to avoid overwriting changes
-     * made already. This can be done via {@link UserManager#loadUser(UUID)} or
-     * {@link GroupManager#loadGroup(String)} respectively.</p>
-     *
-     * @param test the predicate to test for nodes which should be removed
-     * @since 3.2
-     */
-    void clearMatchingTransient(@NonNull Predicate<Node> test);
-
-    /**
-     * Clears all nodes held by the permission holder.
-     *
-     * <p>The effect of this mutate operation will not persist in storage unless changes are
-     * explicitly saved. If changes are not saved, the effect will only be observed until the next
-     * time the holders permission data is (re)loaded. Changes to {@link User}s should be saved
-     * using {@link UserManager#saveUser(User)}, and changes to {@link Group}s should be saved
-     * using {@link GroupManager#saveGroup(Group)}.</p>
-     *
-     * <p>Before making changes to a user or group, it may be a good idea to load a fresh copy of
-     * the backing data from the storage if you haven't done so already, to avoid overwriting changes
-     * made already. This can be done via {@link UserManager#loadUser(UUID)} or
-     * {@link GroupManager#loadGroup(String)} respectively.</p>
-     *
-     * @since 2.17
-     */
-    void clearNodes();
-
-    /**
-     * Clears all nodes held by the permission holder in a specific context.
-     *
-     * <p>The effect of this mutate operation will not persist in storage unless changes are
-     * explicitly saved. If changes are not saved, the effect will only be observed until the next
-     * time the holders permission data is (re)loaded. Changes to {@link User}s should be saved
-     * using {@link UserManager#saveUser(User)}, and changes to {@link Group}s should be saved
-     * using {@link GroupManager#saveGroup(Group)}.</p>
-     *
-     * <p>Before making changes to a user or group, it may be a good idea to load a fresh copy of
-     * the backing data from the storage if you haven't done so already, to avoid overwriting changes
-     * made already. This can be done via {@link UserManager#loadUser(UUID)} or
-     * {@link GroupManager#loadGroup(String)} respectively.</p>
-     *
-     * @param contextSet the contexts to filter by
-     * @since 3.2
-     */
-    void clearNodes(@NonNull ContextSet contextSet);
-
-    /**
-     * Clears all parent groups.
-     *
-     * <p>The effect of this mutate operation will not persist in storage unless changes are
-     * explicitly saved. If changes are not saved, the effect will only be observed until the next
-     * time the holders permission data is (re)loaded. Changes to {@link User}s should be saved
-     * using {@link UserManager#saveUser(User)}, and changes to {@link Group}s should be saved
-     * using {@link GroupManager#saveGroup(Group)}.</p>
-     *
-     * <p>Before making changes to a user or group, it may be a good idea to load a fresh copy of
-     * the backing data from the storage if you haven't done so already, to avoid overwriting changes
-     * made already. This can be done via {@link UserManager#loadUser(UUID)} or
-     * {@link GroupManager#loadGroup(String)} respectively.</p>
-     *
-     * @since 2.17
-     */
-    void clearParents();
-
-    /**
-     * Clears all parent groups in a specific context.
-     *
-     * <p>The effect of this mutate operation will not persist in storage unless changes are
-     * explicitly saved. If changes are not saved, the effect will only be observed until the next
-     * time the holders permission data is (re)loaded. Changes to {@link User}s should be saved
-     * using {@link UserManager#saveUser(User)}, and changes to {@link Group}s should be saved
-     * using {@link GroupManager#saveGroup(Group)}.</p>
-     *
-     * <p>Before making changes to a user or group, it may be a good idea to load a fresh copy of
-     * the backing data from the storage if you haven't done so already, to avoid overwriting changes
-     * made already. This can be done via {@link UserManager#loadUser(UUID)} or
-     * {@link GroupManager#loadGroup(String)} respectively.</p>
-     *
-     * @param contextSet the contexts to filter by
-     * @since 3.2
-     */
-    void clearParents(@NonNull ContextSet contextSet);
-
-    /**
-     * Clears all meta held by the permission holder.
-     *
-     * <p>Meta nodes in this case, are any nodes which have a {@link MetaType}, {@link PrefixType}
-     * or {@link SuffixType} type.</p>
-     *
-     * <p>The effect of this mutate operation will not persist in storage unless changes are
-     * explicitly saved. If changes are not saved, the effect will only be observed until the next
-     * time the holders permission data is (re)loaded. Changes to {@link User}s should be saved
-     * using {@link UserManager#saveUser(User)}, and changes to {@link Group}s should be saved
-     * using {@link GroupManager#saveGroup(Group)}.</p>
-     *
-     * <p>Before making changes to a user or group, it may be a good idea to load a fresh copy of
-     * the backing data from the storage if you haven't done so already, to avoid overwriting changes
-     * made already. This can be done via {@link UserManager#loadUser(UUID)} or
-     * {@link GroupManager#loadGroup(String)} respectively.</p>
-     *
-     * @since 2.17
-     */
-    void clearMeta();
-
-    /**
-     * Clears all meta held by the permission holder in a specific context.
-     *
-     * <p>Meta nodes in this case, are any nodes which have a {@link MetaType}, {@link PrefixType}
-     * or {@link SuffixType} type.</p>
-     *
-     * <p>The effect of this mutate operation will not persist in storage unless changes are
-     * explicitly saved. If changes are not saved, the effect will only be observed until the next
-     * time the holders permission data is (re)loaded. Changes to {@link User}s should be saved
-     * using {@link UserManager#saveUser(User)}, and changes to {@link Group}s should be saved
-     * using {@link GroupManager#saveGroup(Group)}.</p>
-     *
-     * <p>Before making changes to a user or group, it may be a good idea to load a fresh copy of
-     * the backing data from the storage if you haven't done so already, to avoid overwriting changes
-     * made already. This can be done via {@link UserManager#loadUser(UUID)} or
-     * {@link GroupManager#loadGroup(String)} respectively.</p>
-     *
-     * @param contextSet the contexts to filter by
-     * @since 3.2
-     */
-    void clearMeta(@NonNull ContextSet contextSet);
-
-    /**
-     * Clears all transient nodes the permission holder has.
-     */
-    void clearTransientNodes();
-
-    /**
-     * Sets a permission for the permission holder.
-     *
-     * @param node The node to be set
-     * @return the result of the operation
-     * @throws NullPointerException if the node is null
-     * @since 3.1
-     * @deprecated now forwards to {@link #setPermission(Node)}.
-     */
-    @Deprecated
-    default @NonNull DataMutateResult setPermissionUnchecked(@NonNull Node node) {
-        return setPermission(node);
-    }
-
-    /**
-     * Sets a transient permission for the permission holder.
-     *
-     * @param node The node to be set
-     * @return the result of the operation
-     * @throws NullPointerException if the node is null
-     * @since 3.1
-     * @deprecated now forwards to {@link #setTransientPermission(Node)}
-     */
-    @Deprecated
-    default @NonNull DataMutateResult setTransientPermissionUnchecked(@NonNull Node node) {
-        return setTransientPermission(node);
-    }
-
-    /**
-     * Unsets a permission for the permission holder.
-     *
-     * @param node The node to be unset
-     * @return the result of the operation
-     * @throws NullPointerException if the node is null
-     * @since 3.1
-     * @deprecated now forwards to {@link #unsetPermission(Node)}
-     */
-    @Deprecated
-    default @NonNull DataMutateResult unsetPermissionUnchecked(@NonNull Node node) {
-        return unsetPermission(node);
-    }
-
-    /**
-     * Unsets a transient permission for the permission holder.
-     *
-     * @param node The node to be unset
-     * @return the result of the operation
-     * @throws NullPointerException if the node is null
-     * @since 3.1
-     * @deprecated now forwards to {@link #unsetTransientPermission(Node)}
-     */
-    @Deprecated
-    default @NonNull DataMutateResult unsetTransientPermissionUnchecked(@NonNull Node node) {
-        return unsetTransientPermission(node);
-    }
-
-}

api/src/main/java/me/lucko/luckperms/api/Storage.java

@@ -1,332 +0,0 @@
-/*
- * This file is part of LuckPerms, licensed under the MIT License.
- *
- *  Copyright (c) lucko (Luck) <luck@lucko.me>
- *  Copyright (c) contributors
- *
- *  Permission is hereby granted, free of charge, to any person obtaining a copy
- *  of this software and associated documentation files (the "Software"), to deal
- *  in the Software without restriction, including without limitation the rights
- *  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- *  copies of the Software, and to permit persons to whom the Software is
- *  furnished to do so, subject to the following conditions:
- *
- *  The above copyright notice and this permission notice shall be included in all
- *  copies or substantial portions of the Software.
- *
- *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- *  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- *  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- *  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- *  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- *  SOFTWARE.
- */
-
-package me.lucko.luckperms.api;
-
-import me.lucko.luckperms.api.manager.GroupManager;
-import me.lucko.luckperms.api.manager.TrackManager;
-import me.lucko.luckperms.api.manager.UserManager;
-
-import org.checkerframework.checker.nullness.qual.NonNull;
-import org.checkerframework.checker.nullness.qual.Nullable;
-
-import java.util.List;
-import java.util.Set;
-import java.util.UUID;
-import java.util.concurrent.CompletableFuture;
-import java.util.concurrent.Executor;
-
-/**
- * A means of loading and saving permission data to/from the backend.
- *
- * @since 2.14
- */
-public interface Storage {
-
-    /**
-     * Get the name of the storage implementation.
-     *
-     * @return the name of the implementation
-     */
-    @NonNull String getName();
-
-    /**
-     * Gets whether the storage instance is allowing logins on the platform.
-     *
-     * @return true if logins are enabled
-     * @deprecated as this method always returns true.
-     */
-    @Deprecated
-    boolean isAcceptingLogins();
-
-    /**
-     * Saves an action to storage
-     *
-     * @param entry the log entry to be saved
-     * @return true if the operation completed successfully.
-     * @throws NullPointerException if entry is null
-     * @deprecated in favour of {@link ActionLogger#submit(LogEntry)}.
-     */
-    @Deprecated
-    @NonNull CompletableFuture<Boolean> logAction(@NonNull LogEntry entry);
-
-    /**
-     * Loads and returns the entire log from storage
-     *
-     * @return a log instance, could be null if loading failed
-     * @deprecated in favour of {@link ActionLogger#getLog()}
-     */
-    @Deprecated
-    @NonNull CompletableFuture<Log> getLog();
-
-    /**
-     * Loads a user's data from the main storage into the plugins local storage.
-     *
-     * @param uuid     the uuid of the user to load
-     * @param username the users username, or null if it is not known.
-     * @return if the operation completed successfully
-     * @throws NullPointerException if uuid is null
-     * @deprecated in favour of {@link UserManager#loadUser(UUID, String)}
-     */
-    @Deprecated
-    @NonNull CompletableFuture<Boolean> loadUser(@NonNull UUID uuid, @Nullable String username);
-
-    /**
-     * Loads a user's data from the main storage into the plugins local storage.
-     *
-     * @param uuid the uuid of the user to load
-     * @return if the operation completed successfully
-     * @throws NullPointerException if uuid is null
-     * @deprecated in favour of {@link UserManager#loadUser(UUID)}
-     */
-    @Deprecated
-    default @NonNull CompletableFuture<Boolean> loadUser(@NonNull UUID uuid) {
-        return loadUser(uuid, null);
-    }
-
-    /**
-     * Saves a user object back to storage.
-     *
-     * <p>You should call this after you make any changes to a user.</p>
-     *
-     * @param user the user to save
-     * @return true if the operation completed successfully.
-     * @throws NullPointerException  if user is null
-     * @throws IllegalStateException if the user instance was not obtained from LuckPerms.
-     * @deprecated in favour of {@link UserManager#saveUser(User)}
-     */
-    @Deprecated
-    @NonNull CompletableFuture<Boolean> saveUser(@NonNull User user);
-
-    /**
-     * Gets a set all "unique" user UUIDs.
-     *
-     * <p>"Unique" meaning the user isn't just a member of the "default" group.</p>
-     *
-     * @return a set of uuids, or null if the operation failed.
-     * @deprecated in favour of {@link UserManager#getUniqueUsers()}
-     */
-    @Deprecated
-    @NonNull CompletableFuture<Set<UUID>> getUniqueUsers();
-
-    /**
-     * Searches for a list of users with a given permission.
-     *
-     * @param permission the permission to search for
-     * @return a list of held permissions, or null if the operation failed
-     * @throws NullPointerException if the permission is null
-     * @since 2.17
-     * @deprecated in favour of {@link UserManager#getWithPermission(String)}
-     */
-    @Deprecated
-    @NonNull CompletableFuture<List<HeldPermission<UUID>>> getUsersWithPermission(@NonNull String permission);
-
-    /**
-     * Creates and loads a group into the plugins local storage
-     *
-     * @param name the name of the group
-     * @return true if the operation completed successfully
-     * @throws NullPointerException     if name is null
-     * @throws IllegalArgumentException if the name is invalid
-     * @deprecated in favour of {@link GroupManager#createAndLoadGroup(String)}
-     */
-    @Deprecated
-    @NonNull CompletableFuture<Boolean> createAndLoadGroup(@NonNull String name);
-
-    /**
-     * Loads a group into the plugins local storage.
-     *
-     * @param name the name of the group
-     * @return true if the operation completed successfully
-     * @throws NullPointerException     if name is null
-     * @throws IllegalArgumentException if the name is invalid
-     * @deprecated in favour of {@link GroupManager#loadGroup(String)}
-     */
-    @Deprecated
-    @NonNull CompletableFuture<Boolean> loadGroup(@NonNull String name);
-
-    /**
-     * Loads all groups from the storage into memory
-     *
-     * @return true if the operation completed successfully.
-     * @deprecated in favour of {@link GroupManager#loadAllGroups()}
-     */
-    @Deprecated
-    @NonNull CompletableFuture<Boolean> loadAllGroups();
-
-    /**
-     * Saves a group back to storage.
-     *
-     * <p>You should call this after you make any changes to a group.</p>
-     *
-     * @param group the group to save
-     * @return true if the operation completed successfully.
-     * @throws NullPointerException  if group is null
-     * @throws IllegalStateException if the group instance was not obtained from LuckPerms.
-     * @deprecated in favour of {@link GroupManager#saveGroup(Group)}
-     */
-    @Deprecated
-    @NonNull CompletableFuture<Boolean> saveGroup(@NonNull Group group);
-
-    /**
-     * Permanently deletes a group from storage.
-     *
-     * @param group the group to delete
-     * @return true if the operation completed successfully.
-     * @throws NullPointerException  if group is null
-     * @throws IllegalStateException if the group instance was not obtained from LuckPerms.
-     * @deprecated in favour of {@link GroupManager#deleteGroup(Group)}
-     */
-    @Deprecated
-    @NonNull CompletableFuture<Boolean> deleteGroup(@NonNull Group group);
-
-    /**
-     * Searches for a list of groups with a given permission.
-     *
-     * @param permission the permission to search for
-     * @return a list of held permissions, or null if the operation failed
-     * @throws NullPointerException if the permission is null
-     * @since 2.17
-     * @deprecated in favour of {@link GroupManager#getWithPermission(String)}
-     */
-    @Deprecated
-    @NonNull CompletableFuture<List<HeldPermission<String>>> getGroupsWithPermission(@NonNull String permission);
-
-    /**
-     * Creates and loads a track into the plugins local storage
-     *
-     * @param name the name of the track
-     * @return true if the operation completed successfully
-     * @throws NullPointerException     if name is null
-     * @throws IllegalArgumentException if the name is invalid
-     * @deprecated in favour of {@link TrackManager#createAndLoadTrack(String)}
-     */
-    @Deprecated
-    @NonNull CompletableFuture<Boolean> createAndLoadTrack(@NonNull String name);
-
-    /**
-     * Loads a track into the plugins local storage.
-     *
-     * @param name the name of the track
-     * @return true if the operation completed successfully
-     * @throws NullPointerException     if name is null
-     * @throws IllegalArgumentException if the name is invalid
-     * @deprecated in favour of {@link TrackManager#loadTrack(String)}
-     */
-    @Deprecated
-    @NonNull CompletableFuture<Boolean> loadTrack(@NonNull String name);
-
-    /**
-     * Loads all tracks from the storage into memory
-     *
-     * @return true if the operation completed successfully.
-     * @deprecated in favour of {@link TrackManager#loadAllTracks()}
-     */
-    @Deprecated
-    @NonNull CompletableFuture<Boolean> loadAllTracks();
-
-    /**
-     * Saves a track back to storage. You should call this after you make any changes to a track.
-     *
-     * @param track the track to save
-     * @return true if the operation completed successfully.
-     * @throws NullPointerException  if track is null
-     * @throws IllegalStateException if the track instance was not obtained from LuckPerms.
-     * @deprecated in favour of {@link TrackManager#saveTrack(Track)}
-     */
-    @Deprecated
-    @NonNull CompletableFuture<Boolean> saveTrack(@NonNull Track track);
-
-    /**
-     * Permanently deletes a track from storage
-     *
-     * @param track the track to delete
-     * @return true if the operation completed successfully.
-     * @throws NullPointerException  if track is null
-     * @throws IllegalStateException if the track instance was not obtained from LuckPerms.
-     * @deprecated in favour of {@link TrackManager#deleteTrack(Track)}
-     */
-    @Deprecated
-    @NonNull CompletableFuture<Boolean> deleteTrack(@NonNull Track track);
-
-    /**
-     * Saves UUID caching data to the global cache
-     *
-     * @param username the users username
-     * @param uuid     the users mojang unique id
-     * @return true if the operation completed successfully.
-     * @throws NullPointerException     if either parameters are null
-     * @throws IllegalArgumentException if the username is invalid
-     * @deprecated in favour of {@link UserManager#savePlayerData(UUID, String)}
-     */
-    @NonNull CompletableFuture<Boolean> saveUUIDData(@NonNull String username, @NonNull UUID uuid);
-
-    /**
-     * Gets a UUID from a username
-     *
-     * @param username the corresponding username
-     * @return a uuid object, could be null
-     * @throws NullPointerException     if either parameters are null
-     * @throws IllegalArgumentException if the username is invalid
-     * @deprecated in favour of {@link UserManager#lookupUuid(String)}
-     */
-    @NonNull CompletableFuture<UUID> getUUID(@NonNull String username);
-
-    /**
-     * Gets a username from a UUID
-     *
-     * @param uuid the corresponding uuid
-     * @return a name string, could be null
-     * @throws NullPointerException if either parameters are null
-     * @since 2.17
-     * @deprecated in favour of {@link UserManager#lookupUsername(UUID)}
-     */
-    @NonNull @Deprecated CompletableFuture<String> getName(@NonNull UUID uuid);
-
-    /**
-     * Returns an executor which will run all passed runnables on the
-     * main server thread.
-     *
-     * <p>This method is deprecated as plugins should create and use their own
-     * executor instances.</p>
-     *
-     * @return an executor instance
-     * @deprecated as plugins should create their own executors
-     */
-    @NonNull @Deprecated Executor getSyncExecutor();
-
-    /**
-     * Returns an executor which will run all passed runnables asynchronously
-     * using the platforms scheduler and thread pools.
-     *
-     * <p>This method is deprecated as plugins should create and use their own
-     * executor instances.</p>
-     *
-     * @return an executor instance
-     * @deprecated as plugins should create their own executors
-     */
-    @NonNull @Deprecated Executor getAsyncExecutor();
-
-}

api/src/main/java/me/lucko/luckperms/api/caching/CachedData.java

@@ -1,422 +0,0 @@
-/*
- * This file is part of LuckPerms, licensed under the MIT License.
- *
- *  Copyright (c) lucko (Luck) <luck@lucko.me>
- *  Copyright (c) contributors
- *
- *  Permission is hereby granted, free of charge, to any person obtaining a copy
- *  of this software and associated documentation files (the "Software"), to deal
- *  in the Software without restriction, including without limitation the rights
- *  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- *  copies of the Software, and to permit persons to whom the Software is
- *  furnished to do so, subject to the following conditions:
- *
- *  The above copyright notice and this permission notice shall be included in all
- *  copies or substantial portions of the Software.
- *
- *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- *  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- *  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- *  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- *  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- *  SOFTWARE.
- */
-
-package me.lucko.luckperms.api.caching;
-
-import me.lucko.luckperms.api.Contexts;
-import me.lucko.luckperms.api.PermissionHolder;
-
-import org.checkerframework.checker.nullness.qual.NonNull;
-
-import java.util.Objects;
-import java.util.Set;
-import java.util.concurrent.CompletableFuture;
-
-/**
- * Holds cached permission and meta lookup data for a {@link PermissionHolder}.
- *
- * <p>All calls will account for inheritance, as well as any default data
- * provided by the platform. This calls are heavily cached and are therefore
- * fast.</p>
- *
- * <p>For meta, both methods accepting {@link Contexts} and {@link MetaContexts}
- * are provided. The only difference is that the latter allows you to define
- * how the meta stack should be structured internally. Where {@link Contexts}
- * are passed, the values from the configuration are used.</p>
- *
- * @since 4.0
- */
-public interface CachedData {
-
-    /**
-     * Gets PermissionData from the cache, given a specified context.
-     *
-     * @param contexts the contexts to get the permission data in
-     * @return a permission data instance
-     * @throws NullPointerException if contexts is null
-     */
-    @NonNull PermissionData getPermissionData(@NonNull Contexts contexts);
-
-    /**
-     * Gets MetaData from the cache, given a specified context.
-     *
-     * @param contexts the contexts to get the permission data in
-     * @return a meta data instance
-     * @throws NullPointerException if contexts is null
-     * @since 3.2
-     */
-    @NonNull MetaData getMetaData(@NonNull MetaContexts contexts);
-
-    /**
-     * Gets MetaData from the cache, given a specified context.
-     *
-     * @param contexts the contexts to get the permission data in
-     * @return a meta data instance
-     * @throws NullPointerException if contexts is null
-     */
-    @NonNull MetaData getMetaData(@NonNull Contexts contexts);
-
-    /**
-     * Calculates permission data, bypassing the cache.
-     *
-     * <p>The result of this operation is calculated each time the method is called.
-     * The result is not added to the internal cache.</p>
-     *
-     * <p>It is therefore highly recommended to use {@link #getPermissionData(Contexts)} instead.</p>
-     *
-     * <p>The use cases of this method are more around constructing one-time
-     * instances of {@link PermissionData}, without adding the result to the cache.</p>
-     *
-     * @param contexts the contexts to get permission data in
-     * @return a permission data instance
-     * @throws NullPointerException if contexts is null
-     */
-    @NonNull PermissionData calculatePermissions(@NonNull Contexts contexts);
-
-    /**
-     * Calculates meta data, bypassing the cache.
-     *
-     * <p>The result of this operation is calculated each time the method is called.
-     * The result is not added to the internal cache.</p>
-     *
-     * <p>It is therefore highly recommended to use {@link #getMetaData(MetaContexts)} instead.</p>
-     *
-     * <p>The use cases of this method are more around constructing one-time
-     * instances of {@link MetaData}, without adding the result to the cache.</p>
-     *
-     * @param contexts the contexts to get meta data in
-     * @return a meta data instance
-     * @throws NullPointerException if contexts is null
-     * @since 3.2
-     */
-    @NonNull MetaData calculateMeta(@NonNull MetaContexts contexts);
-
-    /**
-     * Calculates meta data, bypassing the cache.
-     *
-     * <p>The result of this operation is calculated each time the method is called.
-     * The result is not added to the internal cache.</p>
-     *
-     * <p>It is therefore highly recommended to use {@link #getMetaData(Contexts)} instead.</p>
-     *
-     * <p>The use cases of this method are more around constructing one-time
-     * instances of {@link MetaData}, without adding the result to the cache.</p>
-     *
-     * @param contexts the contexts to get meta data in
-     * @return a meta data instance
-     * @throws NullPointerException if contexts is null
-     */
-    @NonNull MetaData calculateMeta(@NonNull Contexts contexts);
-
-    /**
-     * (Re)calculates permission data for a given context.
-     *
-     * <p>This method returns immediately in all cases. The (re)calculation is
-     * performed asynchronously and applied to the cache in the background.</p>
-     *
-     * <p>If there was a previous {@link PermissionData} instance associated with
-     * the given {@link Contexts}, then that instance will continue to be returned by
-     * {@link #getPermissionData(Contexts)} until the recalculation is completed.</p>
-     *
-     * <p>If there was no value calculated and cached prior to the call of this
-     * method, then one will be calculated.</p>
-     *
-     * @param contexts the contexts to recalculate in.
-     * @throws NullPointerException if contexts is null
-     */
-    void recalculatePermissions(@NonNull Contexts contexts);
-
-    /**
-     * (Re)calculates meta data for a given context.
-     *
-     * <p>This method returns immediately in all cases. The (re)calculation is
-     * performed asynchronously and applied to the cache in the background.</p>
-     *
-     * <p>If there was a previous {@link MetaData} instance associated with
-     * the given {@link MetaContexts}, then that instance will continue to be returned by
-     * {@link #getMetaData(MetaContexts)} until the recalculation is completed.</p>
-     *
-     * <p>If there was no value calculated and cached prior to the call of this
-     * method, then one will be calculated.</p>
-     *
-     * @param contexts the contexts to recalculate in.
-     * @throws NullPointerException if contexts is null
-     * @since 3.2
-     */
-    void recalculateMeta(@NonNull MetaContexts contexts);
-
-    /**
-     * (Re)calculates meta data for a given context.
-     *
-     * <p>This method returns immediately in all cases. The (re)calculation is
-     * performed asynchronously and applied to the cache in the background.</p>
-     *
-     * <p>If there was a previous {@link MetaData} instance associated with
-     * the given {@link Contexts}, then that instance will continue to be returned by
-     * {@link #getMetaData(Contexts)} until the recalculation is completed.</p>
-     *
-     * <p>If there was no value calculated and cached prior to the call of this
-     * method, then one will be calculated.</p>
-     *
-     * @param contexts the contexts to recalculate in.
-     * @throws NullPointerException if contexts is null
-     */
-    void recalculateMeta(@NonNull Contexts contexts);
-
-    /**
-     * (Re)loads permission data for a given context.
-     *
-     * <p>Unlike {@link #recalculatePermissions(Contexts)}, this method immediately
-     * invalidates any previous {@link PermissionData} values contained within the cache,
-     * and then schedules a task to reload a new {@link PermissionData} instance to
-     * replace the one which was invalidated.</p>
-     *
-     * <p>The invalidation happens immediately during the execution of this method.
-     * The result of the re-computation encapsulated by the future.</p>
-     *
-     * <p>Subsequent calls to {@link #getPermissionData(Contexts)} will block until
-     * the result of this operation is complete.</p>
-     *
-     * <p>If there was no value calculated and cached prior to the call of this
-     * method, then one will be calculated.</p>
-     *
-     * <p>This method returns a Future so users can optionally choose to wait
-     * until the recalculation has been performed.</p>
-     *
-     * @param contexts the contexts to reload in.
-     * @return a future
-     * @throws NullPointerException if contexts is null
-     * @since 4.0
-     */
-    @NonNull CompletableFuture<? extends PermissionData> reloadPermissions(@NonNull Contexts contexts);
-
-    /**
-     * (Re)loads meta data for a given context.
-     *
-     * <p>Unlike {@link #recalculateMeta(MetaContexts)}, this method immediately
-     * invalidates any previous {@link MetaData} values contained within the cache,
-     * and then schedules a task to reload a new {@link MetaData} instance to
-     * replace the one which was invalidated.</p>
-     *
-     * <p>The invalidation happens immediately during the execution of this method.
-     * The result of the re-computation encapsulated by the future.</p>
-     *
-     * <p>Subsequent calls to {@link #getMetaData(MetaContexts)} will block until
-     * the result of this operation is complete.</p>
-     *
-     * <p>If there was no value calculated and cached prior to the call of this
-     * method, then one will be calculated.</p>
-     *
-     * <p>This method returns a Future so users can optionally choose to wait
-     * until the recalculation has been performed.</p>
-     *
-     * @param contexts the contexts to reload in.
-     * @return a future
-     * @throws NullPointerException if contexts is null
-     * @since 4.0
-     */
-    @NonNull CompletableFuture<? extends MetaData> reloadMeta(@NonNull MetaContexts contexts);
-
-    /**
-     * (Re)loads meta data for a given context.
-     *
-     * <p>Unlike {@link #recalculateMeta(Contexts)}, this method immediately
-     * invalidates any previous {@link MetaData} values contained within the cache,
-     * and then schedules a task to reload a new {@link MetaData} instance to
-     * replace the one which was invalidated.</p>
-     *
-     * <p>The invalidation happens immediately during the execution of this method.
-     * The result of the re-computation encapsulated by the future.</p>
-     *
-     * <p>Subsequent calls to {@link #getMetaData(Contexts)} will block until
-     * the result of this operation is complete.</p>
-     *
-     * <p>If there was no value calculated and cached prior to the call of this
-     * method, then one will be calculated.</p>
-     *
-     * <p>This method returns a Future so users can optionally choose to wait
-     * until the recalculation has been performed.</p>
-     *
-     * @param contexts the contexts to reload in.
-     * @return a future
-     * @throws NullPointerException if contexts is null
-     * @since 4.0
-     */
-    @NonNull CompletableFuture<? extends MetaData> reloadMeta(@NonNull Contexts contexts);
-
-    /**
-     * Recalculates permission data for all known contexts.
-     *
-     * <p>This method returns immediately. The recalculation is performed
-     * asynchronously and applied to the cache in the background.</p>
-     *
-     * <p>The previous {@link PermissionData} instances will continue to be returned
-     * by {@link #getPermissionData(Contexts)} until the recalculation is completed.</p>
-     */
-    void recalculatePermissions();
-
-    /**
-     * Recalculates meta data for all known contexts.
-     *
-     * <p>This method returns immediately. The recalculation is performed
-     * asynchronously and applied to the cache in the background.</p>
-     *
-     * <p>The previous {@link MetaData} instances will continue to be returned
-     * by {@link #getMetaData(MetaContexts)} and {@link #getMetaData(Contexts)}
-     * until the recalculation is completed.</p>
-     */
-    void recalculateMeta();
-
-    /**
-     * Reloads permission data for all known contexts.
-     *
-     * <p>Unlike {@link #recalculatePermissions()}, this method immediately
-     * invalidates all previous {@link PermissionData} values contained within the cache,
-     * and then schedules a task to reload a new {@link PermissionData} instances to
-     * replace the ones which were invalidated.</p>
-     *
-     * <p>The invalidation happens immediately during the execution of this method.
-     * The result of the re-computation encapsulated by the future.</p>
-     *
-     * <p>Subsequent calls to {@link #getPermissionData(Contexts)} will block until
-     * the result of this operation is complete.</p>
-     *
-     * <p>This method returns a Future so users can optionally choose to wait
-     * until the recalculation has been performed.</p>
-     *
-     * @return a future
-     * @since 4.0
-     */
-    @NonNull CompletableFuture<Void> reloadPermissions();
-
-    /**
-     * Reloads meta data for all known contexts.
-     *
-     * <p>Unlike {@link #recalculateMeta()}, this method immediately
-     * invalidates all previous {@link MetaData} values contained within the cache,
-     * and then schedules a task to reload a new {@link MetaData} instances to
-     * replace the ones which were invalidated.</p>
-     *
-     * <p>The invalidation happens immediately during the execution of this method.
-     * The result of the re-computation encapsulated by the future.</p>
-     *
-     * <p>Subsequent calls to {@link #getMetaData(MetaContexts)} and
-     * {@link #getMetaData(Contexts)} will block until the result of this operation
-     * is complete.</p>
-     *
-     * <p>This method returns a Future so users can optionally choose to wait
-     * until the recalculation has been performed.</p>
-     *
-     * @return a future
-     * @since 4.0
-     */
-    @NonNull CompletableFuture<Void> reloadMeta();
-
-    /**
-     * Pre-calculates and caches {@link PermissionData} and {@link MetaData}
-     * instances for the given contexts.
-     *
-     * <p>If the cache already contains a value for the given context,
-     * no action is taken.</p>
-     *
-     * <p>This method blocks until the calculation is completed.</p>
-     *
-     * @param contexts a set of contexts
-     * @throws NullPointerException if contexts is null
-     */
-    default void preCalculate(@NonNull Set<Contexts> contexts) {
-        contexts.forEach(this::preCalculate);
-    }
-
-    /**
-     * Pre-calculates and caches {@link PermissionData} and {@link MetaData}
-     * instances for a given context.
-     *
-     * <p>If the cache already contains a value for the given context,
-     * no action is taken.</p>
-     *
-     * <p>This method blocks until the calculation is completed.</p>
-     *
-     * @param contexts the contexts to pre-calculate for
-     * @throws NullPointerException if contexts is null
-     */
-    default void preCalculate(@NonNull Contexts contexts) {
-        Objects.requireNonNull(contexts, "contexts");
-
-        // pre-calculate just by requesting the data from this cache.
-        // if the data isn't already loaded, it will be calculated.
-        getPermissionData(contexts);
-        getMetaData(contexts);
-    }
-
-    /**
-     * Invalidates any cached {@link PermissionData} instances mapped to the given
-     * {@link Contexts}.
-     *
-     * @param contexts the contexts to invalidate for
-     * @since 4.0
-     */
-    void invalidatePermissions(@NonNull Contexts contexts);
-
-    /**
-     * Invalidates any cached {@link MetaData} instances mapped to the given
-     * {@link MetaContexts}.
-     *
-     * @param contexts the contexts to invalidate for
-     * @since 4.0
-     */
-    void invalidateMeta(@NonNull MetaContexts contexts);
-
-    /**
-     * Invalidates any cached {@link MetaData} instances mapped to the given
-     * {@link Contexts}.
-     *
-     * @param contexts the contexts to invalidate for
-     * @since 4.0
-     */
-    void invalidateMeta(@NonNull Contexts contexts);
-
-    /**
-     * Invalidates all cached {@link PermissionData} instances.
-     *
-     * @since 4.2
-     */
-    void invalidatePermissions();
-
-    /**
-     * Invalidates all cached {@link MetaData} instances.
-     *
-     * @since 4.2
-     */
-    void invalidateMeta();
-
-    /**
-     * Invalidates all of the underlying Permission calculators.
-     *
-     * <p>Can be called to allow for an update in defaults.</p>
-     */
-    void invalidatePermissionCalculators();
-
-}

api/src/main/java/me/lucko/luckperms/api/caching/GroupData.java

@@ -1,45 +0,0 @@
-/*
- * This file is part of LuckPerms, licensed under the MIT License.
- *
- *  Copyright (c) lucko (Luck) <luck@lucko.me>
- *  Copyright (c) contributors
- *
- *  Permission is hereby granted, free of charge, to any person obtaining a copy
- *  of this software and associated documentation files (the "Software"), to deal
- *  in the Software without restriction, including without limitation the rights
- *  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- *  copies of the Software, and to permit persons to whom the Software is
- *  furnished to do so, subject to the following conditions:
- *
- *  The above copyright notice and this permission notice shall be included in all
- *  copies or substantial portions of the Software.
- *
- *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- *  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- *  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- *  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- *  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- *  SOFTWARE.
- */
-
-package me.lucko.luckperms.api.caching;
-
-import me.lucko.luckperms.api.Contexts;
-import me.lucko.luckperms.api.Group;
-
-/**
- * Holds cached permission and meta lookup data for a {@link Group}.
- *
- * <p>All calls will account for inheritance, as well as any default data provided
- * by the platform. This calls are heavily cached and are therefore fast.</p>
- *
- * <p>For meta, both methods accepting {@link Contexts} and {@link MetaContexts} are provided. The only difference is that
- * the latter allows you to define how the meta stack should be structured internally. Where {@link Contexts} are passed, the
- * values from the configuration are used.</p>
- *
- * @since 4.0
- */
-public interface GroupData extends CachedData {
-
-}

api/src/main/java/me/lucko/luckperms/api/caching/MetaContexts.java

@@ -1,117 +0,0 @@
-/*
- * This file is part of LuckPerms, licensed under the MIT License.
- *
- *  Copyright (c) lucko (Luck) <luck@lucko.me>
- *  Copyright (c) contributors
- *
- *  Permission is hereby granted, free of charge, to any person obtaining a copy
- *  of this software and associated documentation files (the "Software"), to deal
- *  in the Software without restriction, including without limitation the rights
- *  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- *  copies of the Software, and to permit persons to whom the Software is
- *  furnished to do so, subject to the following conditions:
- *
- *  The above copyright notice and this permission notice shall be included in all
- *  copies or substantial portions of the Software.
- *
- *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- *  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- *  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- *  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- *  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- *  SOFTWARE.
- */
-
-package me.lucko.luckperms.api.caching;
-
-import me.lucko.luckperms.api.Contexts;
-import me.lucko.luckperms.api.metastacking.MetaStackDefinition;
-
-import org.checkerframework.checker.nullness.qual.NonNull;
-
-import java.util.Objects;
-
-/**
- * Encapsulates the options and settings for a meta lookup.
- *
- * <p>Consists of a standard {@link Contexts} element, plus options to define how
- * the meta stack should be constructed.</p>
- *
- * @since 3.2
- */
-public final class MetaContexts {
-
-    /**
-     * Creates a new meta contexts instance
-     *
-     * @param contexts              the standard contexts for the query
-     * @param prefixStackDefinition the prefix stack definition to be used
-     * @param suffixStackDefinition the suffix stack definition to be used
-     * @return the new instance
-     */
-    public static MetaContexts of(@NonNull Contexts contexts, @NonNull MetaStackDefinition prefixStackDefinition, @NonNull MetaStackDefinition suffixStackDefinition) {
-        return new MetaContexts(contexts, prefixStackDefinition, suffixStackDefinition);
-    }
-
-    private final Contexts contexts;
-    private final MetaStackDefinition prefixStackDefinition;
-    private final MetaStackDefinition suffixStackDefinition;
-
-    // cache hashcode - this class is immutable, and is used as an index in the permission cache.
-    private final int hashCode;
-
-    /**
-     * Creates a new meta contexts instance
-     *
-     * @param contexts              the standard contexts for the query
-     * @param prefixStackDefinition the prefix stack definition to be used
-     * @param suffixStackDefinition the suffix stack definition to be used
-     */
-    public MetaContexts(@NonNull Contexts contexts, @NonNull MetaStackDefinition prefixStackDefinition, @NonNull MetaStackDefinition suffixStackDefinition) {
-        this.contexts = Objects.requireNonNull(contexts, "contexts");
-        this.prefixStackDefinition = Objects.requireNonNull(prefixStackDefinition, "prefixStackDefinition");
-        this.suffixStackDefinition = Objects.requireNonNull(suffixStackDefinition, "suffixStackDefinition");
-        this.hashCode = calculateHashCode();
-    }
-
-    public @NonNull Contexts getContexts() {
-        return this.contexts;
-    }
-
-    public @NonNull MetaStackDefinition getPrefixStackDefinition() {
-        return this.prefixStackDefinition;
-    }
-
-    public @NonNull MetaStackDefinition getSuffixStackDefinition() {
-        return this.suffixStackDefinition;
-    }
-
-    @Override
-    public @NonNull String toString() {
-        return "MetaContexts(" +
-                "contexts=" + this.getContexts() + ", " +
-                "prefixStackDefinition=" + this.getPrefixStackDefinition() + ", " +
-                "suffixStackDefinition=" + this.getSuffixStackDefinition() +
-                ")";
-    }
-
-    @Override
-    public boolean equals(Object o) {
-        if (o == this) return true;
-        if (!(o instanceof MetaContexts)) return false;
-        final MetaContexts that = (MetaContexts) o;
-        return this.contexts.equals(that.contexts) &&
-                this.prefixStackDefinition.equals(that.prefixStackDefinition) &&
-                this.suffixStackDefinition.equals(that.suffixStackDefinition);
-    }
-
-    private int calculateHashCode() {
-        return Objects.hash(this.contexts, this.prefixStackDefinition, this.suffixStackDefinition);
-    }
-
-    @Override
-    public int hashCode() {
-        return this.hashCode;
-    }
-}

api/src/main/java/me/lucko/luckperms/api/caching/MetaData.java

@@ -1,122 +0,0 @@
-/*
- * This file is part of LuckPerms, licensed under the MIT License.
- *
- *  Copyright (c) lucko (Luck) <luck@lucko.me>
- *  Copyright (c) contributors
- *
- *  Permission is hereby granted, free of charge, to any person obtaining a copy
- *  of this software and associated documentation files (the "Software"), to deal
- *  in the Software without restriction, including without limitation the rights
- *  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- *  copies of the Software, and to permit persons to whom the Software is
- *  furnished to do so, subject to the following conditions:
- *
- *  The above copyright notice and this permission notice shall be included in all
- *  copies or substantial portions of the Software.
- *
- *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- *  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- *  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- *  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- *  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- *  SOFTWARE.
- */
-
-package me.lucko.luckperms.api.caching;
-
-import com.google.common.collect.ListMultimap;
-
-import me.lucko.luckperms.api.metastacking.MetaStackDefinition;
-
-import org.checkerframework.checker.nullness.qual.NonNull;
-import org.checkerframework.checker.nullness.qual.Nullable;
-
-import java.util.Map;
-import java.util.SortedMap;
-
-/**
- * Holds cached meta lookup data for a specific set of contexts.
- *
- * @since 2.13
- */
-public interface MetaData extends CachedDataContainer {
-
-    /**
-     * Gets the contexts this container is holding data for.
-     *
-     * @return the contexts this container is caching
-     */
-    @NonNull MetaContexts getMetaContexts();
-
-    /**
-     * Gets an immutable copy of the meta this user has.
-     *
-     * <p>A list multimap is used because when inherited values are included, each key can be
-     * mapped to multiple values.</p>
-     *
-     * <p>The first value to be accumulated (and used to represent the key in {@link #getMeta()} is at index 0
-     * in the list. Any additional values are stored in order of accumulation.</p>
-     *
-     * @return an immutable multimap of meta
-     * @since 3.3
-     */
-    @NonNull ListMultimap<String, String> getMetaMultimap();
-
-    /**
-     * Gets an immutable copy of the meta this user has.
-     *
-     * <p>This map is formed by taking the entries in {@link #getMetaMultimap()}, and mapping each key
-     * to the value at index 0 in the corresponding list.</p>
-     *
-     * @return an immutable map of meta
-     */
-    @NonNull Map<String, String> getMeta();
-
-    /**
-     * Gets an immutable sorted map of all of the prefixes the user has, whereby the first value is the highest priority
-     * prefix.
-     *
-     * @return a sorted map of prefixes
-     */
-    @NonNull SortedMap<Integer, String> getPrefixes();
-
-    /**
-     * Gets an immutable sorted map of all of the suffixes the user has, whereby the first value is the highest priority
-     * suffix.
-     *
-     * @return a sorted map of suffixes
-     */
-    @NonNull SortedMap<Integer, String> getSuffixes();
-
-    /**
-     * Gets the user's highest priority prefix, or null if the user has no prefixes
-     *
-     * @return a prefix string, or null
-     */
-    @Nullable String getPrefix();
-
-    /**
-     * Gets the user's highest priority suffix, or null if the user has no suffixes
-     *
-     * @return a suffix string, or null
-     */
-    @Nullable String getSuffix();
-
-    /**
-     * Gets the definition used for the prefix stack
-     *
-     * @return the definition used for the prefix stack
-     * @since 3.2
-     */
-    @NonNull MetaStackDefinition getPrefixStackDefinition();
-
-    /**
-     * Gets the definition used for the suffix stack
-     *
-     * @return the definition used for the suffix stack
-     * @since 3.2
-     */
-    @NonNull MetaStackDefinition getSuffixStackDefinition();
-
-}

api/src/main/java/me/lucko/luckperms/api/context/ImmutableContextSet.java

@@ -1,376 +0,0 @@
-/*
- * This file is part of LuckPerms, licensed under the MIT License.
- *
- *  Copyright (c) lucko (Luck) <luck@lucko.me>
- *  Copyright (c) contributors
- *
- *  Permission is hereby granted, free of charge, to any person obtaining a copy
- *  of this software and associated documentation files (the "Software"), to deal
- *  in the Software without restriction, including without limitation the rights
- *  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- *  copies of the Software, and to permit persons to whom the Software is
- *  furnished to do so, subject to the following conditions:
- *
- *  The above copyright notice and this permission notice shall be included in all
- *  copies or substantial portions of the Software.
- *
- *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- *  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- *  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- *  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- *  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- *  SOFTWARE.
- */
-
-package me.lucko.luckperms.api.context;
-
-import com.google.common.collect.ImmutableMap;
-import com.google.common.collect.ImmutableSetMultimap;
-import com.google.common.collect.Multimap;
-import com.google.common.collect.SetMultimap;
-
-import org.checkerframework.checker.nullness.qual.NonNull;
-
-import java.util.Iterator;
-import java.util.Map;
-import java.util.Objects;
-import java.util.Set;
-import java.util.Spliterator;
-
-/**
- * An immutable implementation of {@link ContextSet}.
- *
- * @since 2.16
- */
-public final class ImmutableContextSet extends AbstractContextSet implements ContextSet {
-    private static final ImmutableContextSet EMPTY = new ImmutableContextSet(ImmutableSetMultimap.of());
-
-    /**
-     * Creates an {@link ImmutableContextSet.Builder}.
-     *
-     * @return a new ImmutableContextSet builder
-     * @since 4.1
-     */
-    public static @NonNull Builder builder() {
-        return new Builder();
-    }
-
-    /**
-     * Creates an {@link ImmutableContextSet} from a context pair.
-     *
-     * @param key   the key
-     * @param value the value
-     * @return a new ImmutableContextSet containing one context pair
-     * @throws NullPointerException if key or value is null
-     */
-    public static @NonNull ImmutableContextSet singleton(@NonNull String key, @NonNull String value) {
-        return new ImmutableContextSet(ImmutableSetMultimap.of(sanitizeKey(key), sanitizeValue(value)));
-    }
-
-    /**
-     * Creates an {@link ImmutableContextSet} from two context pairs.
-     *
-     * @param key1 the first key
-     * @param value1 the first value
-     * @param key2 the second key
-     * @param value2 the second value
-     * @return a new ImmutableContextSet containing the two pairs
-     * @throws NullPointerException if any of the keys or values are null
-     * @since 3.1
-     */
-    public static @NonNull ImmutableContextSet of(@NonNull String key1, @NonNull String value1, @NonNull String key2, @NonNull String value2) {
-        return new ImmutableContextSet(ImmutableSetMultimap.of(
-                sanitizeKey(key1),
-                sanitizeValue(value1),
-                sanitizeKey(key2),
-                sanitizeValue(value2)
-        ));
-    }
-
-    /**
-     * Creates an {@link ImmutableContextSet} from an existing {@link Iterable} of {@link Map.Entry}s.
-     *
-     * @param iterable the iterable to copy from
-     * @return a new ImmutableContextSet representing the pairs in the iterable
-     * @throws NullPointerException if the iterable is null
-     */
-    public static @NonNull ImmutableContextSet fromEntries(@NonNull Iterable<? extends Map.Entry<String, String>> iterable) {
-        Objects.requireNonNull(iterable, "iterable");
-        ImmutableContextSet.Builder builder = builder();
-        for (Map.Entry<String, String> entry : iterable) {
-            builder.add(entry);
-        }
-        return builder.build();
-    }
-
-    /**
-     * Creates an {@link ImmutableContextSet} from an existing {@link Map}.
-     *
-     * @param map the map to copy from
-     * @return a new ImmutableContextSet representing the pairs from the map
-     * @throws NullPointerException if the map is null
-     */
-    public static @NonNull ImmutableContextSet fromMap(@NonNull Map<String, String> map) {
-        return fromEntries(Objects.requireNonNull(map, "map").entrySet());
-    }
-
-    /**
-     * Creates an {@link ImmutableContextSet} from an existing {@link Multimap}.
-     *
-     * @param multimap the multimap to copy from
-     * @return a new ImmutableContextSet representing the pairs in the multimap
-     * @throws NullPointerException if the multimap is null
-     * @since 2.16
-     */
-    public static @NonNull ImmutableContextSet fromMultimap(@NonNull Multimap<String, String> multimap) {
-        return fromEntries(Objects.requireNonNull(multimap, "multimap").entries());
-    }
-
-    /**
-     * Creates an new {@link ImmutableContextSet} from an existing {@link Set}.
-     *
-     * <p>Only really useful for converting between mutable and immutable types.</p>
-     *
-     * @param contextSet the context set to copy from
-     * @return a new ImmutableContextSet with the same content and the one provided
-     * @throws NullPointerException if contextSet is null
-     */
-    public static @NonNull ImmutableContextSet fromSet(@NonNull ContextSet contextSet) {
-        return Objects.requireNonNull(contextSet, "contextSet").makeImmutable();
-    }
-
-    /**
-     * Returns an empty {@link ImmutableContextSet}.
-     *
-     * @return an empty ImmutableContextSet
-     */
-    public static @NonNull ImmutableContextSet empty() {
-        return EMPTY;
-    }
-
-    private final ImmutableSetMultimap<String, String> map;
-    private final int hashCode;
-
-    ImmutableContextSet(ImmutableSetMultimap<String, String> contexts) {
-        this.map = contexts;
-        this.hashCode = this.map.hashCode();
-    }
-
-    @Override
-    protected SetMultimap<String, String> backing() {
-        return this.map;
-    }
-
-    @Override
-    protected void copyTo(SetMultimap<String, String> other) {
-        other.putAll(this.map);
-    }
-
-    @Override
-    public boolean isImmutable() {
-        return true;
-    }
-
-    @Deprecated
-    @Override // This set is already immutable!
-    public @NonNull ImmutableContextSet makeImmutable() {
-        return this;
-    }
-
-    @Override
-    public @NonNull MutableContextSet mutableCopy() {
-        return MutableContextSet.fromSet(this);
-    }
-
-    @Override
-    public @NonNull Set<Map.Entry<String, String>> toSet() {
-        return this.map.entries();
-    }
-
-    @Deprecated
-    @Override
-    public @NonNull Map<String, String> toMap() {
-        ImmutableMap.Builder<String, String> m = ImmutableMap.builder();
-        for (Map.Entry<String, String> e : this.map.entries()) {
-            m.put(e.getKey(), e.getValue());
-        }
-        return m.build();
-    }
-
-    @Override
-    public @NonNull Multimap<String, String> toMultimap() {
-        return this.map;
-    }
-
-    @Override
-    public @NonNull Iterator<Map.Entry<String, String>> iterator() {
-        return this.map.entries().iterator();
-    }
-
-    @Override
-    public Spliterator<Map.Entry<String, String>> spliterator() {
-        return this.map.entries().spliterator();
-    }
-
-    @Override
-    public boolean equals(Object o) {
-        if (o == this) return true;
-        if (!(o instanceof ContextSet)) return false;
-        final ContextSet that = (ContextSet) o;
-
-        // fast(er) path for ImmutableContextSet comparisons
-        if (that instanceof ImmutableContextSet) {
-            ImmutableContextSet immutableThat = (ImmutableContextSet) that;
-            if (this.hashCode != immutableThat.hashCode) return false;
-        }
-
-        final Multimap<String, String> thatBacking;
-        if (that instanceof AbstractContextSet) {
-            thatBacking = ((AbstractContextSet) that).backing();
-        } else {
-            thatBacking = that.toMultimap();
-        }
-
-        return backing().equals(thatBacking);
-    }
-
-    @Override
-    public int hashCode() {
-        return this.hashCode;
-    }
-
-    @Override
-    public String toString() {
-        return "ImmutableContextSet(contexts=" + this.map + ")";
-    }
-
-    /**
-     * A builder for {@link ImmutableContextSet}.
-     *
-     * @since 4.1
-     */
-    public static final class Builder {
-        private ImmutableSetMultimap.Builder<String, String> builder;
-
-        private Builder() {
-
-        }
-
-        private synchronized ImmutableSetMultimap.Builder<String, String> builder() {
-            if (this.builder == null) {
-                this.builder = ImmutableSetMultimap.builder();
-            }
-            return this.builder;
-        }
-
-        private void put(String key, String value) {
-            builder().put(key, value);
-        }
-
-        /**
-         * Adds a context to the set.
-         *
-         * @param key   the key to add
-         * @param value the value to add
-         * @return the builder
-         * @throws NullPointerException if the key or value is null
-         * @see MutableContextSet#add(String, String)
-         */
-        public @NonNull Builder add(@NonNull String key, @NonNull String value) {
-            put(sanitizeKey(key), sanitizeValue(value));
-            return this;
-        }
-
-        /**
-         * Adds a context to the set.
-         *
-         * @param entry the entry to add
-         * @return the builder
-         * @throws NullPointerException if the entry is null
-         * @see MutableContextSet#add(Map.Entry)
-         */
-        public @NonNull Builder add(Map.@NonNull Entry<String, String> entry) {
-            Objects.requireNonNull(entry, "entry");
-            add(entry.getKey(), entry.getValue());
-            return this;
-        }
-
-        /**
-         * Adds the contexts contained in the given {@link Iterable} to the set.
-         *
-         * @param iterable an iterable of key value context pairs
-         * @return the builder
-         * @throws NullPointerException if iterable is null
-         * @see MutableContextSet#addAll(Iterable)
-         */
-        public @NonNull Builder addAll(@NonNull Iterable<? extends Map.Entry<String, String>> iterable) {
-            for (Map.Entry<String, String> e : Objects.requireNonNull(iterable, "iterable")) {
-                add(e);
-            }
-            return this;
-        }
-
-        /**
-         * Adds the contexts contained in the given {@link Map} to the set.
-         *
-         * @param map the map to add from
-         * @return the builder
-         * @throws NullPointerException if the map is null
-         * @see MutableContextSet#addAll(Map)
-         */
-        public @NonNull Builder addAll(@NonNull Map<String, String> map) {
-            addAll(Objects.requireNonNull(map, "map").entrySet());
-            return this;
-        }
-
-        /**
-         * Adds the contexts contained in the given {@link Multimap} to the set.
-         *
-         * @param multimap the multimap to add from
-         * @return the builder
-         * @throws NullPointerException if the map is null
-         * @since 3.4
-         * @see MutableContextSet#addAll(Multimap)
-         */
-        public @NonNull Builder addAll(@NonNull Multimap<String, String> multimap) {
-            addAll(Objects.requireNonNull(multimap, "multimap").entries());
-            return this;
-        }
-
-        /**
-         * Adds of of the contexts in another {@link ContextSet} to the set.
-         *
-         * @param contextSet the set to add from
-         * @return the builder
-         * @throws NullPointerException if the contextSet is null
-         * @see MutableContextSet#addAll(ContextSet)
-         */
-        public @NonNull Builder addAll(@NonNull ContextSet contextSet) {
-            Objects.requireNonNull(contextSet, "contextSet");
-            if (contextSet instanceof AbstractContextSet) {
-                AbstractContextSet other = ((AbstractContextSet) contextSet);
-                if (!other.isEmpty()) {
-                    builder().putAll(other.backing());
-                }
-            } else {
-                addAll(contextSet.toMultimap());
-            }
-            return this;
-        }
-
-        /**
-         * Creates a {@link ImmutableContextSet} from the values previously
-         * added to the builder.
-         *
-         * @return an {@link ImmutableContextSet} from the builder
-         */
-        public @NonNull ImmutableContextSet build() {
-            if (this.builder == null) {
-                return empty();
-            } else {
-                return new ImmutableContextSet(this.builder.build());
-            }
-        }
-    }
-}

api/src/main/java/me/lucko/luckperms/api/context/MutableContextSet.java

@@ -1,368 +0,0 @@
-/*
- * This file is part of LuckPerms, licensed under the MIT License.
- *
- *  Copyright (c) lucko (Luck) <luck@lucko.me>
- *  Copyright (c) contributors
- *
- *  Permission is hereby granted, free of charge, to any person obtaining a copy
- *  of this software and associated documentation files (the "Software"), to deal
- *  in the Software without restriction, including without limitation the rights
- *  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- *  copies of the Software, and to permit persons to whom the Software is
- *  furnished to do so, subject to the following conditions:
- *
- *  The above copyright notice and this permission notice shall be included in all
- *  copies or substantial portions of the Software.
- *
- *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- *  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- *  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- *  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- *  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- *  SOFTWARE.
- */
-
-package me.lucko.luckperms.api.context;
-
-import com.google.common.collect.HashMultimap;
-import com.google.common.collect.ImmutableMap;
-import com.google.common.collect.ImmutableSet;
-import com.google.common.collect.ImmutableSetMultimap;
-import com.google.common.collect.Multimap;
-import com.google.common.collect.Multimaps;
-import com.google.common.collect.SetMultimap;
-
-import org.checkerframework.checker.nullness.qual.NonNull;
-
-import java.util.Iterator;
-import java.util.Map;
-import java.util.Objects;
-import java.util.Set;
-import java.util.Spliterator;
-
-/**
- * A mutable implementation of {@link ContextSet}.
- *
- * @since 2.16
- */
-public final class MutableContextSet extends AbstractContextSet implements ContextSet {
-
-    /**
-     * Creates a {@link MutableContextSet} from a context pair.
-     *
-     * @param key   the key
-     * @param value the value
-     * @return a new MutableContextSet containing one context pair
-     * @throws NullPointerException if key or value is null
-     */
-    public static @NonNull MutableContextSet singleton(@NonNull String key, @NonNull String value) {
-        Objects.requireNonNull(key, "key");
-        Objects.requireNonNull(value, "value");
-        MutableContextSet set = MutableContextSet.create();
-        set.add(key, value);
-        return set;
-    }
-
-    /**
-     * Creates a {@link MutableContextSet} from two context pairs.
-     *
-     * @param key1 the first key
-     * @param value1 the first value
-     * @param key2 the second key
-     * @param value2 the second value
-     * @return a new MutableContextSet containing the two pairs
-     * @throws NullPointerException if any of the keys or values are null
-     * @since 3.1
-     */
-    public static @NonNull MutableContextSet of(@NonNull String key1, @NonNull String value1, @NonNull String key2, @NonNull String value2) {
-        Objects.requireNonNull(key1, "key1");
-        Objects.requireNonNull(value1, "value1");
-        Objects.requireNonNull(key2, "key2");
-        Objects.requireNonNull(value2, "value2");
-        MutableContextSet set = create();
-        set.add(key1, value1);
-        set.add(key2, value2);
-        return set;
-    }
-
-    /**
-     * Creates a {@link MutableContextSet} from an existing {@link Iterable} of {@link Map.Entry}s.
-     *
-     * @param iterable the iterable to copy from
-     * @return a new MutableContextSet representing the pairs in the iterable
-     * @throws NullPointerException if the iterable is null
-     */
-    public static @NonNull MutableContextSet fromEntries(@NonNull Iterable<? extends Map.Entry<String, String>> iterable) {
-        Objects.requireNonNull(iterable, "iterable");
-        MutableContextSet set = create();
-        set.addAll(iterable);
-        return set;
-    }
-
-    /**
-     * Creates a {@link MutableContextSet} from an existing {@link Map}.
-     *
-     * @param map the map to copy from
-     * @return a new MutableContextSet representing the pairs from the map
-     * @throws NullPointerException if the map is null
-     */
-    public static @NonNull MutableContextSet fromMap(@NonNull Map<String, String> map) {
-        Objects.requireNonNull(map, "map");
-        MutableContextSet set = create();
-        set.addAll(map);
-        return set;
-    }
-
-    /**
-     * Creates a {@link MutableContextSet} from an existing {@link Multimap}.
-     *
-     * @param multimap the multimap to copy from
-     * @return a new MutableContextSet representing the pairs in the multimap
-     * @throws NullPointerException if the multimap is null
-     * @since 2.16
-     */
-    public static @NonNull MutableContextSet fromMultimap(@NonNull Multimap<String, String> multimap) {
-        Objects.requireNonNull(multimap, "multimap");
-        MutableContextSet set = create();
-        set.addAll(multimap);
-        return set;
-    }
-
-    /**
-     * Creates a new {@link MutableContextSet} from an existing {@link Set}.
-     *
-     * <p>Only really useful for converting between mutable and immutable types.</p>
-     *
-     * @param contextSet the context set to copy from
-     * @return a new MutableContextSet with the same content and the one provided
-     * @throws NullPointerException if contextSet is null
-     */
-    public static @NonNull MutableContextSet fromSet(@NonNull ContextSet contextSet) {
-        Objects.requireNonNull(contextSet, "contextSet");
-
-        if (contextSet instanceof ImmutableContextSet) {
-            SetMultimap<String, String> map = ((ImmutableContextSet) contextSet).backing();
-            return new MutableContextSet(map);
-        } else if (contextSet instanceof MutableContextSet) {
-            return contextSet.mutableCopy();
-        } else {
-            MutableContextSet set = create();
-            set.addAll(contextSet);
-            return set;
-        }
-    }
-
-    /**
-     * Creates a new empty MutableContextSet.
-     *
-     * @return a new MutableContextSet
-     */
-    public static @NonNull MutableContextSet create() {
-        return new MutableContextSet();
-    }
-
-    private final SetMultimap<String, String> map;
-
-    public MutableContextSet() {
-        this.map = Multimaps.synchronizedSetMultimap(HashMultimap.create());
-    }
-
-    private MutableContextSet(SetMultimap<String, String> other) {
-        this.map = Multimaps.synchronizedSetMultimap(HashMultimap.create(other));
-    }
-
-    @Override
-    protected SetMultimap<String, String> backing() {
-        return this.map;
-    }
-
-    @Override
-    protected void copyTo(SetMultimap<String, String> other) {
-        synchronized (this.map) {
-            other.putAll(this.map);
-        }
-    }
-
-    @Override
-    public boolean isImmutable() {
-        return false;
-    }
-
-    @Override
-    public @NonNull ImmutableContextSet makeImmutable() {
-        // if the map is empty, don't create a new instance
-        if (this.map.isEmpty()) {
-            return ImmutableContextSet.empty();
-        }
-        synchronized (this.map) {
-            return new ImmutableContextSet(ImmutableSetMultimap.copyOf(this.map));
-        }
-    }
-
-    @Override
-    public @NonNull MutableContextSet mutableCopy() {
-        synchronized (this.map) {
-            return new MutableContextSet(this.map);
-        }
-    }
-
-    @Override
-    public @NonNull Set<Map.Entry<String, String>> toSet() {
-        synchronized (this.map) {
-            // map.entries() returns immutable Map.Entry instances, so we can just call copyOf
-            return ImmutableSet.copyOf(this.map.entries());
-        }
-    }
-
-    @Deprecated
-    @Override
-    public @NonNull Map<String, String> toMap() {
-        ImmutableMap.Builder<String, String> m = ImmutableMap.builder();
-        synchronized (this.map) {
-            for (Map.Entry<String, String> e : this.map.entries()) {
-                m.put(e.getKey(), e.getValue());
-            }
-        }
-        return m.build();
-    }
-
-    @Override
-    public @NonNull Multimap<String, String> toMultimap() {
-        synchronized (this.map) {
-            return ImmutableSetMultimap.copyOf(this.map);
-        }
-    }
-
-    @Override
-    public @NonNull Iterator<Map.Entry<String, String>> iterator() {
-        return toSet().iterator();
-    }
-
-    @Override
-    public Spliterator<Map.Entry<String, String>> spliterator() {
-        return toSet().spliterator();
-    }
-
-    /**
-     * Adds a context to this set.
-     *
-     * @param key   the key to add
-     * @param value the value to add
-     * @throws NullPointerException if the key or value is null
-     */
-    public void add(@NonNull String key, @NonNull String value) {
-        this.map.put(sanitizeKey(key), sanitizeValue(value));
-    }
-
-    /**
-     * Adds a context to this set.
-     *
-     * @param entry the entry to add
-     * @throws NullPointerException if the entry is null
-     */
-    public void add(Map.@NonNull Entry<String, String> entry) {
-        Objects.requireNonNull(entry, "entry");
-        add(entry.getKey(), entry.getValue());
-    }
-
-    /**
-     * Adds the contexts contained in the given {@link Iterable} to this set.
-     *
-     * @param iterable an iterable of key value context pairs
-     * @throws NullPointerException if iterable is null
-     */
-    public void addAll(@NonNull Iterable<? extends Map.Entry<String, String>> iterable) {
-        for (Map.Entry<String, String> e : Objects.requireNonNull(iterable, "iterable")) {
-            add(e);
-        }
-    }
-
-    /**
-     * Adds the contexts contained in the given {@link Map} to this set.
-     *
-     * @param map the map to add from
-     * @throws NullPointerException if the map is null
-     */
-    public void addAll(@NonNull Map<String, String> map) {
-        addAll(Objects.requireNonNull(map, "map").entrySet());
-    }
-
-    /**
-     * Adds the contexts contained in the given {@link Multimap} to this set.
-     *
-     * @param multimap the multimap to add from
-     * @throws NullPointerException if the map is null
-     * @since 3.4
-     */
-    public void addAll(@NonNull Multimap<String, String> multimap) {
-        addAll(Objects.requireNonNull(multimap, "multimap").entries());
-    }
-
-    /**
-     * Adds of of the contexts in another {@link ContextSet} to this set.
-     *
-     * @param contextSet the set to add from
-     * @throws NullPointerException if the contextSet is null
-     */
-    public void addAll(@NonNull ContextSet contextSet) {
-        Objects.requireNonNull(contextSet, "contextSet");
-        if (contextSet instanceof AbstractContextSet) {
-            AbstractContextSet other = ((AbstractContextSet) contextSet);
-            synchronized (this.map) {
-                other.copyTo(this.map);
-            }
-        } else {
-            addAll(contextSet.toMultimap());
-        }
-    }
-
-    /**
-     * Removes a context from this set.
-     *
-     * @param key   the key to remove
-     * @param value the value to remove
-     * @throws NullPointerException if the key or value is null
-     */
-    public void remove(@NonNull String key, @NonNull String value) {
-        this.map.remove(sanitizeKey(key), sanitizeValue(value));
-    }
-
-    /**
-     * Removes all contexts from this set with the given key.
-     *
-     * @param key the key to remove
-     * @throws NullPointerException if the key is null
-     */
-    public void removeAll(@NonNull String key) {
-        this.map.removeAll(sanitizeKey(key));
-    }
-
-    /**
-     * Removes all contexts from the set.
-     */
-    public void clear() {
-        this.map.clear();
-    }
-
-    @Override
-    public boolean equals(Object o) {
-        if (o == this) return true;
-        if (!(o instanceof ContextSet)) return false;
-        final ContextSet that = (ContextSet) o;
-
-        final Multimap<String, String> thatBacking;
-        if (that instanceof AbstractContextSet) {
-            thatBacking = ((AbstractContextSet) that).backing();
-        } else {
-            thatBacking = that.toMultimap();
-        }
-
-        return backing().equals(thatBacking);
-    }
-
-    @Override
-    public String toString() {
-        return "MutableContextSet(contexts=" + this.map + ")";
-    }
-}

api/src/main/java/me/lucko/luckperms/api/nodetype/NodeType.java

@@ -1,44 +0,0 @@
-/*
- * This file is part of LuckPerms, licensed under the MIT License.
- *
- *  Copyright (c) lucko (Luck) <luck@lucko.me>
- *  Copyright (c) contributors
- *
- *  Permission is hereby granted, free of charge, to any person obtaining a copy
- *  of this software and associated documentation files (the "Software"), to deal
- *  in the Software without restriction, including without limitation the rights
- *  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- *  copies of the Software, and to permit persons to whom the Software is
- *  furnished to do so, subject to the following conditions:
- *
- *  The above copyright notice and this permission notice shall be included in all
- *  copies or substantial portions of the Software.
- *
- *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- *  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- *  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- *  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- *  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- *  SOFTWARE.
- */
-
-package me.lucko.luckperms.api.nodetype;
-
-import me.lucko.luckperms.api.Node;
-
-/**
- * Superinterface for extended {@link Node} types.
- *
- * <p>The 'permission' property of a {@link Node} is also used in some cases to represent state
- * beyond a granted permission. This state is encapsulated by extra {@link NodeType} data which
- * can be obtained from this instance using {@link Node#getTypeData(NodeTypeKey)}.</p>
- *
- * <p>Type data is mapped by {@link NodeTypeKey}s, which are usually stored as static members of the
- * corresponding {@link NodeType} class under the <code>KEY</code> field.</p>
- *
- * @since 4.2
- */
-public interface NodeType {
-
-}

api/src/main/java/net/luckperms/api/LuckPerms.java

@@ -0,0 +1,259 @@
+/*
+ * This file is part of LuckPerms, licensed under the MIT License.
+ *
+ *  Copyright (c) lucko (Luck) <luck@lucko.me>
+ *  Copyright (c) contributors
+ *
+ *  Permission is hereby granted, free of charge, to any person obtaining a copy
+ *  of this software and associated documentation files (the "Software"), to deal
+ *  in the Software without restriction, including without limitation the rights
+ *  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ *  copies of the Software, and to permit persons to whom the Software is
+ *  furnished to do so, subject to the following conditions:
+ *
+ *  The above copyright notice and this permission notice shall be included in all
+ *  copies or substantial portions of the Software.
+ *
+ *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ *  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ *  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ *  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ *  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ *  SOFTWARE.
+ */
+
+package net.luckperms.api;
+
+import net.luckperms.api.actionlog.ActionLogger;
+import net.luckperms.api.context.ContextCalculator;
+import net.luckperms.api.context.ContextManager;
+import net.luckperms.api.event.EventBus;
+import net.luckperms.api.messaging.MessagingService;
+import net.luckperms.api.messenger.MessengerProvider;
+import net.luckperms.api.metastacking.MetaStackDefinition;
+import net.luckperms.api.metastacking.MetaStackElement;
+import net.luckperms.api.metastacking.MetaStackFactory;
+import net.luckperms.api.model.group.Group;
+import net.luckperms.api.model.group.GroupManager;
+import net.luckperms.api.model.user.User;
+import net.luckperms.api.model.user.UserManager;
+import net.luckperms.api.node.NodeBuilderRegistry;
+import net.luckperms.api.node.matcher.NodeMatcherFactory;
+import net.luckperms.api.platform.Platform;
+import net.luckperms.api.platform.PlayerAdapter;
+import net.luckperms.api.platform.PluginMetadata;
+import net.luckperms.api.query.QueryOptionsRegistry;
+import net.luckperms.api.track.Track;
+import net.luckperms.api.track.TrackManager;
+
+import org.checkerframework.checker.nullness.qual.NonNull;
+import org.jetbrains.annotations.ApiStatus.Internal;
+
+import java.util.Optional;
+import java.util.concurrent.CompletableFuture;
+
+/**
+ * The LuckPerms API.
+ *
+ * <p>The API allows other plugins on the server to read and modify LuckPerms
+ * data, change behaviour of the plugin, listen to certain events, and integrate
+ * LuckPerms into other plugins and systems.</p>
+ *
+ * <p>This interface represents the base of the API package. All functions are
+ * accessed via this interface.</p>
+ *
+ * <p>To start using the API, you need to obtain an instance of this interface.
+ * These are registered by the LuckPerms plugin to the platforms Services
+ * Manager. This is the preferred method for obtaining an instance.</p>
+ *
+ * <p>For ease of use, and for platforms without a Service Manager, an instance
+ * can also be obtained from the static singleton accessor in
+ * {@link LuckPermsProvider}.</p>
+ */
+public interface LuckPerms {
+
+    /**
+     * Gets the name of this server.
+     *
+     * <p>This is defined in the LuckPerms configuration file, and is used for
+     * server specific permission handling.</p>
+     *
+     * <p>The default server name is "global".</p>
+     *
+     * @return the server name
+     */
+    @NonNull String getServerName();
+
+    /**
+     * Gets the {@link UserManager}, responsible for managing
+     * {@link User} instances.
+     *
+     * <p>This manager can be used to retrieve instances of {@link User} by uuid
+     * or name, or query all loaded users.</p>
+     *
+     * @return the user manager
+     */
+    @NonNull UserManager getUserManager();
+
+    /**
+     * Gets the {@link GroupManager}, responsible for managing
+     * {@link Group} instances.
+     *
+     * <p>This manager can be used to retrieve instances of {@link Group} by
+     * name, or query all loaded groups.</p>
+     *
+     * @return the group manager
+     */
+    @NonNull GroupManager getGroupManager();
+
+    /**
+     * Gets the {@link TrackManager}, responsible for managing
+     * {@link Track} instances.
+     *
+     * <p>This manager can be used to retrieve instances of {@link Track} by
+     * name, or query all loaded tracks.</p>
+     *
+     * @return the track manager
+     */
+    @NonNull TrackManager getTrackManager();
+
+    /**
+     * Gets the {@link PlayerAdapter} instance, a utility class for adapting platform Player
+     * instances to {@link User}s.
+     *
+     * <p>The {@code playerClass} parameter must be equal to the class or interface used by the
+     * server platform to represent players.</p>
+     *
+     * <p>Specifically:</p>
+     *
+     * <p></p>
+     * <ul>
+     * <li>{@code org.bukkit.entity.Player}</li>
+     * <li>{@code net.md_5.bungee.api.connection.ProxiedPlayer}</li>
+     * <li>{@code org.spongepowered.api/entity.living.player.Player}</li>
+     * <li>{@code net.minecraft.server.network.ServerPlayerEntity} (Fabric)</li>
+     * <li>{@code cn.nukkit.Player}</li>
+     * <li>{@code com.velocitypowered.api.proxy.Player}</li>
+     * </ul>
+     *
+     * @param playerClass the class used by the platform to represent players
+     * @param <T> the player class type
+     * @return the player adapter
+     * @throws IllegalArgumentException if the player class is not correct
+     * @since 5.1
+     */
+    <T> @NonNull PlayerAdapter<T> getPlayerAdapter(@NonNull Class<T> playerClass);
+
+    /**
+     * Gets the {@link Platform}, which represents the server platform the
+     * plugin is running on.
+     *
+     * @return the platform
+     */
+    @NonNull Platform getPlatform();
+
+    /**
+     * Gets the {@link PluginMetadata}, responsible for providing metadata about
+     * the LuckPerms plugin currently running.
+     *
+     * @return the plugin metadata
+     */
+    @NonNull PluginMetadata getPluginMetadata();
+
+    /**
+     * Gets the {@link EventBus}, used for subscribing to internal LuckPerms
+     * events.
+     *
+     * @return the event bus
+     */
+    @NonNull EventBus getEventBus();
+
+    /**
+     * Gets the {@link MessagingService}, used to dispatch updates throughout a
+     * network of servers running the plugin.
+     *
+     * <p>Not all instances of LuckPerms will have a messaging service setup and
+     * configured.</p>
+     *
+     * @return the messaging service instance, if present.
+     */
+    @NonNull Optional<MessagingService> getMessagingService();
+
+    /**
+     * Gets the {@link ActionLogger}, responsible for saving and broadcasting
+     * defined actions occurring on the platform.
+     *
+     * @return the action logger
+     */
+    @NonNull ActionLogger getActionLogger();
+
+    /**
+     * Gets the {@link ContextManager}, responsible for managing
+     * {@link ContextCalculator}s, and calculating applicable contexts.
+     *
+     * @return the context manager
+     */
+    @NonNull ContextManager getContextManager();
+
+    /**
+     * Gets the {@link MetaStackFactory}.
+     *
+     * <p>The metastack factory provides methods for retrieving
+     * {@link MetaStackElement}s and constructing
+     * {@link MetaStackDefinition}s.</p>
+     *
+     * @return the meta stack factory
+     */
+    @NonNull MetaStackFactory getMetaStackFactory();
+
+    /**
+     * Schedules the execution of an update task, and returns an encapsulation
+     * of the task as a {@link CompletableFuture}.
+     *
+     * <p>The exact actions performed in an update task remains an
+     * implementation detail of the plugin, however, as a minimum, it is
+     * expected to perform a full reload of user, group and track data, and
+     * ensure that any changes are fully applied and propagated.</p>
+     *
+     * @return a future
+     */
+    @NonNull CompletableFuture<Void> runUpdateTask();
+
+    /**
+     * Registers a {@link MessengerProvider} for use by the platform.
+     *
+     * <p>Note that the mere action of registering a provider doesn't
+     * necessarily mean that it will be used.</p>
+     *
+     * @param messengerProvider the messenger provider.
+     */
+    void registerMessengerProvider(@NonNull MessengerProvider messengerProvider);
+
+    /**
+     * Gets the {@link NodeBuilderRegistry}.
+     *
+     * @return the node builder registry
+     */
+    @Internal
+    @NonNull NodeBuilderRegistry getNodeBuilderRegistry();
+
+    /**
+     * Gets the {@link QueryOptionsRegistry}.
+     *
+     * @return the query options registry
+     * @since 5.1
+     */
+    @Internal
+    @NonNull QueryOptionsRegistry getQueryOptionsRegistry();
+
+    /**
+     * Gets the {@link NodeMatcherFactory}.
+     *
+     * @return the node matcher factory
+     * @since 5.1
+     */
+    @Internal
+    @NonNull NodeMatcherFactory getNodeMatcherFactory();
+
+}

api/src/main/java/net/luckperms/api/LuckPermsProvider.java

@@ -0,0 +1,88 @@
+/*
+ * This file is part of LuckPerms, licensed under the MIT License.
+ *
+ *  Copyright (c) lucko (Luck) <luck@lucko.me>
+ *  Copyright (c) contributors
+ *
+ *  Permission is hereby granted, free of charge, to any person obtaining a copy
+ *  of this software and associated documentation files (the "Software"), to deal
+ *  in the Software without restriction, including without limitation the rights
+ *  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ *  copies of the Software, and to permit persons to whom the Software is
+ *  furnished to do so, subject to the following conditions:
+ *
+ *  The above copyright notice and this permission notice shall be included in all
+ *  copies or substantial portions of the Software.
+ *
+ *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ *  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ *  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ *  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ *  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ *  SOFTWARE.
+ */
+
+package net.luckperms.api;
+
+import org.checkerframework.checker.nullness.qual.NonNull;
+
+import static org.jetbrains.annotations.ApiStatus.Internal;
+
+/**
+ * Provides static access to the {@link LuckPerms} API.
+ *
+ * <p>Ideally, the ServiceManager for the platform should be used to obtain an
+ * instance, however, this provider can be used if this is not viable.</p>
+ */
+public final class LuckPermsProvider {
+    private static LuckPerms instance = null;
+
+    /**
+     * Gets an instance of the {@link LuckPerms} API,
+     * throwing {@link IllegalStateException} if the API is not loaded yet.
+     *
+     * <p>This method will never return null.</p>
+     *
+     * @return an instance of the LuckPerms API
+     * @throws IllegalStateException if the API is not loaded yet
+     */
+    public static @NonNull LuckPerms get() {
+        if (instance == null) {
+            throw new NotLoadedException();
+        }
+        return instance;
+    }
+
+    @Internal
+    static void register(LuckPerms instance) {
+        LuckPermsProvider.instance = instance;
+    }
+
+    @Internal
+    static void unregister() {
+        LuckPermsProvider.instance = null;
+    }
+
+    @Internal
+    private LuckPermsProvider() {
+        throw new UnsupportedOperationException("This class cannot be instantiated.");
+    }
+
+    /**
+     * Exception thrown when the API is requested before it has been loaded.
+     */
+    private static final class NotLoadedException extends IllegalStateException {
+        private static final String MESSAGE = "The LuckPerms API isn't loaded yet!\n" +
+                "This could be because:\n" +
+                "  a) the LuckPerms plugin is not installed or it failed to enable\n" +
+                "  b) your plugin does not declare a dependency on LuckPerms\n" +
+                "  c) you are attempting to use the API before plugins reach the 'enable' phase\n" +
+                "     (call the #get method in onEnable, not in your plugin constructor!)\n";
+
+        NotLoadedException() {
+            super(MESSAGE);
+        }
+    }
+
+}

api/src/main/java/net/luckperms/api/actionlog/Action.java

@@ -0,0 +1,208 @@
+/*
+ * This file is part of LuckPerms, licensed under the MIT License.
+ *
+ *  Copyright (c) lucko (Luck) <luck@lucko.me>
+ *  Copyright (c) contributors
+ *
+ *  Permission is hereby granted, free of charge, to any person obtaining a copy
+ *  of this software and associated documentation files (the "Software"), to deal
+ *  in the Software without restriction, including without limitation the rights
+ *  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ *  copies of the Software, and to permit persons to whom the Software is
+ *  furnished to do so, subject to the following conditions:
+ *
+ *  The above copyright notice and this permission notice shall be included in all
+ *  copies or substantial portions of the Software.
+ *
+ *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ *  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ *  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ *  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ *  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ *  SOFTWARE.
+ */
+
+package net.luckperms.api.actionlog;
+
+import net.luckperms.api.LuckPermsProvider;
+
+import org.checkerframework.checker.nullness.qual.NonNull;
+import org.checkerframework.checker.nullness.qual.Nullable;
+
+import java.time.Instant;
+import java.util.Optional;
+import java.util.UUID;
+
+/**
+ * Represents a logged action.
+ */
+public interface Action extends Comparable<Action> {
+
+    /**
+     * Gets a {@link Action.Builder}
+     *
+     * @return a new builder
+     */
+    static @NonNull Builder builder() {
+        return LuckPermsProvider.get().getActionLogger().actionBuilder();
+    }
+
+    /**
+     * Gets the time when the action occurred.
+     *
+     * @return the timestamp
+     */
+    @NonNull Instant getTimestamp();
+
+    /**
+     * Gets the source of the action.
+     *
+     * @return the source
+     */
+    @NonNull Source getSource();
+
+    /**
+     * Gets the target of the action.
+     *
+     * @return the target
+     */
+    @NonNull Target getTarget();
+
+    /**
+     * Returns a string describing the action which took place.
+     *
+     * <p>In most instances, this returns a variation of the command string which caused
+     * the change.</p>
+     *
+     * @return the action
+     */
+    @NonNull String getDescription();
+
+    /**
+     * Represents the source of an action.
+     */
+    interface Source {
+
+        /**
+         * Gets the source unique id.
+         *
+         * @return the source unique id
+         */
+        @NonNull UUID getUniqueId();
+
+        /**
+         * Gets the source name.
+         *
+         * @return the source name
+         */
+        @NonNull String getName();
+
+    }
+
+    /**
+     * Represents the target of an action.
+     */
+    interface Target {
+
+        /**
+         * Gets the target unique id.
+         *
+         * @return the target unique id
+         */
+        @NonNull Optional<UUID> getUniqueId();
+
+        /**
+         * Gets the target name.
+         *
+         * @return the target name
+         */
+        @NonNull String getName();
+
+        /**
+         * Gets the target type.
+         *
+         * @return the target type
+         */
+        @NonNull Type getType();
+
+        /**
+         * Represents the type of a {@link Target}.
+         */
+        enum Type {
+            USER, GROUP, TRACK
+        }
+    }
+
+    /**
+     * Builds an {@link Action} instance
+     */
+    interface Builder {
+
+        /**
+         * Sets the timestamp of the entry.
+         *
+         * @param timestamp the timestamp
+         * @return the builder
+         * @see Action#getTimestamp()
+         */
+        @NonNull Builder timestamp(@NonNull Instant timestamp);
+
+        /**
+         * Sets the actor of the entry.
+         *
+         * @param actor the actor
+         * @return the builder
+         */
+        @NonNull Builder source(@NonNull UUID actor);
+
+        /**
+         * Sets the actor name of the entry.
+         *
+         * @param actorName the actor name
+         * @return the builder
+         */
+        @NonNull Builder sourceName(@NonNull String actorName);
+
+        /**
+         * Sets the type of the entry.
+         *
+         * @param type the type
+         * @return the builder
+         */
+        @NonNull Builder targetType(Target.@NonNull Type type);
+
+        /**
+         * Sets the acted object for the entry.
+         *
+         * @param acted the acted object
+         * @return the builder
+         */
+        @NonNull Builder target(@Nullable UUID acted);
+
+        /**
+         * Sets the acted name for the entry.
+         *
+         * @param actedName the acted name
+         * @return the builder
+         */
+        @NonNull Builder targetName(@NonNull String actedName);
+
+        /**
+         * Sets the action of the entry.
+         *
+         * @param action the action
+         * @return the builder
+         */
+        @NonNull Builder description(@NonNull String action);
+
+        /**
+         * Creates a {@link Action} instance from the builder.
+         *
+         * @return a new log entry instance
+         */
+        @NonNull Action build();
+
+    }
+
+}

api/src/main/java/net/luckperms/api/actionlog/ActionLog.java

@@ -23,9 +23,10 @@
  *  SOFTWARE.
  */
 
-package me.lucko.luckperms.api;
+package net.luckperms.api.actionlog;
 
 import org.checkerframework.checker.nullness.qual.NonNull;
+import org.jetbrains.annotations.Unmodifiable;
 
 import java.util.SortedSet;
 import java.util.UUID;
@@ -36,18 +37,18 @@ import java.util.UUID;
  * <p>The returned instance provides a copy of the data at the time of retrieval.</p>
  *
  * <p>Any changes made to log entries will only apply to this instance of the log.
- * You can add to the log using the {@link Storage}, and then request an updated copy.</p>
+ * You can add to the log using the {@link ActionLogger}, and then request an updated copy.</p>
  *
  * <p>All methods are thread safe, and return immutable and thread safe collections.</p>
  */
-public interface Log {
+public interface ActionLog {
 
     /**
-     * Gets the {@link LogEntry}s that make up this log.
+     * Gets the {@link Action}s that make up this log.
      *
      * @return the content
      */
-    @NonNull SortedSet<LogEntry> getContent();
+    @NonNull @Unmodifiable SortedSet<Action> getContent();
 
     /**
      * Gets the entries in the log performed by the given actor.
@@ -55,15 +56,15 @@ public interface Log {
      * @param actor the uuid of the actor to filter by
      * @return the content for the given actor
      */
-    @NonNull SortedSet<LogEntry> getContent(@NonNull UUID actor);
+    @NonNull @Unmodifiable SortedSet<Action> getContent(@NonNull UUID actor);
 
     /**
      * Gets the log content for a given user
      *
-     * @param uuid the uuid to filter by
+     * @param uniqueId the uuid to filter by
      * @return all content in this log where the user = uuid
      */
-    @NonNull SortedSet<LogEntry> getUserHistory(@NonNull UUID uuid);
+    @NonNull @Unmodifiable SortedSet<Action> getUserHistory(@NonNull UUID uniqueId);
 
     /**
      * Gets the log content for a given group
@@ -71,7 +72,7 @@ public interface Log {
      * @param name the name to filter by
      * @return all content in this log where the group = name
      */
-    @NonNull SortedSet<LogEntry> getGroupHistory(@NonNull String name);
+    @NonNull @Unmodifiable SortedSet<Action> getGroupHistory(@NonNull String name);
 
     /**
      * Gets the log content for a given track
@@ -79,6 +80,6 @@ public interface Log {
      * @param name the name to filter by
      * @return all content in this log where the track = name
      */
-    @NonNull SortedSet<LogEntry> getTrackHistory(@NonNull String name);
+    @NonNull @Unmodifiable SortedSet<Action> getTrackHistory(@NonNull String name);
 
 }

api/src/main/java/net/luckperms/api/actionlog/ActionLogger.java

@@ -23,7 +23,9 @@
  *  SOFTWARE.
  */
 
-package me.lucko.luckperms.api;
+package net.luckperms.api.actionlog;
+
+import net.luckperms.api.messaging.MessagingService;
 
 import org.checkerframework.checker.nullness.qual.NonNull;
 
@@ -31,25 +33,22 @@ import java.util.concurrent.CompletableFuture;
 
 /**
  * Represents the object responsible for handling action logging.
- *
- * @since 4.1
  */
 public interface ActionLogger {
 
     /**
-     * Returns a new {@link LogEntry.Builder} instance
+     * Returns a new {@link Action.Builder} instance
      *
      * @return a new builder
      */
-    LogEntry.@NonNull Builder newEntryBuilder();
+    Action.@NonNull Builder actionBuilder();
 
     /**
-     * Gets a {@link Log} instance from the plugin storage.
+     * Gets a {@link ActionLog} instance from the plugin storage.
      *
      * @return a log instance
-     * @see Storage#getLog()
      */
-    @NonNull CompletableFuture<Log> getLog();
+    @NonNull CompletableFuture<ActionLog> getLog();
 
     /**
      * Submits a log entry to the plugin to be handled.
@@ -58,7 +57,7 @@ public interface ActionLogger {
      * it.</p>
      *
      * <p>It is therefore roughly equivalent to calling
-     * {@link #submitToStorage(LogEntry)} and {@link #broadcastAction(LogEntry)},
+     * {@link #submitToStorage(Action)} and {@link #broadcastAction(Action)},
      * however, using this method is preferred to making the calls individually.</p>
      *
      * <p>If you want to submit a log entry but don't know which method to pick,
@@ -67,17 +66,15 @@ public interface ActionLogger {
      * @param entry the entry to submit
      * @return a future which will complete when the action is done
      */
-    @NonNull CompletableFuture<Void> submit(@NonNull LogEntry entry);
+    @NonNull CompletableFuture<Void> submit(@NonNull Action entry);
 
     /**
      * Submits a log entry to the plugins storage handler.
      *
-     * <p>Performs the same action as {@link Storage#logAction(LogEntry)}.</p>
-     *
      * @param entry the entry to submit
      * @return a future which will complete when the action is done
      */
-    @NonNull CompletableFuture<Void> submitToStorage(@NonNull LogEntry entry);
+    @NonNull CompletableFuture<Void> submitToStorage(@NonNull Action entry);
 
     /**
      * Submits a log entry to the plugins log broadcasting handler.
@@ -88,6 +85,6 @@ public interface ActionLogger {
      * @param entry the entry to submit
      * @return a future which will complete when the action is done
      */
-    @NonNull CompletableFuture<Void> broadcastAction(@NonNull LogEntry entry);
+    @NonNull CompletableFuture<Void> broadcastAction(@NonNull Action entry);
 
 }

api/src/main/java/net/luckperms/api/actionlog/package-info.java

@@ -23,11 +23,7 @@
  *  SOFTWARE.
  */
 
-package me.lucko.luckperms.api.event.node;
-
 /**
- * Called when a holder has their nodes cleared
+ * {@link net.luckperms.api.actionlog.ActionLog} related functionality.
  */
-public interface NodeClearEvent extends NodeMutateEvent {
-
-}
+package net.luckperms.api.actionlog;

api/src/main/java/net/luckperms/api/cacheddata/CachedData.java

@@ -23,23 +23,22 @@
  *  SOFTWARE.
  */
 
-package me.lucko.luckperms.api.event.node;
+package net.luckperms.api.cacheddata;
 
-import me.lucko.luckperms.api.Node;
-import me.lucko.luckperms.api.event.Param;
+import net.luckperms.api.query.QueryOptions;
 
 import org.checkerframework.checker.nullness.qual.NonNull;
 
 /**
- * Called when a node is added to a holder
+ * Holds cached lookup data for a given set of query options.
  */
-public interface NodeAddEvent extends NodeMutateEvent {
+public interface CachedData {
 
     /**
-     * Gets the node that was added
+     * Gets the query options this container is holding data for.
      *
-     * @return the node that was added
+     * @return the query options this container is caching
      */
-    @NonNull @Param(3) Node getNode();
+    @NonNull QueryOptions getQueryOptions();
 
 }

api/src/main/java/net/luckperms/api/cacheddata/CachedDataManager.java

@@ -0,0 +1,250 @@
+/*
+ * This file is part of LuckPerms, licensed under the MIT License.
+ *
+ *  Copyright (c) lucko (Luck) <luck@lucko.me>
+ *  Copyright (c) contributors
+ *
+ *  Permission is hereby granted, free of charge, to any person obtaining a copy
+ *  of this software and associated documentation files (the "Software"), to deal
+ *  in the Software without restriction, including without limitation the rights
+ *  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ *  copies of the Software, and to permit persons to whom the Software is
+ *  furnished to do so, subject to the following conditions:
+ *
+ *  The above copyright notice and this permission notice shall be included in all
+ *  copies or substantial portions of the Software.
+ *
+ *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ *  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ *  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ *  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ *  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ *  SOFTWARE.
+ */
+
+package net.luckperms.api.cacheddata;
+
+import net.luckperms.api.context.ContextManager;
+import net.luckperms.api.model.PermissionHolder;
+import net.luckperms.api.model.group.Group;
+import net.luckperms.api.model.user.User;
+import net.luckperms.api.query.QueryOptions;
+
+import org.checkerframework.checker.nullness.qual.NonNull;
+
+import java.util.concurrent.CompletableFuture;
+
+/**
+ * Holds cached permission and meta lookup data for a {@link PermissionHolder}.
+ *
+ * <p>All calls will account for inheritance, as well as any default data
+ * provided by the platform. This calls are heavily cached and are therefore
+ * fast.</p>
+ */
+public interface CachedDataManager {
+
+    /**
+     * Gets the manager for {@link CachedPermissionData}.
+     *
+     * @return the permission data manager
+     */
+    @NonNull Container<CachedPermissionData> permissionData();
+
+    /**
+     * Gets the manager for {@link CachedMetaData}.
+     *
+     * @return the meta data manager
+     */
+    @NonNull Container<CachedMetaData> metaData();
+
+    /**
+     * Gets PermissionData from the cache, using the given query options.
+     *
+     * @param queryOptions the query options
+     * @return a permission data instance
+     */
+    @NonNull CachedPermissionData getPermissionData(@NonNull QueryOptions queryOptions);
+
+    /**
+     * Gets MetaData from the cache, using the given query options.
+     *
+     * @param queryOptions the query options
+     * @return a meta data instance
+     */
+    @NonNull CachedMetaData getMetaData(@NonNull QueryOptions queryOptions);
+
+    /**
+     * Gets PermissionData from the cache, using the most appropriate query options
+     * available at the time.
+     *
+     * <p>For {@link User}s, the most appropriate query options will be their
+     * {@link ContextManager#getQueryOptions(User) current active query options} if the
+     * corresponding player is online, and otherwise, will fallback to
+     * {@link ContextManager#getStaticQueryOptions() the current static query options}
+     * if they are offline.</p>
+     *
+     * <p>For {@link Group}s, the most appropriate query options will always be
+     * {@link ContextManager#getStaticQueryOptions()} the current static query options.</p>
+     *
+     * @return a permission data instance
+     * @since 5.1
+     */
+    @NonNull CachedPermissionData getPermissionData();
+
+    /**
+     * Gets MetaData from the cache, using the most appropriate query options
+     * available at the time.
+     *
+     * <p>For {@link User}s, the most appropriate query options will be their
+     * {@link ContextManager#getQueryOptions(User) current active query options} if the
+     * corresponding player is online, and otherwise, will fallback to
+     * {@link ContextManager#getStaticQueryOptions() the current static query options}
+     * if they are offline.</p>
+     *
+     * <p>For {@link Group}s, the most appropriate query options will always be
+     * {@link ContextManager#getStaticQueryOptions()} the current static query options.</p>
+     *
+     * @return a meta data instance
+     * @since 5.1
+     * @see PermissionHolder#getQueryOptions()
+     */
+    @NonNull CachedMetaData getMetaData();
+
+    /**
+     * Invalidates all cached {@link CachedPermissionData} and {@link CachedMetaData}
+     * instances.
+     */
+    void invalidate();
+
+    /**
+     * Invalidates all of the underlying Permission calculators.
+     *
+     * <p>Can be called to allow for an update in defaults.</p>
+     */
+    void invalidatePermissionCalculators();
+
+    /**
+     * Manages a specific type of {@link CachedData cached data} within
+     * a {@link CachedDataManager} instance.
+     *
+     * @param <T> the data type
+     */
+    interface Container<T extends CachedData> {
+
+        /**
+         * Gets {@link T data} from the cache.
+         *
+         * @param queryOptions the query options
+         * @return a data instance
+         * @throws NullPointerException if contexts is null
+         */
+        @NonNull T get(@NonNull QueryOptions queryOptions);
+
+        /**
+         * Calculates {@link T data}, bypassing the cache.
+         *
+         * <p>The result of this operation is calculated each time the method is called.
+         * The result is not added to the internal cache.</p>
+         *
+         * <p>It is therefore highly recommended to use {@link #get(QueryOptions)} instead.</p>
+         *
+         * <p>The use cases of this method are more around constructing one-time
+         * instances of {@link T data}, without adding the result to the cache.</p>
+         *
+         * @param queryOptions the query options
+         * @return a data instance
+         * @throws NullPointerException if contexts is null
+         */
+        @NonNull T calculate(@NonNull QueryOptions queryOptions);
+
+        /**
+         * (Re)calculates data for a given context.
+         *
+         * <p>This method returns immediately in all cases. The (re)calculation is
+         * performed asynchronously and applied to the cache in the background.</p>
+         *
+         * <p>If there was a previous data instance associated with
+         * the given {@link QueryOptions}, then that instance will continue to be returned by
+         * {@link #get(QueryOptions)} until the recalculation is completed.</p>
+         *
+         * <p>If there was no value calculated and cached prior to the call of this
+         * method, then one will be calculated.</p>
+         *
+         * @param queryOptions the query options
+         * @throws NullPointerException if contexts is null
+         */
+        void recalculate(@NonNull QueryOptions queryOptions);
+
+        /**
+         * (Re)loads permission data for a given context.
+         *
+         * <p>Unlike {@link #recalculate(QueryOptions)}, this method immediately
+         * invalidates any previous data values contained within the cache,
+         * and then schedules a task to reload a new data instance to
+         * replace the one which was invalidated.</p>
+         *
+         * <p>The invalidation happens immediately during the execution of this method.
+         * The result of the re-computation encapsulated by the future.</p>
+         *
+         * <p>Subsequent calls to {@link #get(QueryOptions)} will block until
+         * the result of this operation is complete.</p>
+         *
+         * <p>If there was no value calculated and cached prior to the call of this
+         * method, then one will be calculated.</p>
+         *
+         * <p>This method returns a Future so users can optionally choose to wait
+         * until the recalculation has been performed.</p>
+         *
+         * @param queryOptions the query options.
+         * @return a future
+         * @throws NullPointerException if contexts is null
+         */
+        @NonNull CompletableFuture<? extends T> reload(@NonNull QueryOptions queryOptions);
+
+        /**
+         * Recalculates data for all known contexts.
+         *
+         * <p>This method returns immediately. The recalculation is performed
+         * asynchronously and applied to the cache in the background.</p>
+         *
+         * <p>The previous data instances will continue to be returned
+         * by {@link #get(QueryOptions)} until the recalculation is completed.</p>
+         */
+        void recalculate();
+
+        /**
+         * Reloads permission data for all known contexts.
+         *
+         * <p>Unlike {@link #recalculate()}, this method immediately
+         * invalidates all previous data values contained within the cache,
+         * and then schedules a task to reload new data instances to
+         * replace the ones which were invalidated.</p>
+         *
+         * <p>The invalidation happens immediately during the execution of this method.
+         * The result of the re-computation encapsulated by the future.</p>
+         *
+         * <p>Subsequent calls to {@link #get(QueryOptions)} will block until
+         * the result of this operation is complete.</p>
+         *
+         * <p>This method returns a Future so users can optionally choose to wait
+         * until the recalculation has been performed.</p>
+         *
+         * @return a future
+         */
+        @NonNull CompletableFuture<Void> reload();
+
+        /**
+         * Invalidates any cached data instances mapped to the given context.
+         *
+         * @param queryOptions the queryOptions to invalidate for
+         */
+        void invalidate(@NonNull QueryOptions queryOptions);
+
+        /**
+         * Invalidates all cached data instances.
+         */
+        void invalidate();
+    }
+
+}

api/src/main/java/net/luckperms/api/cacheddata/CachedMetaData.java

@@ -0,0 +1,144 @@
+/*
+ * This file is part of LuckPerms, licensed under the MIT License.
+ *
+ *  Copyright (c) lucko (Luck) <luck@lucko.me>
+ *  Copyright (c) contributors
+ *
+ *  Permission is hereby granted, free of charge, to any person obtaining a copy
+ *  of this software and associated documentation files (the "Software"), to deal
+ *  in the Software without restriction, including without limitation the rights
+ *  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ *  copies of the Software, and to permit persons to whom the Software is
+ *  furnished to do so, subject to the following conditions:
+ *
+ *  The above copyright notice and this permission notice shall be included in all
+ *  copies or substantial portions of the Software.
+ *
+ *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ *  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ *  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ *  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ *  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ *  SOFTWARE.
+ */
+
+package net.luckperms.api.cacheddata;
+
+import net.luckperms.api.metastacking.MetaStackDefinition;
+
+import org.checkerframework.checker.nullness.qual.NonNull;
+import org.checkerframework.checker.nullness.qual.Nullable;
+import org.jetbrains.annotations.Unmodifiable;
+
+import java.util.List;
+import java.util.Map;
+import java.util.Optional;
+import java.util.SortedMap;
+import java.util.function.Function;
+
+/**
+ * Holds cached meta lookup data for a specific set of contexts.
+ */
+public interface CachedMetaData extends CachedData {
+
+    /**
+     * Gets a value for the given meta key.
+     *
+     * @param key the key
+     * @return the value
+     */
+    @Nullable String getMetaValue(@NonNull String key);
+
+    /**
+     * Gets a value for the given meta key, and runs it through the given {@code transformer}.
+     *
+     * <p>If no such meta value exists, an {@link Optional#empty() empty optional} is returned.
+     * (the transformer will never be passed a null argument)</p>
+     *
+     * <p>The transformer is allowed to throw {@link IllegalArgumentException} or return null. This
+     * will also result in an {@link Optional#empty() empty optional} being returned.</p>
+     *
+     * <p>For example, to parse and return an integer meta value, use:</p>
+     * <p><blockquote><pre>
+     *     getMetaValue("my-int-val", Integer::parseInt).orElse(0);
+     * </pre></blockquote>
+     *
+     * @param key the key
+     * @param valueTransformer the transformer used to transform the value
+     * @param <T> the type of the transformed result
+     * @return the meta value
+     * @since 5.3
+     */
+    default <T> @NonNull Optional<T> getMetaValue(@NonNull String key, @NonNull Function<String, ? extends T> valueTransformer) {
+        return Optional.ofNullable(getMetaValue(key)).map(value -> {
+            try {
+                return valueTransformer.apply(value);
+            } catch (IllegalArgumentException e) {
+                return null;
+            }
+        });
+    }
+
+    /**
+     * Gets the holder's highest priority prefix, or null if the holder has no prefixes
+     *
+     * @return a prefix string, or null
+     */
+    @Nullable String getPrefix();
+
+    /**
+     * Gets the holder's highest priority suffix, or null if the holder has no suffixes
+     *
+     * @return a suffix string, or null
+     */
+    @Nullable String getSuffix();
+
+    /**
+     * Gets an immutable copy of the meta this holder has.
+     *
+     * @return an immutable map of meta
+     */
+    @NonNull @Unmodifiable Map<String, List<String>> getMeta();
+
+    /**
+     * Gets an immutable sorted map of all of the prefixes the holder has, whereby the first
+     * value is the highest priority prefix.
+     *
+     * @return a sorted map of prefixes
+     */
+    @NonNull @Unmodifiable SortedMap<Integer, String> getPrefixes();
+
+    /**
+     * Gets an immutable sorted map of all of the suffixes the holder has, whereby the first
+     * value is the highest priority suffix.
+     *
+     * @return a sorted map of suffixes
+     */
+    @NonNull @Unmodifiable SortedMap<Integer, String> getSuffixes();
+
+    /**
+     * Gets the name of the holders primary group.
+     *
+     * <p>Will return {@code null} for Group holder types.</p>
+     *
+     * @return the name of the primary group
+     * @since 5.1
+     */
+    @Nullable String getPrimaryGroup();
+
+    /**
+     * Gets the definition used for the prefix stack
+     *
+     * @return the definition used for the prefix stack
+     */
+    @NonNull MetaStackDefinition getPrefixStackDefinition();
+
+    /**
+     * Gets the definition used for the suffix stack
+     *
+     * @return the definition used for the suffix stack
+     */
+    @NonNull MetaStackDefinition getSuffixStackDefinition();
+
+}

api/src/main/java/net/luckperms/api/cacheddata/CachedPermissionData.java

@@ -23,20 +23,19 @@
  *  SOFTWARE.
  */
 
-package me.lucko.luckperms.api.caching;
+package net.luckperms.api.cacheddata;
 
-import me.lucko.luckperms.api.Tristate;
+import net.luckperms.api.util.Tristate;
 
 import org.checkerframework.checker.nullness.qual.NonNull;
+import org.jetbrains.annotations.Unmodifiable;
 
 import java.util.Map;
 
 /**
  * Holds cached permission lookup data for a specific set of contexts.
- *
- * @since 2.13
  */
-public interface PermissionData extends CachedDataContainer {
+public interface CachedPermissionData extends CachedData {
 
     /**
      * Gets a permission check result for the given permission node.
@@ -45,7 +44,7 @@ public interface PermissionData extends CachedDataContainer {
      * @return a tristate result
      * @throws NullPointerException if permission is null
      */
-    @NonNull Tristate getPermissionValue(@NonNull String permission);
+    @NonNull Tristate checkPermission(@NonNull String permission);
 
     /**
      * Invalidates the underlying permission calculator cache.
@@ -59,6 +58,6 @@ public interface PermissionData extends CachedDataContainer {
      *
      * @return an immutable set of permissions
      */
-    @NonNull Map<String, Boolean> getImmutableBacking();
+    @NonNull @Unmodifiable Map<String, Boolean> getPermissionMap();
 
 }

api/src/main/java/net/luckperms/api/cacheddata/package-info.java

@@ -23,15 +23,8 @@
  *  SOFTWARE.
  */
 
-package me.lucko.luckperms.common.dependencies.classloader;
-
-import java.nio.file.Path;
-
 /**
- * Represents the plugins classloader
+ * CachedData lookup API for {@link net.luckperms.api.model.user.User}s and
+ * {@link net.luckperms.api.model.group.Group}s.
  */
-public interface PluginClassLoader {
-
-    void loadJar(Path file);
-
-}
+package net.luckperms.api.cacheddata;

api/src/main/java/net/luckperms/api/context/Context.java

@@ -0,0 +1,101 @@
+/*
+ * This file is part of LuckPerms, licensed under the MIT License.
+ *
+ *  Copyright (c) lucko (Luck) <luck@lucko.me>
+ *  Copyright (c) contributors
+ *
+ *  Permission is hereby granted, free of charge, to any person obtaining a copy
+ *  of this software and associated documentation files (the "Software"), to deal
+ *  in the Software without restriction, including without limitation the rights
+ *  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ *  copies of the Software, and to permit persons to whom the Software is
+ *  furnished to do so, subject to the following conditions:
+ *
+ *  The above copyright notice and this permission notice shall be included in all
+ *  copies or substantial portions of the Software.
+ *
+ *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ *  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ *  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ *  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ *  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ *  SOFTWARE.
+ */
+
+package net.luckperms.api.context;
+
+import org.checkerframework.checker.nullness.qual.NonNull;
+import org.checkerframework.checker.nullness.qual.Nullable;
+
+/**
+ * Represents an individual context pair.
+ *
+ * <p>Context keys and values may not be null or empty. A key/value will be
+ * deemed empty if it's length is zero, or if it consists of only space
+ * characters.</p>
+ *
+ * @see ContextSet
+ */
+public interface Context {
+
+    /**
+     * Tests whether {@code key} is valid.
+     *
+     * <p>Context keys and values may not be null or empty. A key/value will be
+     * deemed empty if it's length is zero, or if it consists of only space
+     * characters.</p>
+     *
+     * <p>An exception is thrown when an invalid key is added to a {@link ContextSet}.</p>
+     *
+     * @param key the key to test
+     * @return true if valid, false otherwise.
+     * @since 5.1
+     */
+    static boolean isValidKey(@Nullable String key) {
+        if (key == null || key.isEmpty()) {
+            return false;
+        }
+
+        // look for a non-whitespace character
+        for (int i = 0, n = key.length(); i < n; i++) {
+            if (key.charAt(i) != ' ') {
+                return true;
+            }
+        }
+
+        return false;
+    }
+
+    /**
+     * Tests whether {@code value} is valid.
+     *
+     * <p>Context keys and values may not be null or empty. A key/value will be
+     * deemed empty if it's length is zero, or if it consists of only space
+     * characters.</p>
+     *
+     * <p>An exception is thrown when an invalid value is added to a {@link ContextSet}.</p>
+     *
+     * @param value the value to test
+     * @return true if valid, false otherwise.
+     * @since 5.1
+     */
+    static boolean isValidValue(@Nullable String value) {
+        return isValidKey(value); // the same for now...
+    }
+
+    /**
+     * Gets the context key.
+     *
+     * @return the key
+     */
+    @NonNull String getKey();
+
+    /**
+     * Gets the context value
+     *
+     * @return the value
+     */
+    @NonNull String getValue();
+
+}

api/src/main/java/net/luckperms/api/context/ContextCalculator.java

@@ -0,0 +1,110 @@
+/*
+ * This file is part of LuckPerms, licensed under the MIT License.
+ *
+ *  Copyright (c) lucko (Luck) <luck@lucko.me>
+ *  Copyright (c) contributors
+ *
+ *  Permission is hereby granted, free of charge, to any person obtaining a copy
+ *  of this software and associated documentation files (the "Software"), to deal
+ *  in the Software without restriction, including without limitation the rights
+ *  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ *  copies of the Software, and to permit persons to whom the Software is
+ *  furnished to do so, subject to the following conditions:
+ *
+ *  The above copyright notice and this permission notice shall be included in all
+ *  copies or substantial portions of the Software.
+ *
+ *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ *  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ *  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ *  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ *  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ *  SOFTWARE.
+ */
+
+package net.luckperms.api.context;
+
+import org.checkerframework.checker.nullness.qual.NonNull;
+
+import java.util.Objects;
+import java.util.function.Function;
+
+/**
+ * Calculates the contexts applicable for a contextual subject.
+ *
+ * <p>Implementations of this interface should satisfy the following
+ * requirements:</p>
+ * <ul>
+ *     <li>Context lookups should be <i>fast</i>: lookup methods are likely to
+ *     be invoked frequently, and should therefore be fast to execute. If
+ *     determining the current contexts involves a particularly time consuming
+ *     lookup (database queries, network requests, etc), then such results
+ *     should be cached ahead of time.</li>
+ *
+ *     <li>Context lookups should be <i>thread-safe</i>: lookups will sometimes
+ *     be performed from "async" threads, and therefore should not access any
+ *     part of the server only safe for access from a sync context. If
+ *     necessary, such results should be determined ahead of time and stored in
+ *     a thread-safe collection for retrieval later.</li>
+ *
+ *     <li>Context lookups should <i>not query active contexts</i>: doing so is
+ *     likely to result in a stack overflow, or thread deadlock. Care should be
+ *     taken to avoid (indirect) calls to the same calculator.</li>
+ * </ul>
+ * <p></p>
+ *
+ * <p>Calculators should be registered using
+ * {@link ContextManager#registerCalculator(ContextCalculator)}.</p>
+ */
+@FunctionalInterface
+public interface ContextCalculator<T> {
+
+    /**
+     * Creates a new {@link ContextCalculator} that provides a single context.
+     *
+     * @param key the key of the context provided by the calculator
+     * @param valueFunction the function used to compute the corresponding value
+     *                      for each query. A context will not be "accumulated"
+     *                      if the value returned is null.
+     * @param <T> the contextual type
+     * @return the resultant calculator
+     */
+    static <T> @NonNull ContextCalculator<T> forSingleContext(@NonNull String key, @NonNull Function<T, String> valueFunction) {
+        Objects.requireNonNull(key, "key");
+        Objects.requireNonNull(valueFunction, "valueFunction");
+        return (target, consumer) -> {
+            String value = valueFunction.apply(target);
+            if (value != null) {
+                consumer.accept(key, value);
+            }
+        };
+    }
+
+    /**
+     * Submits any contexts this calculator determines to be applicable to
+     * the {@code target} contextual subject.
+     *
+     * <p>Care should be taken to ensure implementations of this method meet the
+     * general requirements for {@link ContextCalculator}, defined in the class
+     * doc.</p>
+     *
+     * @param target the target contextual subject for this operation
+     * @param consumer the {@link ContextConsumer} to submit contexts to
+     */
+    void calculate(@NonNull T target, @NonNull ContextConsumer consumer);
+
+    /**
+     * Gets a {@link ContextSet}, containing some/all of the contexts this
+     * calculator could potentially submit.
+     *
+     * <p>The result of this call is primarily intended on providing
+     * suggestions to end users when defining permissions.</p>
+     *
+     * @return a set of potential contexts
+     */
+    default @NonNull ContextSet estimatePotentialContexts() {
+        return ImmutableContextSet.empty();
+    }
+
+}

api/src/main/java/net/luckperms/api/context/ContextConsumer.java

@@ -23,27 +23,42 @@
  *  SOFTWARE.
  */
 
-package me.lucko.luckperms.api.context;
+package net.luckperms.api.context;
 
 import org.checkerframework.checker.nullness.qual.NonNull;
 
 /**
- * Calculates whether contexts are applicable to a {@link T subject}.
- *
- * @param <T> the subject type. Is ALWAYS the player class of the platform.
- * @since 2.13
+ * Functional interface that accepts context key value pairs.
  */
 @FunctionalInterface
-public interface ContextCalculator<T> {
+public interface ContextConsumer {
 
     /**
-     * Gives the subject all of the applicable contexts they meet
+     * Accepts a context pair.
      *
-     * @param subject     the subject to add contexts to
-     * @param accumulator a map of contexts to add to
-     * @return the map
-     * @since 2.13
+     * @param key the key
+     * @param value the value
      */
-    @NonNull MutableContextSet giveApplicableContext(@NonNull T subject, @NonNull MutableContextSet accumulator);
+    void accept(@NonNull String key, @NonNull String value);
+
+    /**
+     * Accepts a context pair.
+     *
+     * @param context the context
+     */
+    default void accept(@NonNull Context context) {
+        accept(context.getKey(), context.getValue());
+    }
+
+    /**
+     * Accepts a context set.
+     *
+     * @param contextSet the context set
+     */
+    default void accept(@NonNull ContextSet contextSet) {
+        for (Context entry : contextSet) {
+            accept(entry);
+        }
+    }
 
 }

api/src/main/java/net/luckperms/api/context/ContextManager.java

@@ -23,12 +23,14 @@
  *  SOFTWARE.
  */
 
-package me.lucko.luckperms.api.context;
+package net.luckperms.api.context;
 
-import me.lucko.luckperms.api.Contexts;
-import me.lucko.luckperms.api.User;
+import net.luckperms.api.model.user.User;
+import net.luckperms.api.query.QueryMode;
+import net.luckperms.api.query.QueryOptions;
 
 import org.checkerframework.checker.nullness.qual.NonNull;
+import org.jetbrains.annotations.ApiStatus.Internal;
 
 import java.util.Optional;
 
@@ -36,22 +38,21 @@ import java.util.Optional;
  * Manages {@link ContextCalculator}s, and calculates applicable contexts for a
  * given type.
  *
- * This interface accepts {@link Object} types as a parameter to avoid having to depend
+ * <p>This interface accepts {@link Object} types as a parameter to avoid having to depend
  * on specific server implementations. In all cases, the "player" or "subject" type for
- * the platform must be used.
+ * the platform must be used.</p>
  *
- * Specifically:
+ * <p>Specifically:</p>
  *
  * <p></p>
  * <ul>
  * <li>{@code org.bukkit.entity.Player}</li>
  * <li>{@code net.md_5.bungee.api.connection.ProxiedPlayer}</li>
  * <li>{@code org.spongepowered.api.service.permission.Subject}</li>
+ * <li>{@code net.minecraft.server.network.ServerPlayerEntity} (Fabric)</li>
  * <li>{@code cn.nukkit.Player}</li>
  * <li>{@code com.velocitypowered.api.proxy.Player}</li>
  * </ul>
- *
- * @since 4.0
  */
 public interface ContextManager {
 
@@ -61,15 +62,7 @@ public interface ContextManager {
      * @param subject the subject
      * @return the applicable context for the subject
      */
-    @NonNull ImmutableContextSet getApplicableContext(@NonNull Object subject);
-
-    /**
-     * Queries the ContextManager for current context values for the subject.
-     *
-     * @param subject the subject
-     * @return the applicable context for the subject
-     */
-    @NonNull Contexts getApplicableContexts(@NonNull Object subject);
+    @NonNull ImmutableContextSet getContext(@NonNull Object subject);
 
     /**
      * Queries the ContextManager for current context values for the given User.
@@ -77,27 +70,14 @@ public interface ContextManager {
      * <p>This will only return a value if the player corresponding to the
      * {@link User} is online.</p>
      *
-     * <p>If you need to be a {@link Contexts} instance regardless, you should
-     * initially try this method, and then fallback on {@link #getStaticContext()}.</p>
+     * <p>If you need to obtain a {@link ImmutableContextSet} instance
+     * regardless, you should initially try this method, and then fallback on
+     * {@link #getStaticContext()}.</p>
      *
      * @param user the user
      * @return the applicable context for the subject
      */
-    @NonNull Optional<ImmutableContextSet> lookupApplicableContext(@NonNull User user);
-
-    /**
-     * Queries the ContextManager for current context values for the given User.
-     *
-     * <p>This will only return a value if the player corresponding to the
-     * {@link User} is online.</p>
-     *
-     * <p>If you need to be a {@link Contexts} instance regardless, you should
-     * initially try this method, and then fallback on {@link #getStaticContexts()}.</p>
-     *
-     * @param user the user
-     * @return the applicable context for the subject
-     */
-    @NonNull Optional<Contexts> lookupApplicableContexts(@NonNull User user);
+    @NonNull Optional<ImmutableContextSet> getContext(@NonNull User user);
 
     /**
      * Gets the contexts from the static calculators in this manager.
@@ -110,37 +90,41 @@ public interface ContextManager {
     @NonNull ImmutableContextSet getStaticContext();
 
     /**
-     * Gets the contexts from the static calculators in this manager.
+     * Creates a new {@link QueryOptions.Builder}.
      *
-     * <p>Static calculators provide the same context for all subjects, and are
-     * marked as such when registered.</p>
-     *
-     * @return the current active static contexts
+     * @param mode the mode
+     * @return a new query options builder
      */
-    @NonNull Contexts getStaticContexts();
+    QueryOptions.@NonNull Builder queryOptionsBuilder(@NonNull QueryMode mode);
 
     /**
-     * Forms a {@link Contexts} instance from an {@link ImmutableContextSet}.
+     * Obtains current {@link QueryOptions} for the subject.
      *
-     * <p>This method relies on the plugins configuration to form the
-     * {@link Contexts} instance.</p>
-     *
-     * @param subject    the reference subject
-     * @param contextSet the context set
-     * @return a contexts instance
+     * @param subject the subject
+     * @return the query options for the subject
      */
-    @NonNull Contexts formContexts(@NonNull Object subject, @NonNull ImmutableContextSet contextSet);
+    @NonNull QueryOptions getQueryOptions(@NonNull Object subject);
 
     /**
-     * Forms a {@link Contexts} instance from an {@link ImmutableContextSet}.
+     * Obtains current {@link QueryOptions} for the given User.
      *
-     * <p>This method relies on the plugins configuration to form the
-     * {@link Contexts} instance.</p>
+     * <p>This will only return a value if the player corresponding to the
+     * {@link User} is online.</p>
      *
-     * @param contextSet the context set
-     * @return a contexts instance
+     * <p>If you need to obtain a {@link QueryOptions} instance regardless, you should
+     * initially try this method, and then fallback on {@link #getStaticQueryOptions()}.</p>
+     *
+     * @param user the user
+     * @return the query options for the subject
      */
-    @NonNull Contexts formContexts(@NonNull ImmutableContextSet contextSet);
+    @NonNull Optional<QueryOptions> getQueryOptions(@NonNull User user);
+
+    /**
+     * Gets the static query options, using the registered static context calculators.
+     *
+     * @return the current static query options
+     */
+    @NonNull QueryOptions getStaticQueryOptions();
 
     /**
      * Registers a context calculator with the manager.
@@ -153,15 +137,39 @@ public interface ContextManager {
      * Unregisters a context calculator with the manager.
      *
      * @param calculator the calculator
-     * @since 4.4
      */
     void unregisterCalculator(@NonNull ContextCalculator<?> calculator);
 
+    /**
+     * Signal to the {@link ContextManager} that a {@code subject}s
+     * current contexts have changed.
+     *
+     * <p>It is not strictly necessary to make a call to this method every time a context
+     * changes.</p>
+     *
+     * @param subject the subject
+     * @since 5.2
+     */
+    void signalContextUpdate(@NonNull Object subject);
+
+    /**
+     * Gets the {@link ContextSetFactory}, responsible for creating
+     * {@link ContextSet} instances.
+     *
+     * @return the context set factory
+     */
+    @Internal
+    @NonNull ContextSetFactory getContextSetFactory();
+
     /**
      * Invalidates the lookup cache for a given subject
      *
      * @param subject the subject
+     * @deprecated Use {@link #signalContextUpdate(Object)} instead
      */
-    void invalidateCache(@NonNull Object subject);
+    @Deprecated
+    default void invalidateCache(@NonNull Object subject) {
+        signalContextUpdate(subject);
+    }
 
 }

api/src/main/java/net/luckperms/api/context/ContextSatisfyMode.java

@@ -23,52 +23,41 @@
  *  SOFTWARE.
  */
 
-package me.lucko.luckperms.api;
+package net.luckperms.api.context;
+
+import net.luckperms.api.query.OptionKey;
 
 /**
- * Represents the result to a "mutation" on an object.
+ * Mode for determining whether a {@link ContextSet} satisfies another.
  *
- * @since 4.2
+ * @since 5.2
+ * @see ContextSet#isSatisfiedBy(ContextSet, ContextSatisfyMode)
  */
-public interface MutateResult {
+public enum ContextSatisfyMode {
 
     /**
-     * Instance of {@link MutateResult} which always reports success.
-     */
-    MutateResult GENERIC_SUCCESS = () -> true;
-
-    /**
-     * Instance of {@link MutateResult} which always reports failure.
-     */
-    MutateResult GENERIC_FAILURE = () -> false;
-
-    /**
-     * Gets if the operation which produced this result completed successfully.
+     * Mode where a {@link ContextSet} A will be satisfied by another set B, if at least one of the
+     * key-value entries per key in A are also in B.
      *
-     * @return if the result indicates a success
+     * <p>For example, given <code>A = {server=survival, world=overworld, world=nether}</code>,
+     * another set {@code X} will satisfy {@code A} if {@code X} contains
+     * <code>server=survival AND (world=overworld OR world=nether)</code>.</p>
      */
-    boolean wasSuccess();
+    AT_LEAST_ONE_VALUE_PER_KEY,
 
     /**
-     * Gets if the operation which produced this result failed.
+     * Mode where a {@link ContextSet} A will be satisfied by another set B, if all key-value
+     * entries in A are also in B.
      *
-     * @return if the result indicates a failure
+     * <p>For example, given <code>A = {server=survival, world=overworld, world=nether}</code>,
+     * another set {@code X} will satisfy {@code A} if {@code X} contains
+     * <code>server=survival AND world=overworld AND world=nether</code>.</p>
      */
-    default boolean wasFailure() {
-        return !wasSuccess();
-    }
+    ALL_VALUES_PER_KEY;
 
     /**
-     * Gets a boolean representation of the result.
-     *
-     * <p>A value of <code>true</code> marks that the operation {@link #wasSuccess() was a success}
-     * and a value of <code>false</code> marks that the operation
-     * {@link #wasFailure() was a failure}.</p>
-     *
-     * @return a boolean representation
+     * The {@link OptionKey} for {@link ContextSatisfyMode}.
      */
-    default boolean asBoolean() {
-        return wasSuccess();
-    }
+    public static final OptionKey<ContextSatisfyMode> KEY = OptionKey.of("contextsatisfymode", ContextSatisfyMode.class);
 
 }

api/src/main/java/net/luckperms/api/context/ContextSet.java

@@ -23,11 +23,10 @@
  *  SOFTWARE.
  */
 
-package me.lucko.luckperms.api.context;
-
-import com.google.common.collect.Multimap;
+package net.luckperms.api.context;
 
 import org.checkerframework.checker.nullness.qual.NonNull;
+import org.jetbrains.annotations.Unmodifiable;
 
 import java.util.Iterator;
 import java.util.Map;
@@ -42,109 +41,38 @@ import java.util.Set;
  * something will apply.</p>
  *
  * <p>A single "context" consists of a key and a value, both strings. The key
- * represents the type of context, and the value represents the setting of the
- * context key.</p>
+ * describes the type of the context, and the value represents what the key is
+ * set to.</p>
+ *
+ * <p>For example, a context with {@code key=world} and {@code value=world_nether}
+ * describes that a subject is in the "world_nether" world.</p>
+ *
+ * <p>Contexts are exposed to end users and manipulated when managing permissions.
+ * For this reason, context keys should strike a balance between being descriptive
+ * and succinct.</p>
+ *
+ * <p>Context keys and values are case-insensitive, and will be automatically
+ * converted to {@link String#toLowerCase() lowercase} when added to a
+ * context set. Keys and values cannot be null or empty (len=0 or consisting of
+ * only whitespace).</p>
+ *
+ * <p>If a context key is formed of more than one word, the parts should be
+ * separated by the '{@code -}' character. (e.g. "{@code server-type}")</p>
+ *
+ * <p>If a context key is likely to conflict with another plugin, it should be
+ * appropriately namespaced using the name of the plugin providing the context.
+ * The namespace should be at the start of the context key, and separated using
+ * the '{@code :}' character. (e.g. "{@code worldguard:region}" for WorldGuard
+ * regions)</p>
  *
  * <p>Contexts can be combined with each other to form so called
  * "context sets" - simply a collection of context pairs.</p>
  *
- * <p>Context keys and values are case-insensitive, and will be converted to
- * {@link String#toLowerCase() lowercase} by all implementations.</p>
- *
- * <p>Context keys and values may not be null or empty. A key/value will be
- * deemed empty if it's length is zero, or if it consists of only space
- * characters.</p>
- *
  * <p>Two default ContextSet implementations are provided.
  * {@link MutableContextSet} allows the addition and removal of context keys
  * after construction, and {@link ImmutableContextSet} does not.</p>
- *
- * @since 2.13
  */
-public interface ContextSet extends Iterable<Map.Entry<String, String>> {
-
-    /**
-     * Creates an {@link ImmutableContextSet} from a context pair.
-     *
-     * @param key   the key
-     * @param value the value
-     * @return a new ImmutableContextSet containing one context pair
-     * @throws NullPointerException if key or value is null
-     */
-    static @NonNull ImmutableContextSet singleton(@NonNull String key, @NonNull String value) {
-        return ImmutableContextSet.singleton(key, value);
-    }
-
-    /**
-     * Creates an {@link ImmutableContextSet} from two context pairs.
-     *
-     * @param key1   the first key
-     * @param value1 the first value
-     * @param key2   the second key
-     * @param value2 the second value
-     * @return a new ImmutableContextSet containing the two pairs
-     * @throws NullPointerException if any of the keys or values are null
-     * @since 3.1
-     */
-    static @NonNull ImmutableContextSet of(@NonNull String key1, @NonNull String value1, @NonNull String key2, @NonNull String value2) {
-        return ImmutableContextSet.of(key1, value1, key2, value2);
-    }
-
-    /**
-     * Creates an {@link ImmutableContextSet} from an existing {@link Iterable} of {@link Map.Entry}s.
-     *
-     * @param iterable the iterable to copy from
-     * @return a new ImmutableContextSet representing the pairs in the iterable
-     * @throws NullPointerException if the iterable is null
-     */
-    static @NonNull ImmutableContextSet fromEntries(@NonNull Iterable<? extends Map.Entry<String, String>> iterable) {
-        return ImmutableContextSet.fromEntries(iterable);
-    }
-
-    /**
-     * Creates an {@link ImmutableContextSet} from an existing {@link Map}.
-     *
-     * @param map the map to copy from
-     * @return a new ImmutableContextSet representing the pairs from the map
-     * @throws NullPointerException if the map is null
-     */
-    static @NonNull ImmutableContextSet fromMap(@NonNull Map<String, String> map) {
-        return ImmutableContextSet.fromMap(map);
-    }
-
-    /**
-     * Creates an {@link ImmutableContextSet} from an existing {@link Multimap}.
-     *
-     * @param multimap the multimap to copy from
-     * @return a new ImmutableContextSet representing the pairs in the multimap
-     * @throws NullPointerException if the multimap is null
-     * @since 2.16
-     */
-    static @NonNull ImmutableContextSet fromMultimap(@NonNull Multimap<String, String> multimap) {
-        return ImmutableContextSet.fromMultimap(multimap);
-    }
-
-    /**
-     * Creates an new {@link ImmutableContextSet} from an existing {@link Set}.
-     *
-     * <p>Only really useful for converting between mutable and immutable types.</p>
-     *
-     * @param contextSet the context set to copy from
-     * @return a new ImmutableContextSet with the same content and the one provided
-     * @throws NullPointerException if contextSet is null
-     */
-    static @NonNull ImmutableContextSet fromSet(@NonNull ContextSet contextSet) {
-        return ImmutableContextSet.fromSet(contextSet);
-    }
-
-    /**
-     * Returns an empty {@link ImmutableContextSet}.
-     *
-     * @return an empty ImmutableContextSet
-     */
-    static @NonNull ImmutableContextSet empty() {
-        return ImmutableContextSet.empty();
-    }
+public interface ContextSet extends Iterable<Context> {
 
     /**
      * Gets if this {@link ContextSet} is immutable.
@@ -163,7 +91,7 @@ public interface ContextSet extends Iterable<Map.Entry<String, String>> {
      *
      * @return an immutable representation of this set
      */
-    @NonNull ImmutableContextSet makeImmutable();
+    @NonNull ImmutableContextSet immutableCopy();
 
     /**
      * Creates a mutable copy of this {@link ContextSet}.
@@ -172,12 +100,11 @@ public interface ContextSet extends Iterable<Map.Entry<String, String>> {
      * {@link #isImmutable() mutability} of this set.</p>
      *
      * @return a mutable ContextSet
-     * @since 2.16
      */
     @NonNull MutableContextSet mutableCopy();
 
     /**
-     * Returns a {@link Set} of {@link Map.Entry}s representing the current
+     * Returns a {@link Set} of {@link Context}s representing the current
      * state of this {@link ContextSet}.
      *
      * <p>The returned set is immutable, and is a copy of the current set.
@@ -185,7 +112,18 @@ public interface ContextSet extends Iterable<Map.Entry<String, String>> {
      *
      * @return an immutable set
      */
-    @NonNull Set<Map.Entry<String, String>> toSet();
+    @NonNull @Unmodifiable Set<Context> toSet();
+
+    /**
+     * Returns a {@link Map} representing the current state of this
+     * {@link ContextSet}.
+     *
+     * <p>The returned set is immutable, and is a copy of the current set.
+     * (will not update live)</p>
+     *
+     * @return a map
+     */
+    @NonNull @Unmodifiable Map<String, Set<String>> toMap();
 
     /**
      * Returns a {@link Map} <b>loosely</b> representing the current state of
@@ -197,27 +135,11 @@ public interface ContextSet extends Iterable<Map.Entry<String, String>> {
      * <p>As a single context key can be mapped to multiple values, this method
      * may not be a true representation of the set.</p>
      *
-     * <p>If you need a representation of the set in a Java collection instance,
-     * use {@link #toSet()} or {@link #toMultimap()} followed by
-     * {@link Multimap#asMap()}.</p>
-     *
      * @return an immutable map
-     * @deprecated because the resultant map may not contain all data in the ContextSet
+     * @deprecated Deprecated because the returned map may not contain all data in the ContextSet
      */
     @Deprecated
-    @NonNull Map<String, String> toMap();
-
-    /**
-     * Returns a {@link Multimap} representing the current state of this
-     * {@link ContextSet}.
-     *
-     * <p>The returned multimap is immutable, and is a copy of the current set.
-     * (will not update live)</p>
-     *
-     * @return a multimap
-     * @since 2.16
-     */
-    @NonNull Multimap<String, String> toMultimap();
+    @NonNull @Unmodifiable Map<String, String> toFlattenedMap();
 
     /**
      * Returns an {@link Iterator} over each of the context pairs in this set.
@@ -230,7 +152,7 @@ public interface ContextSet extends Iterable<Map.Entry<String, String>> {
      * @return an iterator
      */
     @Override
-    @NonNull Iterator<Map.Entry<String, String>> iterator();
+    @NonNull @Unmodifiable Iterator<Context> iterator();
 
     /**
      * Returns if the {@link ContextSet} contains at least one value for the
@@ -252,7 +174,7 @@ public interface ContextSet extends Iterable<Map.Entry<String, String>> {
      * @return a set of values
      * @throws NullPointerException if the key is null
      */
-    @NonNull Set<String> getValues(@NonNull String key);
+    @NonNull @Unmodifiable Set<String> getValues(@NonNull String key);
 
     /**
      * Returns any value from this {@link ContextSet} matching the key, if present.
@@ -262,7 +184,6 @@ public interface ContextSet extends Iterable<Map.Entry<String, String>> {
      *
      * @param key the key to find values for
      * @return an optional containing any match
-     * @since 3.1
      */
     default @NonNull Optional<String> getAnyValue(@NonNull String key) {
         return getValues(key).stream().findAny();
@@ -276,7 +197,7 @@ public interface ContextSet extends Iterable<Map.Entry<String, String>> {
      * @return true if the set contains the context pair
      * @throws NullPointerException if the key or value is null
      */
-    boolean has(@NonNull String key, @NonNull String value);
+    boolean contains(@NonNull String key, @NonNull String value);
 
     /**
      * Returns if the {@link ContextSet} contains a given context pairing.
@@ -285,49 +206,54 @@ public interface ContextSet extends Iterable<Map.Entry<String, String>> {
      * @return true if the set contains the context pair
      * @throws NullPointerException if the key or value is null
      */
-    default boolean has(Map.@NonNull Entry<String, String> entry) {
+    default boolean contains(@NonNull Context entry) {
         Objects.requireNonNull(entry, "entry");
-        return has(entry.getKey(), entry.getValue());
+        return contains(entry.getKey(), entry.getValue());
     }
 
     /**
-     * Returns if this {@link ContextSet} is fully "satisfied" by another set.
+     * Returns if the {@link ContextSet} contains any of the given context pairings.
      *
-     * <p>For a context set to "satisfy" another, it must itself contain all of
-     * the context pairings in the other set.</p>
+     * @param key the key to look for
+     * @param values the values to look for
+     * @return true if the set contains any of the pairs
+     * @since 5.2
+     */
+    default boolean containsAny(@NonNull String key, @NonNull Iterable<String> values) {
+        Objects.requireNonNull(key, "key");
+        Objects.requireNonNull(values, "values");
+
+        for (String value : values) {
+            if (contains(key, value)) {
+                return true;
+            }
+        }
+        return false;
+    }
+
+    /**
+     * Returns if this {@link ContextSet} is "satisfied" by another set.
      *
-     * <p>Mathematically, this method returns true if this set is a <b>subset</b> of the other.</p>
+     * <p>{@link ContextSatisfyMode#AT_LEAST_ONE_VALUE_PER_KEY} is the mode used by this method.</p>
      *
-     * @param other the other set to check
-     * @return true if all entries in this set are also in the other set
-     * @since 3.1
+     * @param other the other set
+     * @return true if this context set is satisfied by the other
      */
     default boolean isSatisfiedBy(@NonNull ContextSet other) {
-        if (this == other) {
-            return true;
-        }
-
-        Objects.requireNonNull(other, "other");
-        if (this.isEmpty()) {
-            // this is empty, so is therefore always satisfied.
-            return true;
-        } else if (other.isEmpty()) {
-            // this set isn't empty, but the other one is
-            return false;
-        } else if (this.size() > other.size()) {
-            // this set has more unique entries than the other set, so there's no way this can be satisfied.
-            return false;
-        } else {
-            // neither are empty, we need to compare the individual entries
-            for (Map.Entry<String, String> context : toSet()) {
-                if (!other.has(context)) {
-                    return false;
-                }
-            }
-            return true;
-        }
+        return isSatisfiedBy(other, ContextSatisfyMode.AT_LEAST_ONE_VALUE_PER_KEY);
     }
 
+    /**
+     * Returns if this {@link ContextSet} is "satisfied" by another set, according to the given
+     * {@code mode}.
+     *
+     * @param other the other set
+     * @param mode the mode to use
+     * @return true if this context set is satisfied by the other
+     * @since 5.2
+     */
+    boolean isSatisfiedBy(@NonNull ContextSet other, @NonNull ContextSatisfyMode mode);
+
     /**
      * Returns if the {@link ContextSet} is empty.
      *

api/src/main/java/net/luckperms/api/context/ContextSetFactory.java

@@ -0,0 +1,74 @@
+/*
+ * This file is part of LuckPerms, licensed under the MIT License.
+ *
+ *  Copyright (c) lucko (Luck) <luck@lucko.me>
+ *  Copyright (c) contributors
+ *
+ *  Permission is hereby granted, free of charge, to any person obtaining a copy
+ *  of this software and associated documentation files (the "Software"), to deal
+ *  in the Software without restriction, including without limitation the rights
+ *  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ *  copies of the Software, and to permit persons to whom the Software is
+ *  furnished to do so, subject to the following conditions:
+ *
+ *  The above copyright notice and this permission notice shall be included in all
+ *  copies or substantial portions of the Software.
+ *
+ *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ *  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ *  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ *  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ *  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ *  SOFTWARE.
+ */
+
+package net.luckperms.api.context;
+
+import org.checkerframework.checker.nullness.qual.NonNull;
+import org.jetbrains.annotations.ApiStatus.Internal;
+
+/**
+ * A factory for creating {@link ContextSet}s.
+ *
+ * <p>Prefer using the static methods on {@link ImmutableContextSet} or {@link MutableContextSet}
+ * instead of this interface.</p>
+ */
+@Internal
+public interface ContextSetFactory {
+
+    /**
+     * Prefer using {@link ImmutableContextSet#builder()}.
+     *
+     * @return a immutable context set builder
+     * @see ImmutableContextSet#builder()
+     */
+    ImmutableContextSet.@NonNull Builder immutableBuilder();
+
+    /**
+     * Prefer using {@link ImmutableContextSet#of(String, String)}.
+     *
+     * @param key the key
+     * @param value the value
+     * @return an immutable context set
+     * @see ImmutableContextSet#of(String, String)
+     */
+    @NonNull ImmutableContextSet immutableOf(@NonNull String key, @NonNull String value);
+
+    /**
+     * Prefer using {@link ImmutableContextSet#empty()}.
+     *
+     * @return an empty immutable context set
+     * @see ImmutableContextSet#empty()
+     */
+    @NonNull ImmutableContextSet immutableEmpty();
+
+    /**
+     * Prefer using {@link MutableContextSet#create()}.
+     *
+     * @return a new mutable context set
+     * @see MutableContextSet#create()
+     */
+    @NonNull MutableContextSet mutable();
+
+}

api/src/main/java/net/luckperms/api/context/DefaultContextKeys.java

@@ -23,47 +23,42 @@
  *  SOFTWARE.
  */
 
-package me.lucko.luckperms.api.nodetype.types;
-
-import me.lucko.luckperms.api.Node;
-import me.lucko.luckperms.api.nodetype.NodeType;
-import me.lucko.luckperms.api.nodetype.NodeTypeKey;
-
-import org.checkerframework.checker.nullness.qual.NonNull;
-
-import java.util.Map;
+package net.luckperms.api.context;
 
 /**
- * A sub-type of {@link Node} used to store suffix assignments.
- *
- * @since 4.2
+ * Some default context keys used by the plugin.
  */
-public interface SuffixType extends NodeType {
+public final class DefaultContextKeys {
+    private DefaultContextKeys() {
+        throw new AssertionError();
+    }
 
     /**
-     * The key for this type.
+     * The context key used to denote the name of the subjects server.
      */
-    NodeTypeKey<SuffixType> KEY = new NodeTypeKey<SuffixType>(){};
+    public static final String SERVER_KEY = "server";
 
     /**
-     * Gets the priority of the suffix assignment.
+     * The context key used to denote the name of the subjects world.
+     */
+    public static final String WORLD_KEY = "world";
+
+    /**
+     * The context key used to denote the dimension type of the subjects world.
      *
-     * @return the priority
+     * <p>Possible values: overworld, the_nether, the_end</p>
+     *
+     * @since 5.3
      */
-    int getPriority();
+    public static final String DIMENSION_TYPE_KEY = "dimension-type";
 
     /**
-     * Gets the actual suffix string.
+     * The context key used to denote the subjects gamemode.
      *
-     * @return the suffix
-     */
-    @NonNull String getSuffix();
-
-    /**
-     * Gets a representation of this instance as a {@link Map.Entry}.
+     * <p>Possible values: survival, creative, adventure, spectator</p>
      *
-     * @return a map entry representation of the priority and suffix string
+     * @since 5.3
      */
-    Map.@NonNull Entry<Integer, String> getAsEntry();
+    public static final String GAMEMODE_KEY = "gamemode";
 
 }

api/src/main/java/net/luckperms/api/context/ImmutableContextSet.java

@@ -0,0 +1,139 @@
+/*
+ * This file is part of LuckPerms, licensed under the MIT License.
+ *
+ *  Copyright (c) lucko (Luck) <luck@lucko.me>
+ *  Copyright (c) contributors
+ *
+ *  Permission is hereby granted, free of charge, to any person obtaining a copy
+ *  of this software and associated documentation files (the "Software"), to deal
+ *  in the Software without restriction, including without limitation the rights
+ *  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ *  copies of the Software, and to permit persons to whom the Software is
+ *  furnished to do so, subject to the following conditions:
+ *
+ *  The above copyright notice and this permission notice shall be included in all
+ *  copies or substantial portions of the Software.
+ *
+ *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ *  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ *  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ *  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ *  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ *  SOFTWARE.
+ */
+
+package net.luckperms.api.context;
+
+import net.luckperms.api.LuckPermsProvider;
+
+import org.checkerframework.checker.nullness.qual.NonNull;
+
+import java.util.Objects;
+
+/**
+ * An immutable implementation of {@link ContextSet}.
+ */
+public interface ImmutableContextSet extends ContextSet {
+
+    /**
+     * Creates an {@link ImmutableContextSet.Builder}.
+     *
+     * @return a new ImmutableContextSet builder
+     */
+    static @NonNull Builder builder() {
+        return LuckPermsProvider.get().getContextManager().getContextSetFactory().immutableBuilder();
+    }
+
+    /**
+     * Returns an empty {@link ImmutableContextSet}.
+     *
+     * @return an empty ImmutableContextSet
+     */
+    static @NonNull ImmutableContextSet empty() {
+        return LuckPermsProvider.get().getContextManager().getContextSetFactory().immutableEmpty();
+    }
+
+    /**
+     * Creates an {@link ImmutableContextSet} from a context pair.
+     *
+     * @param key   the key
+     * @param value the value
+     * @return a new ImmutableContextSet containing one context pair
+     * @throws NullPointerException if key or value is null
+     */
+    static @NonNull ImmutableContextSet of(@NonNull String key, @NonNull String value) {
+        return LuckPermsProvider.get().getContextManager().getContextSetFactory().immutableOf(key, value);
+    }
+
+    /**
+     * @deprecated This context set is already immutable!
+     */
+    @Override
+    @Deprecated
+    @NonNull ImmutableContextSet immutableCopy();
+
+    /**
+     * A builder for {@link ImmutableContextSet}.
+     */
+    interface Builder {
+
+        /**
+         * Adds a context to the set.
+         *
+         * @param key   the key to add
+         * @param value the value to add
+         * @return the builder
+         * @throws NullPointerException if the key or value is null
+         * @see MutableContextSet#add(String, String)
+         */
+        @NonNull Builder add(@NonNull String key, @NonNull String value);
+
+        /**
+         * Adds a context to the set.
+         *
+         * @param entry the entry to add
+         * @return the builder
+         * @throws NullPointerException if the entry is null
+         * @see MutableContextSet#add(Context)
+         */
+        default @NonNull Builder add(@NonNull Context entry) {
+            Objects.requireNonNull(entry, "entry");
+            add(entry.getKey(), entry.getValue());
+            return this;
+        }
+
+        /**
+         * Adds the contexts contained in the given {@link Iterable} to the set.
+         *
+         * @param iterable an iterable of key value context pairs
+         * @return the builder
+         * @throws NullPointerException if iterable is null
+         * @see MutableContextSet#addAll(Iterable)
+         */
+        default @NonNull Builder addAll(@NonNull Iterable<Context> iterable) {
+            for (Context e : Objects.requireNonNull(iterable, "iterable")) {
+                add(e);
+            }
+            return this;
+        }
+
+        /**
+         * Adds of of the contexts in another {@link ContextSet} to the set.
+         *
+         * @param contextSet the set to add from
+         * @return the builder
+         * @throws NullPointerException if the contextSet is null
+         * @see MutableContextSet#addAll(ContextSet)
+         */
+        @NonNull Builder addAll(@NonNull ContextSet contextSet);
+
+        /**
+         * Creates a {@link ImmutableContextSet} from the values previously
+         * added to the builder.
+         *
+         * @return an {@link ImmutableContextSet} from the builder
+         */
+        @NonNull ImmutableContextSet build();
+    }
+}

api/src/main/java/net/luckperms/api/context/MutableContextSet.java

@@ -0,0 +1,126 @@
+/*
+ * This file is part of LuckPerms, licensed under the MIT License.
+ *
+ *  Copyright (c) lucko (Luck) <luck@lucko.me>
+ *  Copyright (c) contributors
+ *
+ *  Permission is hereby granted, free of charge, to any person obtaining a copy
+ *  of this software and associated documentation files (the "Software"), to deal
+ *  in the Software without restriction, including without limitation the rights
+ *  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ *  copies of the Software, and to permit persons to whom the Software is
+ *  furnished to do so, subject to the following conditions:
+ *
+ *  The above copyright notice and this permission notice shall be included in all
+ *  copies or substantial portions of the Software.
+ *
+ *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ *  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ *  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ *  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ *  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ *  SOFTWARE.
+ */
+
+package net.luckperms.api.context;
+
+import net.luckperms.api.LuckPermsProvider;
+
+import org.checkerframework.checker.nullness.qual.NonNull;
+
+import java.util.Objects;
+
+/**
+ * A mutable implementation of {@link ContextSet}.
+ */
+public interface MutableContextSet extends ContextSet {
+
+    /**
+     * Creates a new empty MutableContextSet.
+     *
+     * @return a new MutableContextSet
+     */
+    static @NonNull MutableContextSet create() {
+        return LuckPermsProvider.get().getContextManager().getContextSetFactory().mutable();
+    }
+
+    /**
+     * Creates a {@link MutableContextSet} from a context pair.
+     *
+     * @param key   the key
+     * @param value the value
+     * @return a new MutableContextSet containing one context pair
+     * @throws NullPointerException if key or value is null
+     */
+    static @NonNull MutableContextSet of(@NonNull String key, @NonNull String value) {
+        Objects.requireNonNull(key, "key");
+        Objects.requireNonNull(value, "value");
+        MutableContextSet set = create();
+        set.add(key, value);
+        return set;
+    }
+
+    /**
+     * Adds a context to this set.
+     *
+     * @param key   the key to add
+     * @param value the value to add
+     * @throws NullPointerException if the key or value is null
+     */
+    void add(@NonNull String key, @NonNull String value);
+
+    /**
+     * Adds a context to this set.
+     *
+     * @param entry the entry to add
+     * @throws NullPointerException if the entry is null
+     */
+    default void add(@NonNull Context entry) {
+        Objects.requireNonNull(entry, "entry");
+        add(entry.getKey(), entry.getValue());
+    }
+
+    /**
+     * Adds the contexts contained in the given {@link Iterable} to this set.
+     *
+     * @param iterable an iterable of key value context pairs
+     * @throws NullPointerException if iterable is null
+     */
+    default void addAll(@NonNull Iterable<Context> iterable) {
+        for (Context e : Objects.requireNonNull(iterable, "iterable")) {
+            add(e);
+        }
+    }
+
+    /**
+     * Adds of of the contexts in another {@link ContextSet} to this set.
+     *
+     * @param contextSet the set to add from
+     * @throws NullPointerException if the contextSet is null
+     */
+    void addAll(@NonNull ContextSet contextSet);
+
+    /**
+     * Removes a context from this set.
+     *
+     * @param key   the key to remove
+     * @param value the value to remove
+     * @throws NullPointerException if the key or value is null
+     */
+    void remove(@NonNull String key, @NonNull String value);
+
+    /**
+     * Removes all contexts from this set with the given key.
+     *
+     * @param key the key to remove
+     * @throws NullPointerException if the key is null
+     */
+    void removeAll(@NonNull String key);
+
+    /**
+     * Removes all contexts from the set.
+     */
+    void clear();
+
+}

api/src/main/java/net/luckperms/api/context/StaticContextCalculator.java

@@ -0,0 +1,75 @@
+/*
+ * This file is part of LuckPerms, licensed under the MIT License.
+ *
+ *  Copyright (c) lucko (Luck) <luck@lucko.me>
+ *  Copyright (c) contributors
+ *
+ *  Permission is hereby granted, free of charge, to any person obtaining a copy
+ *  of this software and associated documentation files (the "Software"), to deal
+ *  in the Software without restriction, including without limitation the rights
+ *  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ *  copies of the Software, and to permit persons to whom the Software is
+ *  furnished to do so, subject to the following conditions:
+ *
+ *  The above copyright notice and this permission notice shall be included in all
+ *  copies or substantial portions of the Software.
+ *
+ *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ *  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ *  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ *  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ *  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ *  SOFTWARE.
+ */
+
+package net.luckperms.api.context;
+
+import org.checkerframework.checker.nullness.qual.NonNull;
+
+import java.util.Objects;
+import java.util.function.Supplier;
+
+/**
+ * Extension of {@link ContextCalculator} which provides the same context
+ * regardless of the subject.
+ */
+@FunctionalInterface
+public interface StaticContextCalculator extends ContextCalculator<Object> {
+
+    /**
+     * Creates a new {@link StaticContextCalculator} that provides a single context.
+     *
+     * @param key the key of the context provided by the calculator
+     * @param valueFunction the function used to compute the corresponding value
+     *                      for each query. A context will not be "accumulated"
+     *                      if the value returned is null.
+     * @return the resultant calculator
+     */
+    static StaticContextCalculator forSingleContext(String key, Supplier<String> valueFunction) {
+        Objects.requireNonNull(key, "key");
+        Objects.requireNonNull(valueFunction, "valueFunction");
+        return consumer -> {
+            String value = valueFunction.get();
+            if (value != null) {
+                consumer.accept(key, value);
+            }
+        };
+    }
+
+    /**
+     * Submits any contexts this calculator determines to be applicable.
+     *
+     * <p>Care should be taken to ensure implementations of this method meet the
+     * general requirements for {@link ContextCalculator}, defined in the class
+     * doc.</p>
+     *
+     * @param consumer the {@link ContextConsumer} to submit contexts to
+     */
+    void calculate(@NonNull ContextConsumer consumer);
+
+    @Override
+    default void calculate(@NonNull Object target, @NonNull ContextConsumer consumer) {
+        calculate(consumer);
+    }
+}

api/src/main/java/net/luckperms/api/context/package-info.java

@@ -0,0 +1,30 @@
+/*
+ * This file is part of LuckPerms, licensed under the MIT License.
+ *
+ *  Copyright (c) lucko (Luck) <luck@lucko.me>
+ *  Copyright (c) contributors
+ *
+ *  Permission is hereby granted, free of charge, to any person obtaining a copy
+ *  of this software and associated documentation files (the "Software"), to deal
+ *  in the Software without restriction, including without limitation the rights
+ *  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ *  copies of the Software, and to permit persons to whom the Software is
+ *  furnished to do so, subject to the following conditions:
+ *
+ *  The above copyright notice and this permission notice shall be included in all
+ *  copies or substantial portions of the Software.
+ *
+ *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ *  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ *  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ *  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ *  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ *  SOFTWARE.
+ */
+
+/**
+ * Context functionality, including {@link net.luckperms.api.context.ContextSet}s and
+ * {@link net.luckperms.api.context.ContextCalculator}s.
+ */
+package net.luckperms.api.context;

api/src/main/java/net/luckperms/api/event/EventBus.java

@@ -23,9 +23,10 @@
  *  SOFTWARE.
  */
 
-package me.lucko.luckperms.api.event;
+package net.luckperms.api.event;
 
 import org.checkerframework.checker.nullness.qual.NonNull;
+import org.jetbrains.annotations.Unmodifiable;
 
 import java.util.Set;
 import java.util.function.Consumer;
@@ -34,15 +35,13 @@ import java.util.function.Consumer;
  * The LuckPerms event bus.
  *
  * <p>Used to subscribe (or "listen") to LuckPerms events.</p>
- *
- * @since 3.0
  */
 public interface EventBus {
 
     /**
      * Registers a new subscription to the given event.
      *
-     * <p>The returned {@link EventHandler} instance encapsulates the subscription state. It has
+     * <p>The returned {@link EventSubscription} instance encapsulates the subscription state. It has
      * methods which can be used to terminate the subscription, or view stats about the nature of
      * the subscription.</p>
      *
@@ -51,18 +50,18 @@ public interface EventBus {
      * @param <T>        the event class
      * @return an event handler instance representing this subscription
      */
-    @NonNull <T extends LuckPermsEvent> EventHandler<T> subscribe(@NonNull Class<T> eventClass, @NonNull Consumer<? super T> handler);
+    <T extends LuckPermsEvent> @NonNull EventSubscription<T> subscribe(@NonNull Class<T> eventClass, @NonNull Consumer<? super T> handler);
 
     /**
      * Registers a new subscription to the given event.
      *
-     * <p>The returned {@link EventHandler} instance encapsulates the subscription state. It has
+     * <p>The returned {@link EventSubscription} instance encapsulates the subscription state. It has
      * methods which can be used to terminate the subscription, or view stats about the nature of
      * the subscription.</p>
      *
      * <p>Unlike {@link #subscribe(Class, Consumer)}, this method accepts an additional parameter
      * for {@code plugin}. This object must be a "plugin" instance on the platform, and is used to
-     * automatically {@link EventHandler#unregister() unregister} the subscription when the
+     * automatically {@link EventSubscription#close() unregister} the subscription when the
      * corresponding plugin is disabled.</p>
      *
      * @param <T>        the event class
@@ -71,7 +70,7 @@ public interface EventBus {
      * @param handler    the event handler
      * @return an event handler instance representing this subscription
      */
-    @NonNull <T extends LuckPermsEvent> EventHandler<T> subscribe(Object plugin, @NonNull Class<T> eventClass, @NonNull Consumer<? super T> handler);
+    <T extends LuckPermsEvent> @NonNull EventSubscription<T> subscribe(Object plugin, @NonNull Class<T> eventClass, @NonNull Consumer<? super T> handler);
 
     /**
      * Gets a set of all registered handlers for a given event.
@@ -80,6 +79,6 @@ public interface EventBus {
      * @param <T>        the event class
      * @return an immutable set of event handlers
      */
-    @NonNull <T extends LuckPermsEvent> Set<EventHandler<T>> getHandlers(@NonNull Class<T> eventClass);
+    <T extends LuckPermsEvent> @NonNull @Unmodifiable Set<EventSubscription<T>> getSubscriptions(@NonNull Class<T> eventClass);
 
 }

api/src/main/java/net/luckperms/api/event/EventSubscription.java

@@ -23,7 +23,7 @@
  *  SOFTWARE.
  */
 
-package me.lucko.luckperms.api.event;
+package net.luckperms.api.event;
 
 import org.checkerframework.checker.nullness.qual.NonNull;
 
@@ -34,7 +34,7 @@ import java.util.function.Consumer;
  *
  * @param <T> the event class
  */
-public interface EventHandler<T extends LuckPermsEvent> extends AutoCloseable {
+public interface EventSubscription<T extends LuckPermsEvent> extends AutoCloseable {
 
     /**
      * Gets the class this handler is listening to
@@ -51,28 +51,15 @@ public interface EventHandler<T extends LuckPermsEvent> extends AutoCloseable {
     boolean isActive();
 
     /**
-     * Unregisters this handler from the event bus
-     *
-     * @return true if the handler wasn't already unregistered
+     * Unregisters this handler from the event bus.
      */
-    boolean unregister();
+    @Override
+    void close();
 
     /**
      * Gets the event consumer responsible for handling the event
      *
      * @return the event consumer
      */
-    @NonNull Consumer<? super T> getConsumer();
-
-    /**
-     * Gets the number of times this handler has been called
-     *
-     * @return the number of times this handler has been called
-     */
-    int getCallCount();
-
-    @Override
-    default void close() {
-        unregister();
-    }
+    @NonNull Consumer<? super T> getHandler();
 }

api/src/main/java/net/luckperms/api/event/LuckPermsEvent.java

@@ -23,16 +23,14 @@
  *  SOFTWARE.
  */
 
-package me.lucko.luckperms.api.event;
+package net.luckperms.api.event;
 
-import me.lucko.luckperms.api.LuckPermsApi;
+import net.luckperms.api.LuckPerms;
 
 import org.checkerframework.checker.nullness.qual.NonNull;
 
 /**
  * A superinterface for all LuckPerms events.
- *
- * @since 3.0
  */
 public interface LuckPermsEvent {
 
@@ -41,13 +39,12 @@ public interface LuckPermsEvent {
      *
      * @return the api instance
      */
-    @NonNull LuckPermsApi getApi();
+    @NonNull LuckPerms getLuckPerms();
 
     /**
      * Gets the type of the event.
      *
      * @return the type of the event
-     * @since 4.4
      */
     @NonNull Class<? extends LuckPermsEvent> getEventType();
 

api/src/main/java/net/luckperms/api/event/cause/CreationCause.java

@@ -23,7 +23,7 @@
  *  SOFTWARE.
  */
 
-package me.lucko.luckperms.api.event.cause;
+package net.luckperms.api.event.cause;
 
 /**
  * The cause of a group/track creation
@@ -35,6 +35,11 @@ public enum CreationCause {
      */
     COMMAND,
 
+    /**
+     * The creation was caused by the web editor
+     */
+    WEB_EDITOR,
+
     /**
      * The creation was caused by an API call
      */

api/src/main/java/net/luckperms/api/event/cause/DeletionCause.java

@@ -23,7 +23,7 @@
  *  SOFTWARE.
  */
 
-package me.lucko.luckperms.api.event.cause;
+package net.luckperms.api.event.cause;
 
 /**
  * The cause of a group/track deletion
@@ -35,6 +35,12 @@ public enum DeletionCause {
      */
     COMMAND,
 
+    /**
+     * The deletion was caused by the web editor
+     * @since 5.3
+     */
+    WEB_EDITOR,
+
     /**
      * The deletion was caused by an API call
      */

api/src/main/java/net/luckperms/api/event/cause/package-info.java

@@ -0,0 +1,29 @@
+/*
+ * This file is part of LuckPerms, licensed under the MIT License.
+ *
+ *  Copyright (c) lucko (Luck) <luck@lucko.me>
+ *  Copyright (c) contributors
+ *
+ *  Permission is hereby granted, free of charge, to any person obtaining a copy
+ *  of this software and associated documentation files (the "Software"), to deal
+ *  in the Software without restriction, including without limitation the rights
+ *  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ *  copies of the Software, and to permit persons to whom the Software is
+ *  furnished to do so, subject to the following conditions:
+ *
+ *  The above copyright notice and this permission notice shall be included in all
+ *  copies or substantial portions of the Software.
+ *
+ *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ *  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ *  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ *  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ *  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ *  SOFTWARE.
+ */
+
+/**
+ * Event causes.
+ */
+package net.luckperms.api.event.cause;

api/src/main/java/net/luckperms/api/event/context/ContextUpdateEvent.java

@@ -0,0 +1,76 @@
+/*
+ * This file is part of LuckPerms, licensed under the MIT License.
+ *
+ *  Copyright (c) lucko (Luck) <luck@lucko.me>
+ *  Copyright (c) contributors
+ *
+ *  Permission is hereby granted, free of charge, to any person obtaining a copy
+ *  of this software and associated documentation files (the "Software"), to deal
+ *  in the Software without restriction, including without limitation the rights
+ *  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ *  copies of the Software, and to permit persons to whom the Software is
+ *  furnished to do so, subject to the following conditions:
+ *
+ *  The above copyright notice and this permission notice shall be included in all
+ *  copies or substantial portions of the Software.
+ *
+ *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ *  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ *  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ *  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ *  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ *  SOFTWARE.
+ */
+
+package net.luckperms.api.event.context;
+
+import net.luckperms.api.context.ContextManager;
+import net.luckperms.api.event.LuckPermsEvent;
+import net.luckperms.api.event.util.Param;
+
+import org.checkerframework.checker.nullness.qual.NonNull;
+
+import java.util.Optional;
+
+/**
+ * Called when a subject's current/active contexts are updated.
+ *
+ * <p>There are no guarantees that this event will be called for every update. It is merely to be
+ * used as a "hint" for plugins which depend on the current active contexts for a player.</p>
+ *
+ * <p>It will always be fired following a call to
+ * {@link ContextManager#signalContextUpdate(Object)}.</p>
+ *
+ * <p>The {@link #getSubject() subject} is always an instance of the platform's subject type. See
+ * {@link ContextManager} for details.</p>
+ *
+ * <p>Unlike most other LuckPerms events, this event is not fired asynchronously. Care should be
+ * taken to ensure listeners are lightweight. Additionally, listeners should ensure they do not
+ * cause further updates to player context, thus possibly causing a stack overflow.</p>
+ *
+ * @since 5.2
+ */
+public interface ContextUpdateEvent extends LuckPermsEvent {
+
+    /**
+     * Gets the subject whose contexts were updated.
+     *
+     * @return the subject
+     */
+    @Param(0)
+    @NonNull Object getSubject();
+
+    /**
+     * Gets the subject whose contexts were updated, casted to a given type.
+     *
+     * @param subjectClass the type to cast to
+     * @param <T> the subject type
+     * @return the casted subject
+     */
+    default <T> @NonNull Optional<T> getSubject(@NonNull Class<T> subjectClass) {
+        Object subject = getSubject();
+        return subjectClass.isInstance(subject) ? Optional.of(subjectClass.cast(subject)) : Optional.empty();
+    }
+
+}

api/src/main/java/net/luckperms/api/event/context/package-info.java

@@ -0,0 +1,29 @@
+/*
+ * This file is part of LuckPerms, licensed under the MIT License.
+ *
+ *  Copyright (c) lucko (Luck) <luck@lucko.me>
+ *  Copyright (c) contributors
+ *
+ *  Permission is hereby granted, free of charge, to any person obtaining a copy
+ *  of this software and associated documentation files (the "Software"), to deal
+ *  in the Software without restriction, including without limitation the rights
+ *  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ *  copies of the Software, and to permit persons to whom the Software is
+ *  furnished to do so, subject to the following conditions:
+ *
+ *  The above copyright notice and this permission notice shall be included in all
+ *  copies or substantial portions of the Software.
+ *
+ *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ *  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ *  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ *  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ *  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ *  SOFTWARE.
+ */
+
+/**
+ * Events relating to {@link net.luckperms.api.context.Context}s.
+ */
+package net.luckperms.api.event.context;

api/src/main/java/net/luckperms/api/event/extension/ExtensionLoadEvent.java

@@ -23,27 +23,25 @@
  *  SOFTWARE.
  */
 
-package me.lucko.luckperms.api.messenger.message.type;
+package net.luckperms.api.event.extension;
 
-import me.lucko.luckperms.api.LogEntry;
-import me.lucko.luckperms.api.messenger.message.Message;
+import net.luckperms.api.event.LuckPermsEvent;
+import net.luckperms.api.event.util.Param;
+import net.luckperms.api.extension.Extension;
 
 import org.checkerframework.checker.nullness.qual.NonNull;
 
 /**
- * Represents an "log" message.
- *
- * <p>Used to dispatch live log updates to other servers.</p>
- *
- * @since 4.1
+ * Called when an {@link Extension} is loaded.
  */
-public interface LogMessage extends Message {
+public interface ExtensionLoadEvent extends LuckPermsEvent {
 
     /**
-     * Gets the log entry being sent
+     * Gets the extension that was loaded.
      *
-     * @return the log entry
+     * @return the extension
      */
-    @NonNull LogEntry getLogEntry();
+    @Param(0)
+    @NonNull Extension getExtension();
 
 }

api/src/main/java/net/luckperms/api/event/extension/package-info.java

@@ -0,0 +1,29 @@
+/*
+ * This file is part of LuckPerms, licensed under the MIT License.
+ *
+ *  Copyright (c) lucko (Luck) <luck@lucko.me>
+ *  Copyright (c) contributors
+ *
+ *  Permission is hereby granted, free of charge, to any person obtaining a copy
+ *  of this software and associated documentation files (the "Software"), to deal
+ *  in the Software without restriction, including without limitation the rights
+ *  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ *  copies of the Software, and to permit persons to whom the Software is
+ *  furnished to do so, subject to the following conditions:
+ *
+ *  The above copyright notice and this permission notice shall be included in all
+ *  copies or substantial portions of the Software.
+ *
+ *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ *  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ *  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ *  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ *  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ *  SOFTWARE.
+ */
+
+/**
+ * Events relating to {@link net.luckperms.api.extension.Extension}s.
+ */
+package net.luckperms.api.event.extension;

api/src/main/java/net/luckperms/api/event/group/GroupCacheLoadEvent.java

@@ -23,19 +23,17 @@
  *  SOFTWARE.
  */
 
-package me.lucko.luckperms.api.event.group;
+package net.luckperms.api.event.group;
 
-import me.lucko.luckperms.api.Group;
-import me.lucko.luckperms.api.caching.GroupData;
-import me.lucko.luckperms.api.event.LuckPermsEvent;
-import me.lucko.luckperms.api.event.Param;
+import net.luckperms.api.cacheddata.CachedDataManager;
+import net.luckperms.api.event.LuckPermsEvent;
+import net.luckperms.api.event.util.Param;
+import net.luckperms.api.model.group.Group;
 
 import org.checkerframework.checker.nullness.qual.NonNull;
 
 /**
- * Called when a groups {@link GroupData} is loaded.
- *
- * @since 4.0
+ * Called when a groups {@link CachedDataManager} is loaded.
  */
 public interface GroupCacheLoadEvent extends LuckPermsEvent {
 
@@ -44,13 +42,15 @@ public interface GroupCacheLoadEvent extends LuckPermsEvent {
      *
      * @return the group
      */
-    @NonNull @Param(0) Group getGroup();
+    @Param(0)
+    @NonNull Group getGroup();
 
     /**
      * Gets the data that was loaded
      *
      * @return the loaded data
      */
-    @NonNull @Param(1) GroupData getLoadedData();
+    @Param(1)
+    @NonNull CachedDataManager getLoadedData();
 
 }

api/src/main/java/net/luckperms/api/event/group/GroupCreateEvent.java

@@ -23,12 +23,12 @@
  *  SOFTWARE.
  */
 
-package me.lucko.luckperms.api.event.group;
+package net.luckperms.api.event.group;
 
-import me.lucko.luckperms.api.Group;
-import me.lucko.luckperms.api.event.LuckPermsEvent;
-import me.lucko.luckperms.api.event.Param;
-import me.lucko.luckperms.api.event.cause.CreationCause;
+import net.luckperms.api.event.LuckPermsEvent;
+import net.luckperms.api.event.cause.CreationCause;
+import net.luckperms.api.event.util.Param;
+import net.luckperms.api.model.group.Group;
 
 import org.checkerframework.checker.nullness.qual.NonNull;
 
@@ -42,13 +42,15 @@ public interface GroupCreateEvent extends LuckPermsEvent {
      *
      * @return the new group
      */
-    @NonNull @Param(0) Group getGroup();
+    @Param(0)
+    @NonNull Group getGroup();
 
     /**
      * Gets the cause of the creation
      *
      * @return the cause of the creation
      */
-    @NonNull @Param(1) CreationCause getCause();
+    @Param(1)
+    @NonNull CreationCause getCause();
 
 }

api/src/main/java/net/luckperms/api/event/group/GroupDataRecalculateEvent.java

@@ -23,19 +23,17 @@
  *  SOFTWARE.
  */
 
-package me.lucko.luckperms.api.event.group;
+package net.luckperms.api.event.group;
 
-import me.lucko.luckperms.api.Group;
-import me.lucko.luckperms.api.caching.GroupData;
-import me.lucko.luckperms.api.event.LuckPermsEvent;
-import me.lucko.luckperms.api.event.Param;
+import net.luckperms.api.cacheddata.CachedDataManager;
+import net.luckperms.api.event.LuckPermsEvent;
+import net.luckperms.api.event.util.Param;
+import net.luckperms.api.model.group.Group;
 
 import org.checkerframework.checker.nullness.qual.NonNull;
 
 /**
  * Called when a groups cached data is refreshed
- *
- * @since 4.0
  */
 public interface GroupDataRecalculateEvent extends LuckPermsEvent {
 
@@ -44,13 +42,15 @@ public interface GroupDataRecalculateEvent extends LuckPermsEvent {
      *
      * @return the group
      */
-    @NonNull @Param(0) Group getGroup();
+    @Param(0)
+    @NonNull Group getGroup();
 
     /**
      * Gets the data that was recalculated
      *
      * @return the data
      */
-    @NonNull @Param(1) GroupData getData();
+    @Param(1)
+    @NonNull CachedDataManager getData();
 
 }

api/src/main/java/net/luckperms/api/event/group/GroupDeleteEvent.java

@@ -23,12 +23,12 @@
  *  SOFTWARE.
  */
 
-package me.lucko.luckperms.api.event.group;
+package net.luckperms.api.event.group;
 
-import me.lucko.luckperms.api.Node;
-import me.lucko.luckperms.api.event.LuckPermsEvent;
-import me.lucko.luckperms.api.event.Param;
-import me.lucko.luckperms.api.event.cause.DeletionCause;
+import net.luckperms.api.event.LuckPermsEvent;
+import net.luckperms.api.event.cause.DeletionCause;
+import net.luckperms.api.event.util.Param;
+import net.luckperms.api.node.Node;
 
 import org.checkerframework.checker.nullness.qual.NonNull;
 
@@ -44,20 +44,23 @@ public interface GroupDeleteEvent extends LuckPermsEvent {
      *
      * @return the name of the deleted group
      */
-    @NonNull @Param(0) String getGroupName();
+    @Param(0)
+    @NonNull String getGroupName();
 
     /**
      * Gets an immutable copy of the groups existing data
      *
      * @return a copy of the groups existing data
      */
-    @NonNull @Param(1) Set<Node> getExistingData();
+    @Param(1)
+    @NonNull Set<Node> getExistingData();
 
     /**
      * Gets the cause of the deletion
      *
      * @return the cause of the deletion
      */
-    @NonNull @Param(2) DeletionCause getCause();
+    @Param(2)
+    @NonNull DeletionCause getCause();
 
 }

api/src/main/java/net/luckperms/api/event/group/GroupLoadAllEvent.java

@@ -23,9 +23,9 @@
  *  SOFTWARE.
  */
 
-package me.lucko.luckperms.api.event.group;
+package net.luckperms.api.event.group;
 
-import me.lucko.luckperms.api.event.LuckPermsEvent;
+import net.luckperms.api.event.LuckPermsEvent;
 
 /**
  * Called when all groups have been loaded in from storage.

api/src/main/java/net/luckperms/api/event/group/GroupLoadEvent.java

@@ -23,11 +23,11 @@
  *  SOFTWARE.
  */
 
-package me.lucko.luckperms.api.event.group;
+package net.luckperms.api.event.group;
 
-import me.lucko.luckperms.api.Group;
-import me.lucko.luckperms.api.event.LuckPermsEvent;
-import me.lucko.luckperms.api.event.Param;
+import net.luckperms.api.event.LuckPermsEvent;
+import net.luckperms.api.event.util.Param;
+import net.luckperms.api.model.group.Group;
 
 import org.checkerframework.checker.nullness.qual.NonNull;
 
@@ -43,6 +43,7 @@ public interface GroupLoadEvent extends LuckPermsEvent {
      *
      * @return the group that was loaded
      */
-    @NonNull @Param(0) Group getGroup();
+    @Param(0)
+    @NonNull Group getGroup();
 
 }

api/src/main/java/net/luckperms/api/event/group/package-info.java

@@ -0,0 +1,29 @@
+/*
+ * This file is part of LuckPerms, licensed under the MIT License.
+ *
+ *  Copyright (c) lucko (Luck) <luck@lucko.me>
+ *  Copyright (c) contributors
+ *
+ *  Permission is hereby granted, free of charge, to any person obtaining a copy
+ *  of this software and associated documentation files (the "Software"), to deal
+ *  in the Software without restriction, including without limitation the rights
+ *  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ *  copies of the Software, and to permit persons to whom the Software is
+ *  furnished to do so, subject to the following conditions:
+ *
+ *  The above copyright notice and this permission notice shall be included in all
+ *  copies or substantial portions of the Software.
+ *
+ *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ *  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ *  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ *  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ *  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ *  SOFTWARE.
+ */
+
+/**
+ * Events relating to {@link net.luckperms.api.model.group.Group}s.
+ */
+package net.luckperms.api.event.group;

api/src/main/java/net/luckperms/api/event/log/LogBroadcastEvent.java

@@ -23,12 +23,12 @@
  *  SOFTWARE.
  */
 
-package me.lucko.luckperms.api.event.log;
+package net.luckperms.api.event.log;
 
-import me.lucko.luckperms.api.LogEntry;
-import me.lucko.luckperms.api.event.Cancellable;
-import me.lucko.luckperms.api.event.LuckPermsEvent;
-import me.lucko.luckperms.api.event.Param;
+import net.luckperms.api.actionlog.Action;
+import net.luckperms.api.event.LuckPermsEvent;
+import net.luckperms.api.event.type.Cancellable;
+import net.luckperms.api.event.util.Param;
 
 import org.checkerframework.checker.nullness.qual.NonNull;
 
@@ -42,20 +42,19 @@ public interface LogBroadcastEvent extends LuckPermsEvent, Cancellable {
      *
      * @return the log entry to be broadcasted
      */
-    @NonNull @Param(0) LogEntry getEntry();
+    @Param(0)
+    @NonNull Action getEntry();
 
     /**
      * Gets where the log entry originated from.
      *
      * @return the origin of the log
-     * @since 3.3
      */
-    @NonNull @Param(1) Origin getOrigin();
+    @Param(1)
+    @NonNull Origin getOrigin();
 
     /**
      * Represents where a log entry is from
-     *
-     * @since 3.3
      */
     enum Origin {
 

api/src/main/java/net/luckperms/api/event/log/LogNetworkPublishEvent.java

@@ -23,12 +23,12 @@
  *  SOFTWARE.
  */
 
-package me.lucko.luckperms.api.event.log;
+package net.luckperms.api.event.log;
 
-import me.lucko.luckperms.api.LogEntry;
-import me.lucko.luckperms.api.event.Cancellable;
-import me.lucko.luckperms.api.event.LuckPermsEvent;
-import me.lucko.luckperms.api.event.Param;
+import net.luckperms.api.actionlog.Action;
+import net.luckperms.api.event.LuckPermsEvent;
+import net.luckperms.api.event.type.Cancellable;
+import net.luckperms.api.event.util.Param;
 
 import org.checkerframework.checker.nullness.qual.NonNull;
 
@@ -36,8 +36,6 @@ import java.util.UUID;
 
 /**
  * Called when a log is about to be published to the network via the MessagingService
- *
- * @since 3.3
  */
 public interface LogNetworkPublishEvent extends LuckPermsEvent, Cancellable {
 
@@ -46,13 +44,15 @@ public interface LogNetworkPublishEvent extends LuckPermsEvent, Cancellable {
      *
      * @return the id of the log entry being published
      */
-    @NonNull @Param(0) UUID getLogId();
+    @Param(0)
+    @NonNull UUID getLogId();
 
     /**
      * Gets the log entry to be published
      *
      * @return the log entry to be published
      */
-    @NonNull @Param(1) LogEntry getEntry();
+    @Param(1)
+    @NonNull Action getEntry();
 
 }

api/src/main/java/net/luckperms/api/event/log/LogNotifyEvent.java

@@ -23,13 +23,13 @@
  *  SOFTWARE.
  */
 
-package me.lucko.luckperms.api.event.log;
+package net.luckperms.api.event.log;
 
-import me.lucko.luckperms.api.Entity;
-import me.lucko.luckperms.api.LogEntry;
-import me.lucko.luckperms.api.event.Cancellable;
-import me.lucko.luckperms.api.event.LuckPermsEvent;
-import me.lucko.luckperms.api.event.Param;
+import net.luckperms.api.actionlog.Action;
+import net.luckperms.api.event.LuckPermsEvent;
+import net.luckperms.api.event.type.Cancellable;
+import net.luckperms.api.event.util.Param;
+import net.luckperms.api.platform.PlatformEntity;
 
 import org.checkerframework.checker.nullness.qual.NonNull;
 
@@ -40,8 +40,6 @@ import org.checkerframework.checker.nullness.qual.NonNull;
  * <p>This event is not called for players without the notify permission,
  * but is called for objects which are ignoring log notifications (called with
  * the cancelled flag set to true).</p>
- *
- * @since 4.1
  */
 public interface LogNotifyEvent extends LuckPermsEvent, Cancellable {
 
@@ -50,21 +48,24 @@ public interface LogNotifyEvent extends LuckPermsEvent, Cancellable {
      *
      * @return the log entry to be sent
      */
-    @NonNull @Param(0) LogEntry getEntry();
+    @Param(0)
+    @NonNull Action getEntry();
 
     /**
      * Gets where the log entry originated from.
      *
      * @return the origin of the log
      */
-    @NonNull @Param(1) Origin getOrigin();
+    @Param(1)
+    @NonNull Origin getOrigin();
 
     /**
      * Gets the object to be notified.
      *
      * @return the object to notify
      */
-    @NonNull @Param(2) Entity getNotifiable();
+    @Param(2)
+    @NonNull PlatformEntity getNotifiable();
 
     /**
      * Represents where a log entry is from

api/src/main/java/net/luckperms/api/event/log/LogPublishEvent.java

@@ -23,12 +23,12 @@
  *  SOFTWARE.
  */
 
-package me.lucko.luckperms.api.event.log;
+package net.luckperms.api.event.log;
 
-import me.lucko.luckperms.api.LogEntry;
-import me.lucko.luckperms.api.event.Cancellable;
-import me.lucko.luckperms.api.event.LuckPermsEvent;
-import me.lucko.luckperms.api.event.Param;
+import net.luckperms.api.actionlog.Action;
+import net.luckperms.api.event.LuckPermsEvent;
+import net.luckperms.api.event.type.Cancellable;
+import net.luckperms.api.event.util.Param;
 
 import org.checkerframework.checker.nullness.qual.NonNull;
 
@@ -42,6 +42,7 @@ public interface LogPublishEvent extends LuckPermsEvent, Cancellable {
      *
      * @return the log entry to be published
      */
-    @NonNull @Param(0) LogEntry getEntry();
+    @Param(0)
+    @NonNull Action getEntry();
 
 }

api/src/main/java/net/luckperms/api/event/log/LogReceiveEvent.java

@@ -23,11 +23,11 @@
  *  SOFTWARE.
  */
 
-package me.lucko.luckperms.api.event.log;
+package net.luckperms.api.event.log;
 
-import me.lucko.luckperms.api.LogEntry;
-import me.lucko.luckperms.api.event.LuckPermsEvent;
-import me.lucko.luckperms.api.event.Param;
+import net.luckperms.api.actionlog.Action;
+import net.luckperms.api.event.LuckPermsEvent;
+import net.luckperms.api.event.util.Param;
 
 import org.checkerframework.checker.nullness.qual.NonNull;
 
@@ -35,8 +35,6 @@ import java.util.UUID;
 
 /**
  * Called when a log entry is received via the MessagingService
- *
- * @since 3.3
  */
 public interface LogReceiveEvent extends LuckPermsEvent {
 
@@ -45,13 +43,15 @@ public interface LogReceiveEvent extends LuckPermsEvent {
      *
      * @return the id of the log entry being received
      */
-    @NonNull @Param(0) UUID getLogId();
+    @Param(0)
+    @NonNull UUID getLogId();
 
     /**
      * Gets the log entry being received
      *
      * @return the log entry being received
      */
-    @NonNull @Param(1) LogEntry getEntry();
+    @Param(1)
+    @NonNull Action getEntry();
 
 }

api/src/main/java/net/luckperms/api/event/log/package-info.java

@@ -0,0 +1,29 @@
+/*
+ * This file is part of LuckPerms, licensed under the MIT License.
+ *
+ *  Copyright (c) lucko (Luck) <luck@lucko.me>
+ *  Copyright (c) contributors
+ *
+ *  Permission is hereby granted, free of charge, to any person obtaining a copy
+ *  of this software and associated documentation files (the "Software"), to deal
+ *  in the Software without restriction, including without limitation the rights
+ *  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ *  copies of the Software, and to permit persons to whom the Software is
+ *  furnished to do so, subject to the following conditions:
+ *
+ *  The above copyright notice and this permission notice shall be included in all
+ *  copies or substantial portions of the Software.
+ *
+ *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ *  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ *  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ *  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ *  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ *  SOFTWARE.
+ */
+
+/**
+ * Events relating to the {@link net.luckperms.api.actionlog.ActionLog}.
+ */
+package net.luckperms.api.event.log;

api/src/main/java/net/luckperms/api/event/node/NodeAddEvent.java

@@ -23,29 +23,36 @@
  *  SOFTWARE.
  */
 
-package me.lucko.luckperms.api.nodetype;
+package net.luckperms.api.event.node;
+
+import net.luckperms.api.event.util.Param;
+import net.luckperms.api.node.Node;
 
 import org.checkerframework.checker.nullness.qual.NonNull;
+import org.jetbrains.annotations.Unmodifiable;
+
+import java.util.Collections;
+import java.util.HashSet;
+import java.util.Set;
 
 /**
- * Marks an instance used as a key for a {@link NodeType}.
- *
- * <p>A single instance of this interface is created and stored statically for
- * each sub-interface of {@link NodeType}.</p>
- *
- * @param <N> the type of the {@link NodeType} being indexed by this key
- * @since 4.2
+ * Called when a node is added to a holder
  */
-public interface NodeTypeKey<N extends NodeType> {
+public interface NodeAddEvent extends NodeMutateEvent {
 
     /**
-     * Gets the {@link Class#getSimpleName() class name} of the represented type.
+     * Gets the node that was added
      *
-     * @return the name of the represented type
+     * @return the node that was added
      */
-    default @NonNull String getTypeName() {
-        String name = getClass().getName();
-        return name.substring(name.lastIndexOf('.') + 1, name.length() - 2);
-    }
+    @Param(3)
+    @NonNull Node getNode();
 
+    @Override
+    default @NonNull @Unmodifiable Set<Node> getDataBefore() {
+        // Get data after, then reverse the action
+        Set<Node> nodes = new HashSet<>(this.getDataAfter());
+        nodes.remove(this.getNode());
+        return Collections.unmodifiableSet(nodes);
+    }
 }

api/src/main/java/net/luckperms/api/event/node/NodeClearEvent.java

@@ -0,0 +1,59 @@
+/*
+ * This file is part of LuckPerms, licensed under the MIT License.
+ *
+ *  Copyright (c) lucko (Luck) <luck@lucko.me>
+ *  Copyright (c) contributors
+ *
+ *  Permission is hereby granted, free of charge, to any person obtaining a copy
+ *  of this software and associated documentation files (the "Software"), to deal
+ *  in the Software without restriction, including without limitation the rights
+ *  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ *  copies of the Software, and to permit persons to whom the Software is
+ *  furnished to do so, subject to the following conditions:
+ *
+ *  The above copyright notice and this permission notice shall be included in all
+ *  copies or substantial portions of the Software.
+ *
+ *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ *  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ *  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ *  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ *  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ *  SOFTWARE.
+ */
+
+package net.luckperms.api.event.node;
+
+import net.luckperms.api.event.util.Param;
+import net.luckperms.api.node.Node;
+
+import org.checkerframework.checker.nullness.qual.NonNull;
+import org.jetbrains.annotations.Unmodifiable;
+
+import java.util.Collections;
+import java.util.HashSet;
+import java.util.Set;
+
+/**
+ * Called when a holder has their nodes cleared
+ */
+public interface NodeClearEvent extends NodeMutateEvent {
+
+    /**
+     * Gets the nodes that were cleared
+     *
+     * @return the nodes that were removed
+     * @since 5.3
+     */
+    @Param(3)
+    @NonNull @Unmodifiable Set<Node> getNodes();
+
+    @Override
+    default @NonNull @Unmodifiable Set<Node> getDataBefore() {
+        // Get data after, then reverse the action
+        Set<Node> nodes = new HashSet<>(this.getDataAfter());
+        nodes.addAll(this.getNodes());
+        return Collections.unmodifiableSet(nodes);
+    }
+}

api/src/main/java/net/luckperms/api/event/node/NodeMutateEvent.java

@@ -23,16 +23,18 @@
  *  SOFTWARE.
  */
 
-package me.lucko.luckperms.api.event.node;
+package net.luckperms.api.event.node;
 
-import me.lucko.luckperms.api.Group;
-import me.lucko.luckperms.api.Node;
-import me.lucko.luckperms.api.PermissionHolder;
-import me.lucko.luckperms.api.User;
-import me.lucko.luckperms.api.event.LuckPermsEvent;
-import me.lucko.luckperms.api.event.Param;
+import net.luckperms.api.event.LuckPermsEvent;
+import net.luckperms.api.event.util.Param;
+import net.luckperms.api.model.PermissionHolder;
+import net.luckperms.api.model.data.DataType;
+import net.luckperms.api.model.group.Group;
+import net.luckperms.api.model.user.User;
+import net.luckperms.api.node.Node;
 
 import org.checkerframework.checker.nullness.qual.NonNull;
+import org.jetbrains.annotations.Unmodifiable;
 
 import java.util.Set;
 
@@ -46,24 +48,34 @@ public interface NodeMutateEvent extends LuckPermsEvent {
      *
      * @return the event target
      */
-    @NonNull @Param(0) PermissionHolder getTarget();
+    @Param(0)
+    @NonNull PermissionHolder getTarget();
+
+    /**
+     * Gets the data type that was mutated.
+     *
+     * @return the data type
+     */
+    @Param(1)
+    @NonNull DataType getDataType();
 
     /**
      * Gets an immutable copy of the holders data before the change
      *
      * @return the data before the change
      */
-    @NonNull @Param(1) Set<Node> getDataBefore();
+    @NonNull @Unmodifiable Set<Node> getDataBefore();
 
     /**
      * Gets an immutable copy of the holders data after the change
      *
      * @return the data after the change
      */
-    @NonNull @Param(2) Set<Node> getDataAfter();
+    @Param(2)
+    @NonNull @Unmodifiable Set<Node> getDataAfter();
 
     /**
-     * Gets whether the target of this event is a {@link me.lucko.luckperms.api.User}
+     * Gets whether the target of this event is a {@link User}
      *
      * <p>This is equivalent to checking if getTarget() instanceof User</p>
      *
@@ -74,7 +86,7 @@ public interface NodeMutateEvent extends LuckPermsEvent {
     }
 
     /**
-     * Gets whether the target of this event is a {@link me.lucko.luckperms.api.Group}
+     * Gets whether the target of this event is a {@link Group}
      *
      * <p>This is equivalent to checking if getTarget() instanceof Group</p>
      *

api/src/main/java/net/luckperms/api/event/node/NodeRemoveEvent.java

@@ -0,0 +1,59 @@
+/*
+ * This file is part of LuckPerms, licensed under the MIT License.
+ *
+ *  Copyright (c) lucko (Luck) <luck@lucko.me>
+ *  Copyright (c) contributors
+ *
+ *  Permission is hereby granted, free of charge, to any person obtaining a copy
+ *  of this software and associated documentation files (the "Software"), to deal
+ *  in the Software without restriction, including without limitation the rights
+ *  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ *  copies of the Software, and to permit persons to whom the Software is
+ *  furnished to do so, subject to the following conditions:
+ *
+ *  The above copyright notice and this permission notice shall be included in all
+ *  copies or substantial portions of the Software.
+ *
+ *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ *  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ *  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ *  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ *  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ *  SOFTWARE.
+ */
+
+package net.luckperms.api.event.node;
+
+import net.luckperms.api.event.util.Param;
+import net.luckperms.api.node.Node;
+
+import org.checkerframework.checker.nullness.qual.NonNull;
+import org.jetbrains.annotations.Unmodifiable;
+
+import java.util.Collections;
+import java.util.HashSet;
+import java.util.Set;
+
+/**
+ * Called when a node is removed from a holder
+ */
+public interface NodeRemoveEvent extends NodeMutateEvent {
+
+    /**
+     * Gets the node that was removed
+     *
+     * @return the node that was removed
+     */
+    @Param(3)
+    @NonNull Node getNode();
+
+    @Override
+    default @NonNull @Unmodifiable Set<Node> getDataBefore() {
+        // Get data after, then reverse the action
+        Set<Node> nodes = new HashSet<>(this.getDataAfter());
+        nodes.add(this.getNode());
+        return Collections.unmodifiableSet(nodes);
+    }
+
+}

api/src/main/java/net/luckperms/api/event/node/package-info.java

@@ -0,0 +1,30 @@
+/*
+ * This file is part of LuckPerms, licensed under the MIT License.
+ *
+ *  Copyright (c) lucko (Luck) <luck@lucko.me>
+ *  Copyright (c) contributors
+ *
+ *  Permission is hereby granted, free of charge, to any person obtaining a copy
+ *  of this software and associated documentation files (the "Software"), to deal
+ *  in the Software without restriction, including without limitation the rights
+ *  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ *  copies of the Software, and to permit persons to whom the Software is
+ *  furnished to do so, subject to the following conditions:
+ *
+ *  The above copyright notice and this permission notice shall be included in all
+ *  copies or substantial portions of the Software.
+ *
+ *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ *  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ *  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ *  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ *  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ *  SOFTWARE.
+ */
+
+/**
+ * Events relating to changes to a {@link net.luckperms.api.model.user.User} or
+ * {@link net.luckperms.api.model.group.Group}s {@link net.luckperms.api.model.data.NodeMap}.
+ */
+package net.luckperms.api.event.node;

api/src/main/java/net/luckperms/api/event/package-info.java

@@ -0,0 +1,29 @@
+/*
+ * This file is part of LuckPerms, licensed under the MIT License.
+ *
+ *  Copyright (c) lucko (Luck) <luck@lucko.me>
+ *  Copyright (c) contributors
+ *
+ *  Permission is hereby granted, free of charge, to any person obtaining a copy
+ *  of this software and associated documentation files (the "Software"), to deal
+ *  in the Software without restriction, including without limitation the rights
+ *  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ *  copies of the Software, and to permit persons to whom the Software is
+ *  furnished to do so, subject to the following conditions:
+ *
+ *  The above copyright notice and this permission notice shall be included in all
+ *  copies or substantial portions of the Software.
+ *
+ *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ *  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ *  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ *  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ *  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ *  SOFTWARE.
+ */
+
+/**
+ * Main events package.
+ */
+package net.luckperms.api.event;

api/src/main/java/net/luckperms/api/event/player/PlayerDataSaveEvent.java

@@ -23,12 +23,12 @@
  *  SOFTWARE.
  */
 
-package me.lucko.luckperms.api.event.player;
+package net.luckperms.api.event.player;
 
-import me.lucko.luckperms.api.PlayerSaveResult;
-import me.lucko.luckperms.api.event.LuckPermsEvent;
-import me.lucko.luckperms.api.event.Param;
-import me.lucko.luckperms.api.manager.UserManager;
+import net.luckperms.api.event.LuckPermsEvent;
+import net.luckperms.api.event.util.Param;
+import net.luckperms.api.model.PlayerSaveResult;
+import net.luckperms.api.model.user.UserManager;
 
 import org.checkerframework.checker.nullness.qual.NonNull;
 
@@ -38,8 +38,6 @@ import java.util.UUID;
  * Called when player data is saved to the storage.
  *
  * <p>Data can be saved using {@link UserManager#savePlayerData(UUID, String)}.</p>
- *
- * @since 4.3
  */
 public interface PlayerDataSaveEvent extends LuckPermsEvent {
 
@@ -48,20 +46,23 @@ public interface PlayerDataSaveEvent extends LuckPermsEvent {
      *
      * @return the uuid
      */
-    @NonNull @Param(0) UUID getUuid();
+    @Param(0)
+    @NonNull UUID getUniqueId();
 
     /**
      * Gets the username that was saved.
      *
      * @return the username
      */
-    @NonNull @Param(1) String getUsername();
+    @Param(1)
+    @NonNull String getUsername();
 
     /**
      * Gets the result of the operation.
      *
      * @return the result
      */
-    @NonNull @Param(2) PlayerSaveResult getResult();
+    @Param(2)
+    @NonNull PlayerSaveResult getResult();
 
 }

api/src/main/java/net/luckperms/api/event/player/PlayerLoginProcessEvent.java

@@ -23,11 +23,12 @@
  *  SOFTWARE.
  */
 
-package me.lucko.luckperms.api.event.player;
+package net.luckperms.api.event.player;
 
-import me.lucko.luckperms.api.User;
-import me.lucko.luckperms.api.event.LuckPermsEvent;
-import me.lucko.luckperms.api.event.Param;
+import net.luckperms.api.event.LuckPermsEvent;
+import net.luckperms.api.event.util.Param;
+import net.luckperms.api.model.user.User;
+import net.luckperms.api.util.Result;
 
 import org.checkerframework.checker.nullness.qual.NonNull;
 import org.checkerframework.checker.nullness.qual.Nullable;
@@ -49,30 +50,31 @@ import java.util.UUID;
  * for all connections, even if the operation to load User data was not
  * successful. Note that LuckPerms will usually cancel the platform connection
  * event if data could not be loaded.</p>
- *
- * @since 4.4
  */
-public interface PlayerLoginProcessEvent extends LuckPermsEvent {
+public interface PlayerLoginProcessEvent extends LuckPermsEvent, Result {
 
     /**
      * Gets the UUID of the connection which was processed
      *
      * @return the uuid of the connection which was processed
      */
-    @NonNull @Param(0) UUID getUuid();
+    @Param(0)
+    @NonNull UUID getUniqueId();
 
     /**
      * Gets the username of the connection which was processed
      *
      * @return the username of the connection which was processed
      */
-    @NonNull @Param(1) String getUsername();
+    @Param(1)
+    @NonNull String getUsername();
 
     /**
      * Gets if the login was processed successfully.
      *
      * @return true if the login was successful
      */
+    @Override
     default boolean wasSuccessful() {
         return getUser() != null;
     }
@@ -85,6 +87,7 @@ public interface PlayerLoginProcessEvent extends LuckPermsEvent {
      *
      * @return the user instance
      */
-    @Nullable @Param(2) User getUser();
+    @Param(2)
+    @Nullable User getUser();
 
 }

api/src/main/java/net/luckperms/api/event/player/lookup/UniqueIdDetermineTypeEvent.java

@@ -23,77 +23,64 @@
  *  SOFTWARE.
  */
 
-package me.lucko.luckperms.api;
+package net.luckperms.api.event.player.lookup;
 
-import me.lucko.luckperms.api.context.ContextSet;
+import net.luckperms.api.event.LuckPermsEvent;
+import net.luckperms.api.event.type.ResultEvent;
+import net.luckperms.api.event.util.Param;
 
 import org.checkerframework.checker.nullness.qual.NonNull;
 
-import java.util.Optional;
-import java.util.OptionalLong;
+import java.util.Objects;
+import java.util.UUID;
 
 /**
- * A relationship between a {@link PermissionHolder} and a permission.
+ * Called when the platform needs to determine the type of a player's {@link UUID unique id}.
  *
- * @param <T> the identifier type of the holder
- * @since 2.17
+ * @since 5.3
  */
-public interface HeldPermission<T> {
+public interface UniqueIdDetermineTypeEvent extends LuckPermsEvent, ResultEvent<String> {
 
     /**
-     * Gets the holder of the permission
+     * The players UUID has been obtained by authenticating with the Mojang session servers.
      *
-     * @return the holder
+     * <p>Usually indicated by the UUID being {@link UUID#version() version} 4.</p>
      */
-    @NonNull T getHolder();
+    String TYPE_AUTHENTICATED = "authenticated";
 
     /**
-     * Gets the permission being held
+     * The players UUID has not been obtained through authentication, and instead is likely based
+     * on the username they connected with.
      *
-     * @return the permission
+     * <p>Usually indicated by the UUID being {@link UUID#version() version} 3.</p>
      */
-    @NonNull String getPermission();
+    String TYPE_UNAUTHENTICATED = "unauthenticated";
 
     /**
-     * Gets the value of the permission
+     * Gets the {@link UUID unique id} being queried.
      *
-     * @return the value
+     * @return the unique id
      */
-    boolean getValue();
+    @Param(0)
+    @NonNull UUID getUniqueId();
 
     /**
-     * Gets the server where the permission is held
+     * Gets the current result unique id type.
      *
-     * @return the server
+     * @return the type
      */
-    @NonNull Optional<String> getServer();
+    default @NonNull String getType() {
+        return result().get();
+    }
 
     /**
-     * Gets the world where the permission is held
+     * Sets the result unique id type.
      *
-     * @return the world
+     * @param type the type
      */
-    @NonNull Optional<String> getWorld();
-
-    /**
-     * Gets the time in unix time when the permission will expire
-     *
-     * @return the expiry time
-     */
-    @NonNull OptionalLong getExpiry();
-
-    /**
-     * Gets the extra context for the permission.
-     *
-     * @return the extra context
-     */
-    @NonNull ContextSet getContexts();
-
-    /**
-     * Converts this permission into a Node
-     *
-     * @return a Node copy of this permission
-     */
-    @NonNull Node asNode();
+    default void setType(@NonNull String type) {
+        Objects.requireNonNull(type, "type");
+        result().set(type);
+    }
 
 }

api/src/main/java/net/luckperms/api/event/player/lookup/UniqueIdLookupEvent.java

@@ -23,34 +23,39 @@
  *  SOFTWARE.
  */
 
-package me.lucko.luckperms.api.nodetype.types;
+package net.luckperms.api.event.player.lookup;
 
-import me.lucko.luckperms.api.Node;
-import me.lucko.luckperms.api.nodetype.NodeType;
-import me.lucko.luckperms.api.nodetype.NodeTypeKey;
+import net.luckperms.api.event.LuckPermsEvent;
+import net.luckperms.api.event.type.ResultEvent;
+import net.luckperms.api.event.util.Param;
 
 import org.checkerframework.checker.nullness.qual.NonNull;
+import org.checkerframework.checker.nullness.qual.Nullable;
+
+import java.util.UUID;
 
 /**
- * A sub-type of {@link Node} used to mark that the holder of the node should inherit
- * from another group.
+ * Called when the platform needs a unique id for a given username.
  *
- * @since 4.2
+ * @since 5.3
  */
-public interface InheritanceType extends NodeType {
+public interface UniqueIdLookupEvent extends LuckPermsEvent, ResultEvent<UUID> {
 
     /**
-     * The key for this type.
+     * Gets the username being looked up.
+     *
+     * @return the username
      */
-    NodeTypeKey<InheritanceType> KEY = new NodeTypeKey<InheritanceType>(){};
+    @Param(0)
+    @NonNull String getUsername();
 
     /**
-     * Gets the name of the group to be inherited.
+     * Sets the result unique id.
      *
-     * <p>This is no guarantee that this group exists.</p>
-     *
-     * @return the name of the group
+     * @param uniqueId the unique id
      */
-    @NonNull String getGroupName();
+    default void setUniqueId(@Nullable UUID uniqueId) {
+        result().set(uniqueId);
+    }
 
 }

api/src/main/java/net/luckperms/api/event/player/lookup/UsernameLookupEvent.java

@@ -23,31 +23,39 @@
  *  SOFTWARE.
  */
 
-package me.lucko.luckperms.api.nodetype.types;
+package net.luckperms.api.event.player.lookup;
 
-import me.lucko.luckperms.api.Node;
-import me.lucko.luckperms.api.nodetype.NodeType;
-import me.lucko.luckperms.api.nodetype.NodeTypeKey;
+import net.luckperms.api.event.LuckPermsEvent;
+import net.luckperms.api.event.type.ResultEvent;
+import net.luckperms.api.event.util.Param;
 
 import org.checkerframework.checker.nullness.qual.NonNull;
+import org.checkerframework.checker.nullness.qual.Nullable;
+
+import java.util.UUID;
 
 /**
- * A sub-type of {@link Node} used to mark the display name of the node's holder.
+ * Called when the platform needs a username for a given unique id.
  *
- * @since 4.2
+ * @since 5.3
  */
-public interface DisplayNameType extends NodeType {
+public interface UsernameLookupEvent extends LuckPermsEvent, ResultEvent<String> {
 
     /**
-     * The key for this type.
-     */
-    NodeTypeKey<DisplayNameType> KEY = new NodeTypeKey<DisplayNameType>(){};
-
-    /**
-     * Gets the display name.
+     * Gets the {@link UUID unique id} being looked up.
      *
-     * @return the display name
+     * @return the unique id
      */
-    @NonNull String getDisplayName();
+    @Param(0)
+    @NonNull UUID getUniqueId();
+
+    /**
+     * Sets the result username.
+     *
+     * @param username the username
+     */
+    default void setUsername(@Nullable String username) {
+        result().set(username);
+    }
 
 }

api/src/main/java/net/luckperms/api/event/player/lookup/UsernameValidityCheckEvent.java

@@ -0,0 +1,76 @@
+/*
+ * This file is part of LuckPerms, licensed under the MIT License.
+ *
+ *  Copyright (c) lucko (Luck) <luck@lucko.me>
+ *  Copyright (c) contributors
+ *
+ *  Permission is hereby granted, free of charge, to any person obtaining a copy
+ *  of this software and associated documentation files (the "Software"), to deal
+ *  in the Software without restriction, including without limitation the rights
+ *  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ *  copies of the Software, and to permit persons to whom the Software is
+ *  furnished to do so, subject to the following conditions:
+ *
+ *  The above copyright notice and this permission notice shall be included in all
+ *  copies or substantial portions of the Software.
+ *
+ *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ *  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ *  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ *  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ *  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ *  SOFTWARE.
+ */
+
+package net.luckperms.api.event.player.lookup;
+
+import net.luckperms.api.event.LuckPermsEvent;
+import net.luckperms.api.event.util.Param;
+
+import org.checkerframework.checker.nullness.qual.NonNull;
+
+import java.util.concurrent.atomic.AtomicBoolean;
+
+/**
+ * Called when the validity of a username is being tested.
+ *
+ * @since 5.3
+ */
+public interface UsernameValidityCheckEvent extends LuckPermsEvent {
+
+    /**
+     * Gets the username being tested.
+     *
+     * @return the username
+     */
+    @Param(0)
+    @NonNull String getUsername();
+
+    /**
+     * Gets the current validity state for the username.
+     *
+     * @return the validity state
+     */
+    @Param(1)
+    @NonNull AtomicBoolean validityState();
+
+    /**
+     * Gets if the username is currently considered to be valid.
+     *
+     * @return if the username is valid
+     */
+    default boolean isValid() {
+        return validityState().get();
+    }
+
+    /**
+     * Sets if the username should be considered valid or not.
+     *
+     * @param valid whether the username is valid
+     */
+    default void setValid(boolean valid) {
+        validityState().set(valid);
+    }
+
+}

api/src/main/java/net/luckperms/api/event/player/lookup/package-info.java

@@ -0,0 +1,29 @@
+/*
+ * This file is part of LuckPerms, licensed under the MIT License.
+ *
+ *  Copyright (c) lucko (Luck) <luck@lucko.me>
+ *  Copyright (c) contributors
+ *
+ *  Permission is hereby granted, free of charge, to any person obtaining a copy
+ *  of this software and associated documentation files (the "Software"), to deal
+ *  in the Software without restriction, including without limitation the rights
+ *  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ *  copies of the Software, and to permit persons to whom the Software is
+ *  furnished to do so, subject to the following conditions:
+ *
+ *  The above copyright notice and this permission notice shall be included in all
+ *  copies or substantial portions of the Software.
+ *
+ *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ *  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ *  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ *  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ *  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ *  SOFTWARE.
+ */
+
+/**
+ * Events relating to a player {@link java.util.UUID unique id} or username lookup.
+ */
+package net.luckperms.api.event.player.lookup;

api/src/main/java/net/luckperms/api/event/player/package-info.java

@@ -0,0 +1,29 @@
+/*
+ * This file is part of LuckPerms, licensed under the MIT License.
+ *
+ *  Copyright (c) lucko (Luck) <luck@lucko.me>
+ *  Copyright (c) contributors
+ *
+ *  Permission is hereby granted, free of charge, to any person obtaining a copy
+ *  of this software and associated documentation files (the "Software"), to deal
+ *  in the Software without restriction, including without limitation the rights
+ *  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ *  copies of the Software, and to permit persons to whom the Software is
+ *  furnished to do so, subject to the following conditions:
+ *
+ *  The above copyright notice and this permission notice shall be included in all
+ *  copies or substantial portions of the Software.
+ *
+ *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ *  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ *  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ *  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ *  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ *  SOFTWARE.
+ */
+
+/**
+ * Events relating to a player.
+ */
+package net.luckperms.api.event.player;

api/src/main/java/net/luckperms/api/event/source/EntitySource.java

@@ -23,16 +23,14 @@
  *  SOFTWARE.
  */
 
-package me.lucko.luckperms.api.event.source;
+package net.luckperms.api.event.source;
 
-import me.lucko.luckperms.api.Entity;
+import net.luckperms.api.platform.PlatformEntity;
 
 import org.checkerframework.checker.nullness.qual.NonNull;
 
 /**
- * Represents an {@link Entity} which was the {@link Source} of something.
- *
- * @since 4.1
+ * Represents an {@link PlatformEntity} which was the {@link Source} of something.
  */
 public interface EntitySource extends Source {
 
@@ -41,6 +39,6 @@ public interface EntitySource extends Source {
      *
      * @return the entity
      */
-    @NonNull Entity getEntity();
+    @NonNull PlatformEntity getEntity();
 
 }

api/src/main/java/net/luckperms/api/event/source/Source.java

@@ -23,9 +23,9 @@
  *  SOFTWARE.
  */
 
-package me.lucko.luckperms.api.event.source;
+package net.luckperms.api.event.source;
 
-import me.lucko.luckperms.api.Entity;
+import net.luckperms.api.platform.PlatformEntity;
 
 import org.checkerframework.checker.nullness.qual.NonNull;
 
@@ -33,8 +33,6 @@ import org.checkerframework.checker.nullness.qual.NonNull;
  * Represents the source of an event.
  *
  * <p>Could also be described as the "thing" that caused an event to occur.</p>
- *
- * @since 4.1
  */
 public interface Source {
 
@@ -51,7 +49,7 @@ public interface Source {
     enum Type {
 
         /**
-         * Represents an {@link Entity} source
+         * Represents an {@link PlatformEntity} source
          *
          * @see EntitySource
          */

api/src/main/java/net/luckperms/api/event/source/package-info.java

@@ -0,0 +1,29 @@
+/*
+ * This file is part of LuckPerms, licensed under the MIT License.
+ *
+ *  Copyright (c) lucko (Luck) <luck@lucko.me>
+ *  Copyright (c) contributors
+ *
+ *  Permission is hereby granted, free of charge, to any person obtaining a copy
+ *  of this software and associated documentation files (the "Software"), to deal
+ *  in the Software without restriction, including without limitation the rights
+ *  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ *  copies of the Software, and to permit persons to whom the Software is
+ *  furnished to do so, subject to the following conditions:
+ *
+ *  The above copyright notice and this permission notice shall be included in all
+ *  copies or substantial portions of the Software.
+ *
+ *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ *  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ *  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ *  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ *  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ *  SOFTWARE.
+ */
+
+/**
+ * Event sources.
+ */
+package net.luckperms.api.event.source;

api/src/main/java/net/luckperms/api/event/sync/ConfigReloadEvent.java

@@ -23,9 +23,9 @@
  *  SOFTWARE.
  */
 
-package me.lucko.luckperms.api.event.sync;
+package net.luckperms.api.event.sync;
 
-import me.lucko.luckperms.api.event.LuckPermsEvent;
+import net.luckperms.api.event.LuckPermsEvent;
 
 /**
  * Called when the configuration is reloaded

api/src/main/java/net/luckperms/api/event/sync/PostSyncEvent.java

@@ -23,9 +23,9 @@
  *  SOFTWARE.
  */
 
-package me.lucko.luckperms.api.event.sync;
+package net.luckperms.api.event.sync;
 
-import me.lucko.luckperms.api.event.LuckPermsEvent;
+import net.luckperms.api.event.LuckPermsEvent;
 
 /**
  * Called when an sync task has been completed

api/src/main/java/net/luckperms/api/event/sync/PreNetworkSyncEvent.java

@@ -23,11 +23,11 @@
  *  SOFTWARE.
  */
 
-package me.lucko.luckperms.api.event.sync;
+package net.luckperms.api.event.sync;
 
-import me.lucko.luckperms.api.event.Cancellable;
-import me.lucko.luckperms.api.event.LuckPermsEvent;
-import me.lucko.luckperms.api.event.Param;
+import net.luckperms.api.event.LuckPermsEvent;
+import net.luckperms.api.event.type.Cancellable;
+import net.luckperms.api.event.util.Param;
 
 import org.checkerframework.checker.nullness.qual.NonNull;
 
@@ -43,6 +43,7 @@ public interface PreNetworkSyncEvent extends LuckPermsEvent, Cancellable {
      *
      * @return the id of the sync request
      */
-    @NonNull @Param(0) UUID getSyncId();
+    @Param(0)
+    @NonNull UUID getSyncId();
 
 }

api/src/main/java/net/luckperms/api/event/sync/PreSyncEvent.java

@@ -23,10 +23,10 @@
  *  SOFTWARE.
  */
 
-package me.lucko.luckperms.api.event.sync;
+package net.luckperms.api.event.sync;
 
-import me.lucko.luckperms.api.event.Cancellable;
-import me.lucko.luckperms.api.event.LuckPermsEvent;
+import net.luckperms.api.event.LuckPermsEvent;
+import net.luckperms.api.event.type.Cancellable;
 
 /**
  * Called before a sync task runs

api/src/main/java/net/luckperms/api/event/sync/package-info.java

@@ -0,0 +1,29 @@
+/*
+ * This file is part of LuckPerms, licensed under the MIT License.
+ *
+ *  Copyright (c) lucko (Luck) <luck@lucko.me>
+ *  Copyright (c) contributors
+ *
+ *  Permission is hereby granted, free of charge, to any person obtaining a copy
+ *  of this software and associated documentation files (the "Software"), to deal
+ *  in the Software without restriction, including without limitation the rights
+ *  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ *  copies of the Software, and to permit persons to whom the Software is
+ *  furnished to do so, subject to the following conditions:
+ *
+ *  The above copyright notice and this permission notice shall be included in all
+ *  copies or substantial portions of the Software.
+ *
+ *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ *  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ *  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ *  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ *  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ *  SOFTWARE.
+ */
+
+/**
+ * Events relating to {@link net.luckperms.api.LuckPerms#runUpdateTask() sync/update task}s.
+ */
+package net.luckperms.api.event.sync;

api/src/main/java/net/luckperms/api/event/track/TrackCreateEvent.java

@@ -23,12 +23,12 @@
  *  SOFTWARE.
  */
 
-package me.lucko.luckperms.api.event.track;
+package net.luckperms.api.event.track;
 
-import me.lucko.luckperms.api.Track;
-import me.lucko.luckperms.api.event.LuckPermsEvent;
-import me.lucko.luckperms.api.event.Param;
-import me.lucko.luckperms.api.event.cause.CreationCause;
+import net.luckperms.api.event.LuckPermsEvent;
+import net.luckperms.api.event.cause.CreationCause;
+import net.luckperms.api.event.util.Param;
+import net.luckperms.api.track.Track;
 
 import org.checkerframework.checker.nullness.qual.NonNull;
 
@@ -42,13 +42,15 @@ public interface TrackCreateEvent extends LuckPermsEvent {
      *
      * @return the new track
      */
-    @NonNull @Param(0) Track getTrack();
+    @Param(0)
+    @NonNull Track getTrack();
 
     /**
      * Gets the cause of the creation
      *
      * @return the cause of the creation
      */
-    @NonNull @Param(1) CreationCause getCause();
+    @Param(1)
+    @NonNull CreationCause getCause();
 
 }

api/src/main/java/net/luckperms/api/event/track/TrackDeleteEvent.java

@@ -23,11 +23,11 @@
  *  SOFTWARE.
  */
 
-package me.lucko.luckperms.api.event.track;
+package net.luckperms.api.event.track;
 
-import me.lucko.luckperms.api.event.LuckPermsEvent;
-import me.lucko.luckperms.api.event.Param;
-import me.lucko.luckperms.api.event.cause.DeletionCause;
+import net.luckperms.api.event.LuckPermsEvent;
+import net.luckperms.api.event.cause.DeletionCause;
+import net.luckperms.api.event.util.Param;
 
 import org.checkerframework.checker.nullness.qual.NonNull;
 
@@ -43,20 +43,23 @@ public interface TrackDeleteEvent extends LuckPermsEvent {
      *
      * @return the name of the deleted track
      */
-    @NonNull @Param(0) String getTrackName();
+    @Param(0)
+    @NonNull String getTrackName();
 
     /**
      * Gets an immutable copy of the tracks existing data
      *
      * @return a copy of the tracks existing data
      */
-    @NonNull @Param(1) List<String> getExistingData();
+    @Param(1)
+    @NonNull List<String> getExistingData();
 
     /**
      * Gets the cause of the deletion
      *
      * @return the cause of the deletion
      */
-    @NonNull @Param(2) DeletionCause getCause();
+    @Param(2)
+    @NonNull DeletionCause getCause();
 
 }

api/src/main/java/net/luckperms/api/event/track/TrackLoadAllEvent.java

@@ -23,9 +23,9 @@
  *  SOFTWARE.
  */
 
-package me.lucko.luckperms.api.event.track;
+package net.luckperms.api.event.track;
 
-import me.lucko.luckperms.api.event.LuckPermsEvent;
+import net.luckperms.api.event.LuckPermsEvent;
 
 /**
  * Called when all tracks have been loaded in from storage.