Release v4.3.0

thanks @kashike

.gitignore

@@ -1,40 +1,12 @@
-# Created by https://www.gitignore.io/
-
 ### Intellij ###
-# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio and Webstorm
-# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
-
-# User-specific stuff:
 .idea/
 *.iws
 /out/
 *.iml
 .idea_modules/
-
-# JIRA plugin
 atlassian-ide-plugin.xml
 
-# Crashlytics plugin (for Android Studio and IntelliJ)
-com_crashlytics_export_strings.xml
-crashlytics.properties
-crashlytics-build.properties
-fabric.properties
-
-
-### Maven ###
-target/
-pom.xml.tag
-pom.xml.releaseBackup
-pom.xml.versionsBackup
-pom.xml.next
-release.properties
-dependency-reduced-pom.xml
-buildNumber.properties
-.mvn/timing.properties
-
-
 ### Eclipse ###
-
 .metadata
 bin/
 tmp/
@@ -46,73 +18,27 @@ local.properties
 .settings/
 .loadpath
 .recommenders
-
-# Eclipse Core
-.project
-
-# External tool builders
 .externalToolBuilders/
-
-# Locally stored "Eclipse launch configurations"
 *.launch
-
-# PyDev specific (Python IDE for Eclipse)
-*.pydevproject
-
-# CDT-specific (C/C++ Development Tooling)
-.cproject
-
-# JDT-specific (Eclipse Java Development Tools)
-.classpath
-
-# Java annotation processor (APT)
 .factorypath
-
-# PDT-specific (PHP Development Tools)
-.buildpath
-
-# sbteclipse plugin
-.target
-
-# Tern plugin
-.tern-project
-
-# TeXlipse plugin
-.texlipse
-
-# STS (Spring Tool Suite)
-.springBeans
-
-# Code Recommenders
 .recommenders/
-
+.apt_generated/
+.project
+.classpath
 
 ### Linux ###
 *~
-
-# temporary files which can be created if a process still has a handle open of a deleted file
 .fuse_hidden*
-
-# KDE directory preferences
 .directory
-
-# Linux trash folder which might appear on any partition or disk
 .Trash-*
-
-# .nfs files are created when an open file is removed but is still being accessed
 .nfs*
 
-
 ### macOS ###
-*.DS_Store
+.DS_Store
 .AppleDouble
 .LSOverride
-
-# Icon must end with two \r
 Icon
-# Thumbnails
 ._*
-# Files that might appear in the root of a volume
 .DocumentRevisions-V100
 .fseventsd
 .Spotlight-V100
@@ -120,45 +46,34 @@ Icon
 .Trashes
 .VolumeIcon.icns
 .com.apple.timemachine.donotpresent
-# Directories potentially created on remote AFP share
 .AppleDB
 .AppleDesktop
 Network Trash Folder
 Temporary Items
 .apdisk
 
+### NetBeans ###
+nbproject/private/
+build/
+nbbuild/
+dist/
+nbdist/
+.nb-gradle/
 
 ### Windows ###
-# Windows image file caches
+# Windows thumbnail cache files
 Thumbs.db
 ehthumbs.db
-
-# Folder config file
-Desktop.ini
-
-# Recycle Bin used on file shares
+ehthumbs_vista.db
+*.stackdump
+[Dd]esktop.ini
 $RECYCLE.BIN/
-
-# Windows Installer files
-*.cab
-*.msi
-*.msm
-*.msp
-
-# Windows shortcuts
 *.lnk
 
-
-### Java ###
-*.class
-
-# Mobile Tools for Java (J2ME)
-.mtj.tmp/
-
-# Package Files #
-*.jar
-*.war
-*.ear
-
-# virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml
-hs_err_pid*
+### Gradle ###
+.gradle
+/build/
+/out/
+gradle-app.setting
+!gradle-wrapper.jar
+.gradletasknamecache

.locale/en_US.yml

@@ -1,299 +0,0 @@
-# LuckPerms Language File
-# Locale: en_US (English)
-# Author: Luck
-
-prefix: "&7&l[&b&lL&3&lP&7&l] &c"
-log-info: "&7&l[&bL&3P&7&l] &3{0}"
-log-warn: "&7&l[&bLuck&3Perms&7&l] &c[WARN] {0}"
-log-error: "&7&l[&bLuck&3Perms&7&l] &4[ERROR] {0}"
-empty: "{0}"
-player-online: "&aOnline"
-player-offline: "&cOffline"
-loading-error: "Permissions data could not be loaded. Please try again later."
-op-disabled: "&bThe vanilla OP system is disabled on this server."
-op-disabled-sponge: "&2Server Operator status has no effect when a permission plugin is installed. Please edit user data directly."
-log: "&3LOG &3&l> {0}"
-export-log: "&3EXPORT &3&l> &f{0}"
-export-log-progress: "&3EXPORT &3&l> &7{0}"
-migration-log: "&3MIGRATION &7[&3{0}&7] &3&l> &f{1}"
-migration-log-progress: "&3MIGRATION &7[&3{0}&7] &3&l> &7{1}"
-command-not-recognised: "Command not recognised."
-command-no-permission: "You do not have permission to use this command!"
-already-haspermission: "{0} already has this permission!"
-does-not-havepermission: "{0} does not have this permission set."
-already-has-temp-permission: "{0} already has this permission set temporarily!"
-does-not-have-temp-permission: "{0} does not have this permission set temporarily."
-user-not-found: "&bUser could not be found."
-user-not-online: "&bUser &a{0}&b is not online."
-user-no-data: "&bUser &a{0}&b does not have any data loaded."
-user-save-success: "&7(User data was saved to storage)"
-user-save-error: "There was an error whilst saving the user."
-user-create-fail: "There was an error whilst creating a new user."
-group-not-found: "&bGroup could not be found."
-group-save-success: "&7(Group data was saved to storage)"
-group-save-error: "There was an error whilst saving the group."
-track-not-found: "&bTrack could not be found."
-track-save-success: "&7(Track data was saved to storage)"
-track-save-error: "There was an error whilst saving the track."
-user-invalid-entry: "&d{0}&c is not a valid username/uuid."
-group-invalid-entry: "Group names can only contain alphanumeric characters."
-track-invalid-entry: "Track names can only contain alphanumeric characters."
-server-invalid-entry: "Server names can only contain alphanumeric characters."
-use-inherit-command: "Use the 'parent add' and 'parent remove' commands instead of specifying the node."
-verbose-invalid-filter: "&cInvalid verbose filter: &f{0}"
-verbose-on: "&bVerbose checking output set to &aTRUE &bfor all permissions."
-verbose-on-query: "&bVerbose checking output set to &aTRUE &bfor permissions matching the following filters: &f{0}"
-verbose-off: "&bVerbose checking output set to &cFALSE&b."
-verbose-recording-on: "&bVerbose recording set to &aTRUE &bfor all permissions."
-verbose-recording-on-query: "&bVerbose recording set to &aTRUE &bfor permissions matching the following filters: &f{0}"
-verbose-recording-upload-start: "&bVerbose recording was disabled. Uploading results..."
-verbose-recording-url: "&aVerbose results URL:"
-tree-upload-start: "&bGenerating permission tree..."
-tree-empty: "&aUnable to generate tree. No results were found."
-tree-url: "&aPermission Tree URL:"
-search-searching: "&aSearching for users and groups with &b{0}&a..."
-search-result: "&aFound &b{0}&a entries from &b{1}&a users and &b{2}&a groups."
-search-showing-users: "&bShowing user entries:"
-search-showing-groups: "&bShowing group entries:"
-search-showing-users-with-page: "&bShowing user entries:  {0}"
-search-showing-groups-with-page: "&bShowing group entries:  {0}"
-check-result: "&aPermission check result on user &b{0}&a for permission &b{1}&a: &f{2}"
-create-success: "&b{0}&a was successfully created."
-delete-success: "&b{0}&a was successfully deleted."
-rename-success: "&b{0}&a was successfully renamed to &b{1}&a."
-clone-success: "&b{0}&a was successfully cloned onto &b{1}&a."
-already-inherits: "{0} already inherits '{1}'."
-does-not-inherit: "{0} does not inherit '{1}'."
-already-temp-inherits: "{0} already temporarily inherits '{1}'."
-does-not-temp-inherit: "{0} does not temporarily inherit '{1}'."
-track-already-contains: "Track {0} already contains the group '{1}'."
-track-does-not-contain: "Track {0} does not contain the group '{1}'."
-track-ambiguous-call: "The user specified is a member of multiple groups on this track. Unable to determine their location."
-group-already-exists: "That group already exists!"
-group-does-not-exist: "That group does not exist!"
-group-load-error: "An unexpected error occurred. Group not loaded."
-groups-load-error: "An unexpected error occurred. Unable to load all groups."
-track-already-exists: "That track already exists!"
-track-does-not-exist: "That track does not exist!"
-track-load-error: "An unexpected error occurred. Track not loaded."
-tracks-load-error: "An unexpected error occurred. Unable to load all tracks."
-track-empty: "The track cannot be used as it is empty or contains only one group."
-update-task-request: "&bUpdate task scheduled."
-update-task-complete: "&aUpdate task finished."
-update-task-complete-network: "&aUpdate task finished. Now attempting to push to other servers."
-update-task-push-success: "&aOther servers were notified via &b{0} Messaging &asuccessfully."
-update-task-push-failure: "&cError whilst pushing changes to other servers."
-update-task-push-failure-not-setup: "&cError whilst pushing changes to other servers. A messaging service has not been configured."
-reload-config-success: "&aThe configuration file was reloaded. &7(some options will only apply after the server has restarted.)"
-info: >
-  {PREFIX}&2Running &bLuckPerms v{0}&2 by &bLuck&2.\n
-  {PREFIX}&f-  &3Platform: &f{1}\n
-  {PREFIX}&f-  &3Storage Method: &f{2}\n
-  {PREFIX}&f-  &3Server Name: &f{3}\n
-  {PREFIX}&f-  &3Sync Interval: &a{4} &fminutes\n
-  {PREFIX}&f-  &3Messaging Service: &f{5}\n
-  {PREFIX}&f-  &bCounts:\n
-  {PREFIX}&f-     &3Online Players: &a{6}\n
-  {PREFIX}&f-     &3Loaded Users: &a{7}\n
-  {PREFIX}&f-     &3Loaded Groups: &a{8}\n
-  {PREFIX}&f-     &3Loaded Tracks: &a{9}\n
-  {PREFIX}&f-     &3Log size: &a{10}\n
-  {PREFIX}&f-     &3UUID Cache size: &a{11}\n
-  {PREFIX}&f-     &3Translations loaded: &a{12}\n
-  {PREFIX}&f-     &3Pre-process contexts: &a{13}\n
-  {PREFIX}&f-     &3Context Calculators: &a{14}\n
-  {PREFIX}&f-     &3Unique permissions: &a{15}\n
-  {PREFIX}&f-  &bConfiguration:\n
-  {PREFIX}&f-     &3Use Server UUIDs: {16}\n
-  {PREFIX}&f-     &bPermission Calculation:\n
-  {PREFIX}&f-        &3Including Global: {17}\n
-  {PREFIX}&f-        &3Including Global World: {18}\n
-  {PREFIX}&f-        &3Applying Global Groups: {19}\n
-  {PREFIX}&f-        &3Applying Global World Groups: {20}\n
-  {PREFIX}&f-        &3Applying Wildcards: {21}\n
-  {PREFIX}&f-        &3Applying Regex: {22}\n
-  {PREFIX}&f-        &3Applying Shorthand: {23}
-create-group-error: "There was an error whilst creating the group."
-delete-group-error: "There was an error whilst deleting the group."
-delete-group-error-default: "You cannot delete the default group."
-groups-list: "&aGroups: {0}"
-create-track-error: "There was an error whilst creating the track."
-delete-track-error: "There was an error whilst deleting the track."
-tracks-list: "&aTracks: {0}"
-listnodes: "&b{0}'s Nodes:"
-listnodes-with-page: "&b{0}'s Nodes:  {1}"
-listnodes-temp: >
-  &b{0}'s Temporary Nodes:\n
-  {1}
-listparents: >
-  &b{0}'s Parent Groups:\n
-  {1}
-listparents-temp: >
-  &b{0}'s Temporary Parent Groups:\n
-  {1}
-listgroups: >
-  &b{0}'s Groups:\n
-  {1}
-listgroups-temp: >
-  &b{0}'s Temporary Groups:\n
-  {1}
-list-tracks: >
-  &b{0}'s Tracks:\n
-  {1}
-list-tracks-empty: "{0} is not on any tracks."
-context-pair-inline: "&3{0}=&b{1}"
-context-pair--global-inline: "&eglobal"
-context-pair-end: "&a."
-context-pair-sep: "&a, "
-context-pair: "&8(&7{0}=&f{1}&8)"
-check-permission: "&b{0}&a has permission &b{1}&a set to {2}&a in context {3}&a."
-check-permission-inherited: "&b{0}&a has permission &b{1}&a set to {2}&a in context {3}&a, inherited from &b{4}&a."
-setpermission-success: "&aSet &b{0}&a to &b{1}&a for &b{2}&a in context {3}&a."
-setpermission-temp-success: "&aSet &b{0}&a to &b{1}&a for &b{2}&a for a duration of &b{3}&a in context {4}&a."
-unsetpermission-success: "&aUnset &b{0}&a for &b{1}&a in context {2}&a."
-unset-temp-permission-success: "&aUnset temporary permission &b{0}&a for &b{1}&a in context {2}&a."
-set-inherit-success: "&b{0}&a now inherits permissions from &b{1}&a in context {2}&a."
-set-temp-inherit-success: "&b{0}&a now inherits permissions from &b{1}&a for a duration of &b{2}&a in context {3}&a."
-set-parent-success: "&b{0}&a had their existing parent groups cleared, and now only inherits &b{1}&a in context {2}&a."
-unset-inherit-success: "&b{0}&a no longer inherits permissions from &b{1}&a in context {2}&a."
-unset-temp-inherit-success: "&b{0}&a no longer temporarily inherits permissions from &b{1}&a in context {2}&a."
-clear-success: "&b{0}&a's permissions were cleared. (&b{1}&a nodes were removed.)"
-clear-success-singular: "&b{0}&a's permissions were cleared. (&b{1}&a node was removed.)"
-parent-clear-success: "&b{0}&a's parents were cleared. (&b{1}&a nodes were removed.)"
-parent-clear-success-singular: "&b{0}&a's parents were cleared. (&b{1}&a node was removed.)"
-meta-clear-success: "&b{0}&a's meta was cleared. (&b{1}&a nodes were removed.)"
-meta-clear-success-singular: "&b{0}&a's meta was cleared. (&b{1}&a node was removed.)"
-illegal-date-error: "Could not parse date '{0}'."
-past-date-error: "You cannot set a date in the past!"
-chat-meta-prefix-header: "&b{0}'s Prefixes"
-chat-meta-suffix-header: "&b{0}'s Suffixes"
-meta-header: "&b{0}'s Meta"
-chat-meta-entry: "&b-> {0} &f- &f\"{1}&f\" &8(&7inherited from &a{2}&8)"
-chat-meta-entry-with-context: "&b-> {0} &f- &f\"{1}&f\" &8(&7inherited from &a{2}&8){3}"
-meta-entry: "&b-> &a{0} &f= &f\"{1}&f\" &8(&7inherited from &a{2}&8)"
-meta-entry-with-context: "&b-> &a{0} &f= &f\"{1}&f\" &8(&7inherited from &a{2}&8){3}"
-chat-meta-prefix-none: "&b{0} has no prefixes."
-chat-meta-suffix-none: "&b{0} has no suffixes."
-meta-none: "&b{0} has no meta."
-meta-invalid-priority: "Invalid priority '{0}'. Expected a number."
-already-has-chat-meta: "{0} already has that {1} set."
-does-not-have-chat-meta: "{0} doesn't have that {1} set."
-add-chatmeta-success: "&b{0}&a had {1} &f\"{2}&f\"&a set at a priority of &b{3}&a in context {4}&a."
-add-temp-chatmeta-success: "&b{0}&a had {1} &f\"{2}&f\"&a set at a priority of &b{3}&a for a duration of &b{4}&a in context {5}&a."
-remove-chatmeta-success: "&b{0}&a had {1} &f\"{2}&f\"&a at priority &b{3}&a removed in context {4}&a."
-bulk-remove-chatmeta-success: "&b{0}&a had all {1}es at priority &b{3}&a removed in context {4}&a."
-remove-temp-chatmeta-success: "&b{0}&a had temporary {1} &f\"{2}&f\"&a at priority &b{3}&a removed in context {4}&a."
-bulk-remove-temp-chatmeta-success: "&b{0}&a had all temporary {1}es at priority &b{3}&a removed in context {4}&a."
-already-has-meta: "{0} already has that meta key value pair set."
-set-meta-success: "&aSet meta value for key &f\"{0}&f\"&a to &f\"{1}&f\"&a for &b{2}&a in context {3}&a."
-set-meta-temp-success: "&aSet meta value for key &f\"{0}&f\"&a to &f\"{1}&f\"&a for &b{2}&a for a duration of &b{3}&a in context {4}&a."
-unset-meta-success: "&aUnset meta value with key &f\"{0}&f\"&a for &b{1}&a in context {2}&a."
-unset-meta-temp-success: "&aUnset temporary meta value with key &f\"{0}&f\"&a for &b{1}&a in context {2}&a."
-bulk-change-type-error: "Invalid type. Was expecting 'server' or 'world'."
-bulk-change-success: "&aApplied bulk change successfully. {0} records were changed."
-user-info-general: >
-  {PREFIX}&b&l> &bUser Info: &f{0}\n
-  {PREFIX}&f- &3UUID: &f{1}\n
-  {PREFIX}&f- &3Status: {2}\n
-  {PREFIX}&f- &3Primary Group: &f{3}\n
-  {PREFIX}&f- &aCounts:\n
-  {PREFIX}&f-    &3Permissions: &a{4}\n
-  {PREFIX}&f-    &3Temporary Permissions: &a{5}\n
-  {PREFIX}&f-    &3Prefixes: &a{6}\n
-  {PREFIX}&f-    &3Suffixes: &a{7}\n
-  {PREFIX}&f-    &3Meta: &a{8}
-user-info-data: >
-  {PREFIX}&f- &aCached Data:\n
-  {PREFIX}&f-    &3Is Loaded: {0}\n
-  {PREFIX}&f-    &3Current Contexts: {1}\n
-  {PREFIX}&f-    &3Current Prefix: {2}\n
-  {PREFIX}&f-    &3Current Suffix: {3}
-info-parent-header: "&f- &aParent Groups:"
-info-temp-parent-header: "&f- &aTemporary Parent Groups:"
-user-getuuid: "&bThe UUID of &b{0}&b is &b{1}&b."
-user-removegroup-error-primary: "You cannot remove a user from their primary group."
-user-primarygroup-success: "&b{0}&a's primary group was set to &b{1}&a."
-user-primarygroup-warn-option: "&cWarning: The primary group calculation method being used by this server &7({0}) &cmay not reflect this change."
-user-primarygroup-error-alreadyhas: "The user already has this group set as their primary group."
-user-primarygroup-error-notmember: "&b{0}&a was not already a member of &b{1}&a, adding them now."
-user-track-error-not-contain-group: "The user specified isn't already in any groups on this track."
-user-track-added-to-first: "&b{0}&a isn't in any groups on this track, so they were added to the first group, &b{1}&a."
-user-track-added-to-first-server: "&b{0}&a isn't in any groups on this track, so they were added to the first group, &b{1}&a, on server &b{2}&a."
-user-track-added-to-first-server-world: "&b{0}&a isn't in any groups on this track, so they were added to the first group, &b{1}&a, on server &b{2}&a, world &b{3}&a."
-user-promote-success: "&aPromoting user along track &b{0}&a from &b{1}&a to &b{2}&a."
-user-promote-success-server: "&aPromoting user along track &b{0}&a from &b{1}&a to &b{2}&a on server &b{3}&a."
-user-promote-success-server-world: "&aPromoting user along track &b{0}&a from &b{1}&a to &b{2}&a on server &b{3}&a, world &b{4}&a."
-user-promote-error-endoftrack: "The end of track &4{0}&c was reached. Unable to promote user."
-user-promote-error-malformed: >
-  {PREFIX}The next group on the track, {0}, no longer exists. Unable to promote user.\n
-  {PREFIX}Either create the group, or remove it from the track and try again.
-user-demote-success: "&aDemoting user along track &b{0}&a from &b{1}&a to &b{2}&a."
-user-demote-success-server: "&aDemoting user along track &b{0}&a from &b{1}&a to &b{2}&a on server &b{3}&a."
-user-demote-success-server-world: "&aDemoting user along track &b{0}&a from &b{1}&a to &b{2}&a on server &b{3}&a, world &b{4}&a."
-user-demote-endoftrack: "The end of track &4{0}&c was reached, so &4{1}&c was removed from &4{2}&c."
-user-demote-error-malformed: >
-  {PREFIX}The previous group on the track, {0}, no longer exists. Unable to demote user.\n
-  {PREFIX}Either create the group, or remove it from the track and try again.
-user-showpos: >
-  &aShowing &b{0}&a's position on track &b{1}&a.\n
-  {2}
-group-info-general: >
-  {PREFIX}&b&l> &bGroup Info: &f{0}\n
-  {PREFIX}&f- &3Display Name: &f{1}\n
-  {PREFIX}&f- &3Weight: &f{2}\n
-  {PREFIX}&f- &aCounts:\n
-  {PREFIX}&f-    &3Permissions: &a{3}\n
-  {PREFIX}&f-    &3Temporary Permissions: &a{4}\n
-  {PREFIX}&f-    &3Prefixes: &a{5}\n
-  {PREFIX}&f-    &3Suffixes: &a{6}\n
-  {PREFIX}&f-    &3Meta: &a{7}
-group-set-weight: "&aSet weight to &b{0}&a for group &b{1}&a."
-track-info: >
-  {PREFIX}&b&l> &bShowing Track: &f{0}\n
-  {PREFIX}&f- &7Path: &f{1}
-track-clear: "&b{0}&a's groups track was cleared."
-track-append-success: "&aGroup &b{0}&a was successfully appended to track &b{1}&a."
-track-insert-success: "&aGroup &b{0}&a was successfully inserted into track &b{1}&a at position &b{2}&a."
-track-insert-error-number: "Expected number but instead received: {0}"
-track-insert-error-invalid-pos: "Unable to insert at position {0}. Index out of bounds."
-track-remove-success: "&aGroup &b{0}&a was successfully removed from track &b{1}&a."
-log-load-error: "The log could not be loaded."
-log-invalid-page: "Invalid page number."
-log-invalid-page-range: "Invalid page number. Please enter a value between 1 and {0}."
-log-no-entries: "&bNo log entries to show."
-log-entry: "&b#{0} -> &8(&7{1} ago&8) {2}"
-log-notify-toggle-on: "&aEnabled&b logging output."
-log-notify-toggle-off: "&cDisabled&b logging output."
-log-notify-already-on: "You are already receiving notifications."
-log-notify-already-off: "You aren't currently receiving notifications."
-log-notify-unknown: "State unknown. Expecting \"on\" or \"off\"."
-log-search-header: "&aShowing recent actions for query &b{0} &a(page &f{1}&a of &f{2}&a)"
-log-recent-header: "&aShowing recent actions (page &f{0}&a of &f{1}&a)"
-log-recent-by-header: "&aShowing recent actions by &b{0} &a(page &f{1}&a of &f{2}&a)"
-log-history-user-header: "&aShowing history for user &b{0} &a(page &f{1}&a of &f{2}&a)"
-log-history-group-header: "&aShowing history for group &b{0} &a(page &f{1}&a of &f{2}&a)"
-log-history-track-header: "&aShowing history for track &b{0} &a(page &f{1}&a of &f{2}&a)"
-log-export-already-exists: "Error: File {0} already exists."
-log-export-not-writable: "Error: File {0} is not writable."
-log-export-empty: "The log is empty and therefore cannot be exported."
-log-export-failure: "An unexpected error occured whilst writing to the file."
-log-export-success: "&aSuccessfully exported the log to &b{0}&a."
-import-already-running: "Another import process is already running. Please wait for it to finish and try again."
-export-already-running: "Another export process is already running. Please wait for it to finish and try again."
-import-log-doesnt-exist: "Error: File {0} does not exist."
-import-log-not-readable: "Error: File {0} is not readable."
-import-log-failure: "An unexpected error occured whilst reading from the log file."
-import-progress: "&b(Import) &b-> &f{0} &fpercent complete &7- &b{1}&f/&b{2} &foperations complete with &c{3} &ferrors."
-import-progress-sin: "&b(Import) &b-> &f{0} &fpercent complete &7- &b{1}&f/&b{2} &foperations complete with &c{3} &ferror."
-import-start: "&b(Import) &b-> &fStarting import process."
-import-end-complete: "&b(Import) &a&lCOMPLETED &7- took &b{0} &7seconds - &7No errors."
-import-end-complete-err: "&b(Import) &a&lCOMPLETED &7- took &b{0} &7seconds - &c{1} errors."
-import-end-complete-err-sin: "&b(Import) &a&lCOMPLETED &7- took &b{0} &7seconds - &c{1} error."
-import-end-error-header: >
-  {PREFIX}&b(Import) &7------------> &fShowing Error #&b{0} &7<------------\n
-  {PREFIX}&b(Import) &fWhilst executing: &3Command #{1}\n
-  {PREFIX}&b(Import) &fCommand: &7{2}\n
-  {PREFIX}&b(Import) &fType: &3{3}\n
-  {PREFIX}&b(Import) &fOutput:
-import-end-error-content: "&b(Import) &b-> &c{0}"
-import-end-error-footer: "&b(Import) &7<------------------------------------------>"

.locale/es_ES.yml

@@ -1,338 +0,0 @@
-# LuckPerms Language File
-# Locale: es_ES (Spanish)
-# Author: Jose Chavez (Twitter: @JoCHav3z)
-
-prefix: "&7&l[&b&lL&3&lP&7&l] &c"
-log-info: "&7&l[&bL&3P&7&l] &3{0}"
-log-warn: "&7&l[&bLuck&3Perms&7&l] &c[ADVERTENCIA] {0}"
-log-error: "&7&l[&bLuck&3Perms&7&l] &4[ERROR] {0}"
-empty: "{0}"
-player-online: "&aConectado"
-player-offline: "&cDesconectado"
-loading-error: "La Informacion de los permisos no pudo ser cargada. Por favor contacte al administrador."
-op-disabled: "&bEl sistema OP de Vanilla esta deshabilitado en este servidor."
-op-disabled-sponge: "&2El estado de operador del servidor no tiene efecto cuando un plugin de permisos esta instalado. Por favor edite la informacion de usuario directamente."
-log: "&3LOG &3&l> {0}"
-export-log: "&3EXPORTAR &3&l> &f{0}"
-export-log-progress: "&3EXPORTADO &3&l> &7{0}"
-migration-log: "&3MIGRACION &7[&3{0}&7] &3&l> &f{1}"
-migration-log-progress: "&3MIGRADO &7[&3{0}&7] &3&l> &7{1}"
-command-not-recognised: "Comando no reconocido."
-command-no-permission: "¡No tienes permiso de usar este comando!"
-already-haspermission: "{0} ¡Ya tienes este permiso!"
-does-not-havepermission: "{0} No tienes este permiso establecido."
-already-has-temp-permission: "{0} ¡Ya tienes este permiso establecido temporalmente!"
-does-not-have-temp-permission: "{0} No tienes este permiso establecido temporalmente."
-user-not-found: "&bNo se pudo encontrar al usuario."
-user-not-online: "&bUsuario &a{0}&b no esta conectado."
-user-no-data: "&bUsuario &a{0}&b no tiene ningún dato cargado."
-user-save-success: "&7(Los datos del usuario se guardaron en el almacenamiento)"
-user-save-error: "Se ha producido un error al guardar el usuario."
-user-create-fail: "Se produjo un error al crear un nuevo usuario."
-group-not-found: "&bEl Grupo no se pudo encontrar."
-group-save-success: "&7(Los datos del grupo se guardaron en el almacenamiento)"
-group-save-error: "Se ha producido un error al guardar el grupo."
-track-not-found: "&bNo se pudo encontrar la pista."
-track-save-success: "&7(Los datos de la pista se guardaron en el almacenamiento)"
-track-save-error: "Se ha producido un error al guardar la pista."
-user-invalid-entry: "&d{0}&c El username/uuid no es valido."
-group-invalid-entry: "Los nombres de grupo sólo pueden contener caracteres alfanuméricos."
-track-invalid-entry: "Los nombres de pista sólo pueden contener caracteres alfanuméricos."
-server-invalid-entry: "Los nombres de servidor sólo pueden contener caracteres alfanuméricos."
-use-inherit-command: "Usa el comando 'parent add' y 'parent remove' en vez de especificar el nodo."
-verbose-invalid-filter: "&cFiltro Verbose invalido: &f{0}"
-verbose-on: "&bEl chequeo Verbose de salida se ha establecido en &aTRUE &bpara todos los permisos."
-verbose-on-query: "&bEl chequeo Verbose de salida que se establecio en &aTRUE &bpara los permisos se ha pareado con los siguientes filtros: &f{0}"
-verbose-off: "&bEl chequeo Verbose de salida que se establecio en &cFALSE&b."
-verbose-recording-on: "&bGrabacion de Verbose establecida en &aTRUE &bpara todos los permisos."
-verbose-recording-on-query: "&bGrabacion de Verbose establecida en &aTRUE &bpara los permisos se ha pareado con los siguientes filtros: &f{0}"
-verbose-recording-upload-start: "&bGrabacion de Verbose se ha deshabilitado. Cargando resultados..."
-verbose-recording-url: "&aURL de resultados de Verbose:"
-tree-upload-start: "&bGenerando arbol de permisos..."
-tree-empty: "&aNo se puede generar el árbol. No se encontraron resultados."
-tree-url: "&aURL de arbol de permisos:"
-search-searching: "&aBúsqueda de usuarios y grupos con &b{0}&a..."
-search-result: "&aEncontradas &b{0}&a entradas por parte de &b{1}&a usuarios y &b{2}&a grupos."
-search-showing-users: "&bMostrando entradas del usuario:"
-search-showing-groups: "&bMostrando entradas del grupo:"
-search-showing-users-with-page: "&bMostrando entradas del usuario:  {0}"
-search-showing-groups-with-page: "&bMostrando entradas del grupo:  {0}"
-check-result: "&aResultado de la comprobación del permiso en el usuario &b{0}&a para permiso &b{1}&a: &f{2}"
-create-success: "&b{0}&a se creó correctamente."
-delete-success: "&b{0}&a fue eliminado correctamente."
-rename-success: "&b{0}&a fue exitosamente renombrado a &b{1}&a."
-clone-success: "&b{0}&a fue clonado con éxito en &b{1}&a."
-already-inherits: "{0} ya hereda '{1}'."
-does-not-inherit: "{0} no hereda '{1}'."
-already-temp-inherits: "{0} ya lo heredo temporalmente a '{1}'."
-does-not-temp-inherit: "{0} no lo heredo temporalmente a '{1}'."
-track-already-contains: "La pista {0} ya contiene el grupo '{1}'."
-track-does-not-contain: "La pista {0} no contiene el grupo '{1}'."
-track-ambiguous-call: "El usuario especificado es miembro de varios grupos en esta pista. No se puede determinar su ubicación."
-group-already-exists: "¡Ese grupo ya existe!"
-group-does-not-exist: "¡Ese grupo no existe!"
-group-load-error: "Ocurrió un error inesperado. No se pudo cargar el grupo."
-groups-load-error: "Ocurrió un error inesperado. No se pueden cargar todos los grupos."
-track-already-exists: "¡La pista ya existe!"
-track-does-not-exist: "¡La pista no existe!"
-track-load-error: "Ocurrió un error inesperado. No se pudo cargar la pista."
-tracks-load-error: "Ocurrió un error inesperado. No se pueden cargar todas las pistas."
-track-empty: "La pista no se puede utilizar porque está vacía o contiene sólo un grupo."
-update-task-request: "&bActualizar tarea programada."
-update-task-complete: "&aLa actualizacion de la tarea a finalizado."
-update-task-complete-network: "&aLa actualizacion de la tarea a finalizado. Ahora intentando enviar a otros servidores."
-update-task-push-success: "&aOtros servidores fueron notificados vía &b{0} Mensajería &aexitoxamente."
-update-task-push-failure: "&cError al empujar cambios a otros servidores."
-update-task-push-failure-not-setup: "&cError al presionar los cambios a otros servidores. No se ha configurado un servicio de mensajería."
-reload-config-success: "&aSe ha vuelto a cargar el archivo de configuración. &7(Algunas opciones sólo se aplicarán después de que el servidor se haya reiniciado.)"
-info: >
-  {PREFIX}&2Running &bLuckPerms v{0}&2 by &bLuck&2.\n
-  {PREFIX}&f-  &3Platform: &f{1}\n
-  {PREFIX}&f-  &3Storage Method: &f{2}\n
-  {PREFIX}&f-  &3Server Name: &f{3}\n
-  {PREFIX}&f-  &3Sync Interval: &a{4} &fminutes\n
-  {PREFIX}&f-  &3Messaging Service: &f{5}\n
-  {PREFIX}&f-  &bCounts:\n
-  {PREFIX}&f-     &3Online Players: &a{6}\n
-  {PREFIX}&f-     &3Loaded Users: &a{7}\n
-  {PREFIX}&f-     &3Loaded Groups: &a{8}\n
-  {PREFIX}&f-     &3Loaded Tracks: &a{9}\n
-  {PREFIX}&f-     &3Log size: &a{10}\n
-  {PREFIX}&f-     &3UUID Cache size: &a{11}\n
-  {PREFIX}&f-     &3Translations loaded: &a{12}\n
-  {PREFIX}&f-     &3Pre-process contexts: &a{13}\n
-  {PREFIX}&f-     &3Context Calculators: &a{14}\n
-  {PREFIX}&f-     &3Unique permissions: &a{15}\n
-  {PREFIX}&f-  &bConfiguration:\n
-  {PREFIX}&f-     &3Use Server UUIDs: {16}\n
-  {PREFIX}&f-     &bPermission Calculation:\n
-  {PREFIX}&f-        &3Including Global: {17}\n
-  {PREFIX}&f-        &3Including Global World: {18}\n
-  {PREFIX}&f-        &3Applying Global Groups: {19}\n
-  {PREFIX}&f-        &3Applying Global World Groups: {20}\n
-  {PREFIX}&f-        &3Applying Wildcards: {21}\n
-  {PREFIX}&f-        &3Applying Regex: {22}\n
-  {PREFIX}&f-        &3Applying Shorthand: {23}
-create-group-error: "Se produjo un error al crear el grupo."
-delete-group-error: "Se produjo un error al eliminar el grupo."
-delete-group-error-default: "No puede eliminar el grupo predeterminado."
-groups-list: "&aGrupos: {0}"
-create-track-error: "Se produjo un error al crear la pista."
-delete-track-error: "Se produjo un error al eliminar la pista."
-tracks-list: "&aPistas: {0}"
-listnodes: "&b{0}'s Nodos:"
-listnodes-with-page: "&b{0}'s Nodos:  {1}"
-listnodes-temp: >
-  &b{0}'s Temporary Nodes:\n
-  {1}
-listparents: >
-  &b{0}'s Parent Groups:\n
-  {1}
-listparents-temp: >
-  &b{0}'s Temporary Parent Groups:\n
-  {1}
-listgroups: >
-  &b{0}'s Groups:\n
-  {1}
-listgroups-temp: >
-  &b{0}'s Temporary Groups:\n
-  {1}
-list-tracks: >
-  &b{0}'s Tracks:\n
-  {1}
-list-tracks-empty: "{0} no está en ninguna pista."
-setpermission-success: "&aEstablecer &b{0}&a a &b{1}&a para &b{2}&a."
-setpermission-server-success: "&aEstablecer &b{0}&a a &b{1}&a para &b{2}&a en el servidor &b{3}&a."
-setpermission-server-world-success: "&aEstablecer &b{0}&a a &b{1}&a para &b{2}&a en el servidor &b{3}&a, mundo &b{4}&a."
-setpermission-temp-success: "&aEstablecer &b{0}&a a &b{1}&a para &b{2}&a por una duracion de &b{3}&a."
-setpermission-temp-server-success: "&aEstablecer &b{0}&a a &b{1}&a para &b{2}&a en el servidor &b{3}&a por una duracion de &b{4}&a."
-setpermission-temp-server-world-success: "&aEstablecer &b{0}&a a &b{1}&a para &b{2}&a en el servidor &b{3}&a, mundo &b{4}&a, por una duracion de &b{5}&a."
-unsetpermission-success: "&aDesestablecer &b{0}&a para &b{1}&a."
-unsetpermission-server-success: "&aDesestablecer &b{0}&a para &b{1}&a en el servidor &b{2}&a."
-unsetpermission-server-world-success: "&aDesestablecer &b{0}&a para &b{1}&a en el servidor &b{2}&a, mundo &b{3}&a."
-unset-temp-permission-success: "&aDesestablecer temporalmente el permiso &b{0}&a para &b{1}&a."
-unset-temp-permission-server-success: "&aDesestablecer temporalmente el permiso &b{0}&a para &b{1}&a en el servidor &b{2}&a."
-unset-temp-permission-server-world-success: "&aDesestablecer temporalmente el permiso &b{0}&a para &b{1}&a en el servidor &b{2}&a, mundo &b{3}&a."
-set-inherit-success: "&b{0}&a ahora hereda los permisos de &b{1}&a."
-set-inherit-server-success: "&b{0}&a ahora hereda los permisos de &b{1}&a en el servidor &b{2}&a."
-set-inherit-server-world-success: "&b{0}&a ahora hereda los permisos de &b{1}&a en el servidor &b{2}&a, mundo &b{3}&a."
-set-parent-success: "&b{0}&a sus grupos parentales existentes han sido borrados, y ahora solo heredan &b{1}&a."
-set-parent-server-success: "&b{0}&a sus grupos parentales existentes han sido borrados, y ahora solo heredan &b{1}&a en el servidor &b{2}&a."
-set-parent-server-world-success: "&b{0}&a sus grupos parentales existentes han sido borrados, y ahora solo heredan &b{1}&a en el servidor &b{2}&a, mundo &b{3}&a."
-set-temp-inherit-success: "&b{0}&a ahora heredan permisos de &b{1}&a por una duracion de &b{2}&a."
-set-temp-inherit-server-success: "&b{0}&a ahora heredan permisos de &b{1}&a en el servidor &b{2}&a por una duracion de &b{3}&a."
-set-temp-inherit-server-world-success: "&b{0}&a ahora heredan permisos de &b{1}&a en el servidor &b{2}&a, mundo &b{3}&a, por una duracion de &b{4}&a."
-unset-inherit-success: "&b{0}&a ya no hereda los permisos de &b{1}&a."
-unset-inherit-server-success: "&b{0}&a ya no hereda los permisos de &b{1}&a en el servidor &b{2}&a."
-unset-inherit-server-world-success: "&b{0}&a ya no hereda los permisos de &b{1}&a en el servidor &b{2}&a, mundo &b{3}&a."
-unset-temp-inherit-success: "&b{0}&a ya no hereda temporalmente los permisos de &b{1}&a."
-unset-temp-inherit-server-success: "&b{0}&a ya no hereda temporalmente los permisos &b{1}&a en el servidor &b{2}&a."
-unset-temp-inherit-server-world-success: "&b{0}&a ya no hereda temporalmente los permisos &b{1}&a en el servidor &b{2}&a, mundo &b{3}&a."
-clear-success: "&b{0}&a's permisos fueron borrados. (&b{1}&a nodos fueron removidos.)"
-clear-success-singular: "&b{0}&a's permisos fueron borrados. (&b{1}&a nodo fue removido.)"
-parent-clear-success: "&b{0}&a's los padres fueron eliminados. (&b{1}&a nodos fueron removidos.)"
-parent-clear-success-singular: "&b{0}&a's los padres fueron eliminados. (&b{1}&a nodo fue removido.)"
-meta-clear-success: "&b{0}&a's meta fue eliminada. (&b{1}&a nodos fueron removidos.)"
-meta-clear-success-singular: "&b{0}&a's meta fue eliminada. (&b{1}&a nodo fue removido.)"
-illegal-date-error: "No se pudo analizar la fecha '{0}'."
-past-date-error: "¡No puedes fijar una fecha en el pasado!"
-chat-meta-prefix-header: "&b{0}'s Prefijos"
-chat-meta-suffix-header: "&b{0}'s Sufijos"
-meta-header: "&b{0}'s Meta"
-chat-meta-entry: "&b-> {0} &f- &f\"{1}&f\" &8(&7heredado de &a{2}&8)"
-chat-meta-entry-with-context: "&b-> {0} &f- &f\"{1}&f\" &8(&7heredado de &a{2}&8){3}"
-meta-entry: "&b-> &a{0} &f= &f\"{1}&f\" &8(&7heredado de &a{2}&8)"
-meta-entry-with-context: "&b-> &a{0} &f= &f\"{1}&f\" &8(&7heredado de &a{2}&8){3}"
-chat-meta-prefix-none: "&b{0} no tiene prefijos."
-chat-meta-suffix-none: "&b{0} no tiene sufijos."
-meta-none: "&b{0} no tiene meta."
-meta-invalid-priority: "Prioridad no válida '{0}'. Se esperaba un número."
-already-has-prefix: "{0} ya tiene ese prefijo establecido."
-already-has-suffix: "{0} ya tiene ese sufijo establecido."
-does-not-have-prefix: "{0} no tiene ese prefijo establecido."
-does-not-have-suffix: "{0} no tiene ese sufijo establecido."
-addprefix-success: "&b{0}&a tiene el prefijo &f\"{1}&f\"&a establecido como prioridad de &b{2}&a."
-addprefix-server-success: "&b{0}&a tiene el prefijo &f\"{1}&f\"&a establecido como prioridad de &b{2}&a en el servidor &b{3}&a."
-addprefix-server-world-success: "&b{0}&a tiene el prefijo &f\"{1}&f\"&a establecido como prioridad de &b{2}&a en el servidor &b{3}&a, mundo &b{4}&a."
-removeprefix-success: "&b{0}&a tiene el prefijo &f\"{1}&f\"&a en prioridad de &b{2}&a removido."
-removeprefix-server-success: "&b{0}&a tiene el prefijo &f\"{1}&f\"&a en prioridad de &b{2}&a removido en el servidor &b{3}&a."
-removeprefix-server-world-success: "&b{0}&a tiene el prefijo &f\"{1}&f\"&a en prioridad de &b{2}&a removido en el servidor &b{3}&a, mundo &b{4}&a."
-addsuffix-success: "&b{0}&a tiene el sufijo &f\"{1}&f\"&a establecido en prioridad de &b{2}&a."
-addsuffix-server-success: "&b{0}&a tiene el sufijo &f\"{1}&f\"&a establecido en prioridad de &b{2}&a en el servidor &b{3}&a."
-addsuffix-server-world-success: "&b{0}&a tiene el sufijo &f\"{1}&f\"&a establecido en prioridad de &b{2}&a en el servidor &b{3}&a, mundo &b{4}&a."
-removesuffix-success: "&b{0}&a tiene el sufijo &f\"{1}&f\"&a en prioridad de &b{2}&a removido."
-removesuffix-server-success: "&b{0}&a tiene el sufijo &f\"{1}&f\"&a en prioridad de &b{2}&a removido en el servidor &b{3}&a."
-removesuffix-server-world-success: "&b{0}&a tiene el sufijo &f\"{1}&f\"&a en prioridad de &b{2}&a removido en el servidor &b{3}&a, mundo &b{4}&a."
-add-temp-prefix-success: "&b{0}&a tiene el prefijo &f\"{1}&f\"&a en prioridad de &b{2}&a por una duracion de &b{3}&a."
-add-temp-prefix-server-success: "&b{0}&a tiene el prefijo &f\"{1}&f\"&a establecido en prioridad de &b{2}&a en el servidor &b{3}&a, por una duracion de &b{4}&a."
-add-temp-prefix-server-world-success: "&b{0}&a tiene el prefijo &f\"{1}&f\"&a establecido en prioridad de &b{2}&a en el servidor &b{3}&a, mundo &b{4}&a, por una duracion de &b{5}&a."
-remove-temp-prefix-success: "&b{0}&a tiene temporalmente el prefijo &f\"{1}&f\"&a en prioridad de &b{2}&a removido."
-remove-temp-prefix-server-success: "&b{0}&a tiene temporalmente el prefijo &f\"{1}&f\"&a en prioridad de &b{2}&a removido en el servidor &b{3}&a."
-remove-temp-prefix-server-world-success: "&b{0}&a tiene temporalmente el prefijo &f\"{1}&f\"&a en prioridad de &b{2}&a removido en el servidor &b{3}&a, mundo &b{4}&a."
-add-temp-suffix-success: "&b{0}&a tiene el sufijo &f\"{1}&f\"&a establecido en prioridad de &b{2}&a por una duracion de &b{3}&a."
-add-temp-suffix-server-success: "&b{0}&a tiene el sufijo &f\"{1}&f\"&a establecido en prioridad de &b{2}&a en el servidor &b{3}&a, por una duracion de &b{4}&a."
-add-temp-suffix-server-world-success: "&b{0}&a tiene el sufijo &f\"{1}&f\"&a establecido en prioridad de &b{2}&a en el servidor &b{3}&a, mundo &b{4}&a, por una duracion de &b{5}&a."
-remove-temp-suffix-success: "&b{0}&a tiene temporalmente el sufijo &f\"{1}&f\"&a en prioridad de &b{1}&a removido."
-remove-temp-suffix-server-success: "&b{0}&a tiene temporalmente el sufijo &f\"{1}&f\"&a en prioridad de &b{2}&a removido en el servidor &b{3}&a."
-remove-temp-suffix-server-world-success: "&b{0}&a tiene temporalmente el sufijo &f\"{1}&f\"&a en prioridad de &b{2}&a removido en el servidor &b{3}&a, mundo &b{4}&a."
-already-has-meta: "{0} ya tiene ese par de valores de llave meta establecido."
-set-meta-success: "&aEstablecer el valor meta para la llave &f\"{0}&f\"&a a &f\"{1}&f\"&a para &b{2}&a."
-set-meta-server-success: "&aEstablecer el valor meta para la llave &f\"{0}&f\"&a a &f\"{1}&f\"&a para &b{2}&a en el servidor &b{3}&a."
-set-meta-server-world-success: "&aEstablecer el valor meta para la llave &f\"{0}&f\"&a a &f\"{1}&f\"&a para &b{2}&a en el servidor &b{3}&a, mundo &b{4}&a."
-set-meta-temp-success: "&aEstablecer el valor meta para la llave &f\"{0}&f\"&a a &f\"{1}&f\"&a para &b{2}&a por una duracion de &b{3}&a."
-set-meta-temp-server-success: "&aEstablecer el valor meta para la llave &f\"{0}&f\"&a a &f\"{1}&f\"&a para &b{2}&a en el servidor &b{3}&a por una duracion de &b{4}&a."
-set-meta-temp-server-world-success: "&aEstablecer el valor meta para la llave &f\"{0}&f\"&a a &f\"{1}&f\"&a para &b{2}&a en el servidor &b{3}&a, mundo &b{4}&a, por una duracion de &b{5}&a."
-unset-meta-success: "&aDesestablecer el valor meta con la llave &f\"{0}&f\"&a para &b{1}&a."
-unset-meta-server-success: "&aDesestablecer el valor meta con la llave &f\"{0}&f\"&a para &b{1}&a en el servidor &b{2}&a."
-unset-meta-server-world-success: "&aDesestablecer el valor meta con la llave &f\"{0}&f\"&a for &b{1}&a en el servidor &b{2}&a, mundo &b{3}&a."
-unset-meta-temp-success: "&aDesestablecer temporalmente el valor meta con la llave &f\"{0}&f\"&a para &b{1}&a."
-unset-meta-temp-server-success: "&aDesestablecer temporalmente el valor meta con la llave &f\"{0}&f\"&a para &b{1}&a en el servidor &b{2}&a."
-unset-meta-temp-server-world-success: "&aDesestablecer temporalmente el valor meta con la llave &f\"{0}&f\"&a para &b{1}&a en el servidor &b{2}&a, mundo &b{3}&a."
-bulk-change-type-error: "Tipo no válido. Se estaba esperando 'server' o 'world'."
-bulk-change-success: "&aEl cambio masivo fue aplicado correctamente. {0} los registros fueron cambiados."
-user-info-general: >
-  {PREFIX}&b&l> &bUser Info: &f{0}\n
-  {PREFIX}&f- &3UUID: &f{1}\n
-  {PREFIX}&f- &3Status: {2}\n
-  {PREFIX}&f- &3Primary Group: &f{3}\n
-  {PREFIX}&f- &aCounts:\n
-  {PREFIX}&f-    &3Permissions: &a{4}\n
-  {PREFIX}&f-    &3Temporary Permissions: &a{5}\n
-  {PREFIX}&f-    &3Prefixes: &a{6}\n
-  {PREFIX}&f-    &3Suffixes: &a{7}\n
-  {PREFIX}&f-    &3Meta: &a{8}
-user-info-data: >
-  {PREFIX}&f- &aCached Data:\n
-  {PREFIX}&f-    &3Is Loaded: {0}\n
-  {PREFIX}&f-    &3Current Contexts: {1}\n
-  {PREFIX}&f-    &3Current Prefix: {2}\n
-  {PREFIX}&f-    &3Current Suffix: {3}
-info-parent-header: "&f- &aGrupos Parentales:"
-info-temp-parent-header: "&f- &aGrupos Temporalmente Parentales:"
-user-getuuid: "&bEl UUID de &b{0}&b es &b{1}&b."
-user-removegroup-error-primary: "No puede eliminar un usuario de su grupo principal."
-user-primarygroup-success: "&b{0}&a's grupo primario se estableció &b{1}&a."
-user-primarygroup-warn-option: "&cAdvertencia: El método de cálculo de grupo primario utilizado por este servidor &7({0}) &cpuede no reflejar este cambio."
-user-primarygroup-error-alreadyhas: "El usuario ya tiene este grupo configurado como su grupo principal."
-user-primarygroup-error-notmember: "&b{0}&a ya no era miembro de &b{1}&a, agregándolos ahora."
-user-track-error-not-contain-group: "El usuario especificado ya no está en ningún grupo de esta pista."
-user-track-added-to-first: "&b{0}&a no está en ningún grupo en esta pista, por lo que se agregaron al primer grupo, &b{1}&a."
-user-track-added-to-first-server: "&b{0}&a no está en ningún grupo en esta pista, por lo que se agregaron al primer grupo, &b{1}&a, en el servidor &b{2}&a."
-user-track-added-to-first-server-world: "&b{0}&a no está en ningún grupo en esta pista, por lo que se agregaron al primer grupo, &b{1}&a, en el servidor &b{2}&a, mundo &b{3}&a."
-user-promote-success: "&aPromover al usuario a lo largo de la pista &b{0}&a desde &b{1}&a a &b{2}&a."
-user-promote-success-server: "&aPromover al usuario a lo largo de la pista &b{0}&a desde &b{1}&a a &b{2}&a en el servidor &b{3}&a."
-user-promote-success-server-world: "&aPromover al usuario a lo largo de la pista &b{0}&a desde &b{1}&a a &b{2}&a en el servidor &b{3}&a, mundo &b{4}&a."
-user-promote-error-endoftrack: "El final de la pista &4{0}&c fue alcanzado. No se puede promover al usuario."
-user-promote-error-malformed: >
-  {PREFIX}The next group on the track, {0}, no longer exists. Unable to promote user.\n
-  {PREFIX}Either create the group, or remove it from the track and try again.
-user-demote-success: "&aDegradando al usuario a lo largo de la pista &b{0}&a desde &b{1}&a a &b{2}&a."
-user-demote-success-server: "&aDegradando al usuario a lo largo de la pista &b{0}&a desde &b{1}&a a &b{2}&a en el servidor &b{3}&a."
-user-demote-success-server-world: "&aDegradando al usuario a lo largo de la pista &b{0}&a desde &b{1}&a a &b{2}&a en el servidor &b{3}&a, mundo &b{4}&a."
-user-demote-endoftrack: "El final de la pista &4{0}&c fue alcanzado, asi que &4{1}&c fue removido de &4{2}&c."
-user-demote-error-malformed: >
-  {PREFIX}The previous group on the track, {0}, no longer exists. Unable to demote user.\n
-  {PREFIX}Either create the group, or remove it from the track and try again.
-user-showpos: >
-  &aShowing &b{0}&a's position on track &b{1}&a.\n
-  {2}
-group-info-general: >
-  {PREFIX}&b&l> &bGroup Info: &f{0}\n
-  {PREFIX}&f- &3Display Name: &f{1}\n
-  {PREFIX}&f- &3Weight: &f{2}\n
-  {PREFIX}&f- &aCounts:\n
-  {PREFIX}&f-    &3Permissions: &a{3}\n
-  {PREFIX}&f-    &3Temporary Permissions: &a{4}\n
-  {PREFIX}&f-    &3Prefixes: &a{5}\n
-  {PREFIX}&f-    &3Suffixes: &a{6}\n
-  {PREFIX}&f-    &3Meta: &a{7}
-group-set-weight: "&aEstablesca el peso a &b{0}&a para el grupo &b{1}&a."
-track-info: >
-  {PREFIX}&b&l> &bShowing Track: &f{0}\n
-  {PREFIX}&f- &7Path: &f{1}
-track-clear: "&b{0}&a's pista de grupos fue borrada."
-track-append-success: "&aGrupo &b{0}&a fue añadido con éxito a la pista &b{1}&a."
-track-insert-success: "&aGrupo &b{0}&a fue insertado con éxito en la pista &b{1}&a en la posicion &b{2}&a."
-track-insert-error-number: "Numero esperado en lugar de recibido: {0}"
-track-insert-error-invalid-pos: "No se puede insertar en la posición {0}. Indice fuera de los limites."
-track-remove-success: "&aGrupo &b{0}&a se eliminó correctamente de la pista &b{1}&a."
-log-load-error: "No se pudo cargar el registro."
-log-invalid-page: "Número de página no válido."
-log-invalid-page-range: "Número de página no válido. Por favor introduzca un valor entre 1 y {0}."
-log-no-entries: "&bNo hay entradas de registro que mostrar."
-log-entry: "&b#{0} -> &8(&7{1} hace&8) {2}"
-log-notify-toggle-on: "&aHabilitada&b salida de registro."
-log-notify-toggle-off: "&cDeshabilitada&b salida de registro."
-log-notify-already-on: "Ya está recibiendo notificaciones."
-log-notify-already-off: "Actualmente no estás recibiendo notificaciones."
-log-notify-unknown: "Estado desconocido. Esperando \"on\" o \"off\"."
-log-search-header: "&aMostrar acciones recientes para la consulta &b{0} &a(pagina &f{1}&a de &f{2}&a)"
-log-recent-header: "&aMostrando acciones recientes (pagina &f{0}&a de &f{1}&a)"
-log-recent-by-header: "&aMostrando las acciones recientes por &b{0} &a(pagina &f{1}&a de &f{2}&a)"
-log-history-user-header: "&aMostrando el historial del usuario &b{0} &a(pagina &f{1}&a de &f{2}&a)"
-log-history-group-header: "&aMostrando la historia del grupo &b{0} &a(pagina &f{1}&a de &f{2}&a)"
-log-history-track-header: "&aMostrando la historia de la pista &b{0} &a(pagina &f{1}&a de &f{2}&a)"
-log-export-already-exists: "Error: Archivo {0} ya existe."
-log-export-not-writable: "Error: Archivo {0} no se puede escribir."
-log-export-empty: "El registro está vacío y por lo tanto no puede ser exportado."
-log-export-failure: "Se ha producido un error inesperado al escribir en el archivo."
-log-export-success: "&aExitosamente exportó el registro a &b{0}&a."
-import-already-running: "Ya se está ejecutando otro proceso de importación. Por favor espere a que finalice e inténtelo de nuevo."
-export-already-running: "Ya se está ejecutando otro proceso de exportación. Por favor espere a que finalice e inténtelo de nuevo."
-import-log-doesnt-exist: "Error: Archivo {0} no existe."
-import-log-not-readable: "Error: Archivo {0} no es legible."
-import-log-failure: "Se ha producido un error inesperado al leer del archivo de registro."
-import-progress: "&b(Import) &b-> &f{0} &fporcentaje completado &7- &b{1}&f/&b{2} &fOperaciones completas con &c{3} &ferrores."
-import-progress-sin: "&b(Import) &b-> &f{0} &fporcentaje completado &7- &b{1}&f/&b{2} &fOperaciones completas con &c{3} &ferrores."
-import-start: "&b(Import) &b-> &fInicio del proceso de importación."
-import-end-complete: "&b(Import) &a&lCOMPLETADO &7- tomo &b{0} &7segundos - &7No errores."
-import-end-complete-err: "&b(Import) &a&lCOMPLETADO &7- tomo &b{0} &7segundos - &c{1} errores."
-import-end-complete-err-sin: "&b(Import) &a&lCOMPLETADO &7- tomo &b{0} &7segundos - &c{1} errores."
-import-end-error-header: >
-  {PREFIX}&b(Import) &7------------> &fShowing Error #&b{0} &7<------------\n
-  {PREFIX}&b(Import) &fWhilst executing: &3Command #{1}\n
-  {PREFIX}&b(Import) &fCommand: &7{2}\n
-  {PREFIX}&b(Import) &fType: &3{3}\n
-  {PREFIX}&b(Import) &fOutput:
-import-end-error-content: "&b(Import) &b-> &c{0}"
-import-end-error-footer: "&b(Import) &7<------------------------------------------>"

.locale/ru_RU.yml

@@ -1,338 +0,0 @@
-# LuckPerms Language File
-# Locale: ru_RU
-# Author: Pixelmon.PRO
-
-prefix: "&7&l[&b&lL&3&lP&7&l] &c"
-log-info: "&7&l[&bL&3P&7&l] &3{0}"
-log-warn: "&7&l[&bLuck&3Perms&7&l] &c[WARN] {0}"
-log-error: "&7&l[&bLuck&3Perms&7&l] &4[ERROR] {0}"
-empty: "{0}"
-player-online: "&aОнлайн"
-player-offline: "&cОффлайн"
-loading-error: "Не удалось загрузить данные разрешений (пермов). Пожалуйста обратитесь к администратору."
-op-disabled: "&bНа этом сервере отключена ванильная система OP."
-op-disabled-sponge: "&2Статус оператора сервера не влияет на установленный плагин разрешений (пермов). Пожалуйста отредактируйте данные пользователя напрямую."
-log: "&3LOG &3&l> {0}"
-export-log: "&3ЭКСПОРТ &3&l> &f{0}"
-export-log-progress: "&3ЭКСПОРТ &3&l> &7{0}"
-migration-log: "&3ПЕРЕМЕЩЕНИЕ &7[&3{0}&7] &3&l> &f{1}"
-migration-log-progress: "&3ПЕРЕМЕЩЕНИЕ &7[&3{0}&7] &3&l> &7{1}"
-command-not-recognised: "Команда не распознана."
-command-no-permission: "У вас нет разрешения на использование этой команды!"
-already-haspermission: "{0} уже имеет такое разрешение (перм)!"
-does-not-havepermission: "{0} не имеет этого набора разрешений (пермов)."
-already-has-temp-permission: "{0} уже имеет этот набор временных разрешений (пермов)!"
-does-not-have-temp-permission: "{0} не имеет этого набора временных разрешений (пермов)."
-user-not-found: "&bНе удалось найти пользователя."
-user-not-online: "&bПользователь &a{0}&b не онлайн."
-user-no-data: "&bПользователь &a{0}&b не имеет загруженных данных."
-user-save-success: "&7(Пользовательские данные были сохранены на хранение)"
-user-save-error: "При сохранении пользователя произошла ошибка."
-user-create-fail: "При создании нового пользователя возникла ошибка."
-group-not-found: "&bНе удалось найти группу."
-group-save-success: "&7(Групповые данные были сохранены на хранение)"
-group-save-error: "При сохранении группы произошла ошибка."
-track-not-found: "&bНе удалось найти путь (track)."
-track-save-success: "&7(Данные о путе (track) сохранены на хранение)"
-track-save-error: "При сохранении пути (track) произошла ошибка."
-user-invalid-entry: "&d{0}&c не является допустимым именем пользователя/uuid."
-group-invalid-entry: "Имена групп могут содержать только буквенно-цифровые символы."
-track-invalid-entry: "Имена путей (track) могут содержать только буквенно-цифровые символы."
-server-invalid-entry: "Имена серверов могут содержать только буквенно-цифровые символы."
-use-inherit-command: "Используйте команды «parent add» и «parent remove» вместо указания узла (node)."
-verbose-invalid-filter: "&cНедопустимый подробный (verbose) фильтр: &f{0}"
-verbose-on: "&Запись подробной проверки установлена на &aВЕРНЫЙ &bдля всех разрешений (пермов)."
-verbose-on-query: "&Запись подробной проверки установлена на &aВЕРНЫЙ &bДля разрешений, соответствующих следующим фильтрам: &f{0}"
-verbose-off: "&Запись подробной проверки установлена на &cНЕВЕРНЫЙ&b."
-verbose-recording-on: "&Запись подробной записи установлена ​​на &aВЕРНЫЙ &bдля всех разрешений."
-verbose-recording-on-query: "&Запись подробной записи установлена ​​на &aВЕРНЫЙ &bДля разрешений, соответствующих следующим фильтрам: &f{0}"
-verbose-recording-upload-start: "&bЗапись подробной информации была отключена. Загрузка результатов..."
-verbose-recording-url: "&aПодробный URL результатов:"
-tree-upload-start: "&bСоздание дерева разрешений..."
-tree-empty: "&aНе удалось создать дерево. Ничего не найдено."
-tree-url: "&aURL дерева разрешений:"
-search-searching: "&aПоиск пользователей и групп с помощью &b{0}&a..."
-search-result: "&aНайдено &b{0}&a записи из &b{1}&a пользователей и &b{2}&a групп."
-search-showing-users: "&bПросмотр записей пользователя:"
-search-showing-groups: "&bПросмотр записей в группах:"
-search-showing-users-with-page: "&bПросмотр записей пользователя:  {0}"
-search-showing-groups-with-page: "&bПросмотр записей в группах:  {0}"
-check-result: "&aРезультат проверки разрешения (перма) на пользователя &b{0}&a на разрешение (перма) &b{1}&a: &f{2}"
-create-success: "&b{0}&a было успешно создано."
-delete-success: "&b{0}&a успешно удален."
-rename-success: "&b{0}&a был успешно переименован в &b{1}&a."
-clone-success: "&b{0}&a был успешно клонирован на &b{1}&a."
-already-inherits: "{0} уже наследует '{1}'."
-does-not-inherit: "{0} не наследует '{1}'."
-already-temp-inherits: "{0} уже временно наследует '{1}'."
-does-not-temp-inherit: "{0} временно не наследует '{1}'."
-track-already-contains: "Путь (Track) {0} уже содержит группу '{1}'."
-track-does-not-contain: "Путь (Track) {0} не содержит группу '{1}'."
-track-ambiguous-call: "Указанный пользователь является членом нескольких групп на этом пути (track). Невозможно определить их местоположение."
-group-already-exists: "Эта группа уже существует!"
-group-does-not-exist: "Эта группа не существует!"
-group-load-error: "Произошла непредвиденная ошибка. Группа не загружена."
-groups-load-error: "Произошла непредвиденная ошибка. Не удалось загрузить все группы."
-track-already-exists: "Этот путь (track) уже существует!"
-track-does-not-exist: "Этот путь (track) не существует!"
-track-load-error: "Произошла непредвиденная ошибка. Путь (track) не загружен."
-tracks-load-error: "Произошла непредвиденная ошибка. Не удалось загрузить все пути (tracks)."
-track-empty: "Путь (track) нельзя использовать, так как он пуст или содержит только одну группу."
-update-task-request: "&bОбновление задачи запланировано."
-update-task-complete: "&aОбновление задачи завершено."
-update-task-complete-network: "&aОбновление задачи завершено. Теперь пытаемся подключиться к другим серверам."
-update-task-push-success: "&aДругие серверы были уведомлены через &b{0} Сообщения и удаленный доступ."
-update-task-push-failure: "&cОшибка при нажатии изменений на других серверах."
-update-task-push-failure-not-setup: "&cОшибка при нажатии изменений на других серверах. Служба обмена сообщениями не настроена."
-reload-config-success: "&aФайл конфигурации был перезагружен. &7(Некоторые параметры будут применяться только после перезапуска сервера.)"
-info: >
-  {PREFIX}&2Выполнение &bLuckPerms v{0}&2 by &bLuck&2.\n
-  {PREFIX}&f-  &3Платформа: &f{1}\n
-  {PREFIX}&f-  &3Способ Хранения: &f{2}\n
-  {PREFIX}&f-  &3Имя Сервера: &f{3}\n
-  {PREFIX}&f-  &3Интервал Синхронизации: &a{4} &fминут\n
-  {PREFIX}&f-  &3Служба обмена сообщениями: &f{5}\n
-  {PREFIX}&f-  &bГрафы:\n
-  {PREFIX}&f-     &3Игроки Онлайн: &a{6}\n
-  {PREFIX}&f-     &3Загруженные пользователи: &a{7}\n
-  {PREFIX}&f-     &3Загруженные группы: &a{8}\n
-  {PREFIX}&f-     &3Загруженные пути (tracks): &a{9}\n
-  {PREFIX}&f-     &3Размер лога: &a{10}\n
-  {PREFIX}&f-     &3UUID Размер кеша: &a{11}\n
-  {PREFIX}&f-     &3Переводы загружены: &a{12}\n
-  {PREFIX}&f-     &3Контексты перед обработкой: &a{13}\n
-  {PREFIX}&f-     &3Счетчик контекста: &a{14}\n
-  {PREFIX}&f-     &3Уникальные разрешения (пермы): &a{15}\n
-  {PREFIX}&f-  &bКонфигурация:\n
-  {PREFIX}&f-     &3Использует сервер UUIDs: {16}\n
-  {PREFIX}&f-     &bСчетчик разрешений (Пермов):\n
-  {PREFIX}&f-        &3Включая глобальные: {17}\n
-  {PREFIX}&f-        &3Включая глобальный мир: {18}\n
-  {PREFIX}&f-        &3Применения глобальных групп: {19}\n
-  {PREFIX}&f-        &3Применения глобальных групп мира: {20}\n
-  {PREFIX}&f-        &3Применения подстановочных знаков (Wildcards): {21}\n
-  {PREFIX}&f-        &3Применение регулярных выражений: {22}\n
-  {PREFIX}&f-        &3Применение стенографии (Shorthand): {23}
-create-group-error: "При создании группы произошла ошибка."
-delete-group-error: "При удалении группы произошла ошибка."
-delete-group-error-default: "Вы не можете удалить группу по умолчанию."
-groups-list: "&aГруппы: {0}"
-create-track-error: "При создании пути (track) произошла ошибка."
-delete-track-error: "При удалении пути (Track) произошла ошибка."
-tracks-list: "&aGenb (Tracks): {0}"
-listnodes: "&b{0}'s Узлы:"
-listnodes-with-page: "&b{0}'s Узлы:  {1}"
-listnodes-temp: >
-  &b{0}'s Временные узлы:\n
-  {1}
-listparents: >
-  &b{0}'s Родительские группы:\n
-  {1}
-listparents-temp: >
-  &b{0}'s Временные родительские группы:\n
-  {1}
-listgroups: >
-  &b{0}'s Группы:\n
-  {1}
-listgroups-temp: >
-  &b{0}'s Временные группы:\n
-  {1}
-list-tracks: >
-  &b{0}'s Пути (Tracks):\n
-  {1}
-list-tracks-empty: "{0} Не на каких-либо путях (tracks)."
-setpermission-success: "&aУстановить &b{0}&a к &b{1}&a для &b{2}&a."
-setpermission-server-success: "&aУстановить &b{0}&a к &b{1}&a для &b{2}&a на сервер &b{3}&a."
-setpermission-server-world-success: "&aУстановить &b{0}&a к &b{1}&a для &b{2}&a на сервер &b{3}&a, мир &b{4}&a."
-setpermission-temp-success: "&aУстановить &b{0}&a к &b{1}&a для &b{2}&a На срок &b{3}&a."
-setpermission-temp-server-success: "&aУстановить &b{0}&a к &b{1}&a для &b{2}&a на сервер &b{3}&a на срок &b{4}&a."
-setpermission-temp-server-world-success: "&aУстановить &b{0}&a к &b{1}&a для &b{2}&a на сервер &b{3}&a, мир &b{4}&a, на срок &b{5}&a."
-unsetpermission-success: "&aСбросить &b{0}&a для &b{1}&a."
-unsetpermission-server-success: "&aСбросить &b{0}&a для &b{1}&a on server &b{2}&a."
-unsetpermission-server-world-success: "&aСбросить &b{0}&a для &b{1}&a on server &b{2}&a, world &b{3}&a."
-unset-temp-permission-success: "&aСбросить временное разрешение &b{0}&a для &b{1}&a."
-unset-temp-permission-server-success: "&aСбросить временное разрешение &b{0}&a для &b{1}&a на сервере &b{2}&a."
-unset-temp-permission-server-world-success: "&aСбросить временное разрешение &b{0}&a для &b{1}&a на сервере &b{2}&a, мире &b{3}&a."
-set-inherit-success: "&b{0}&a теперь наследует разрешения от &b{1}&a."
-set-inherit-server-success: "&b{0}&a теперь наследует разрешения от &b{1}&a на сервере &b{2}&a."
-set-inherit-server-world-success: "&b{0}&a теперь наследует разрешения от &b{1}&a на сервере &b{2}&a, мире &b{3}&a."
-set-parent-success: "&b{0}&a их существующие родительские группы очищены, и теперь только наследуют &b{1}&a."
-set-parent-server-success: "&b{0}&a их существующие родительские группы очищены, и теперь только наследуют &b{1}&a на сервере &b{2}&a."
-set-parent-server-world-success: "&b{0}&a их существующие родительские группы очищены, и теперь только наследуют &b{1}&a на сервере &b{2}&a, мире &b{3}&a."
-set-temp-inherit-success: "&b{0}&a теперь наследует разрешения (пермы) от &b{1}&a на срок &b{2}&a."
-set-temp-inherit-server-success: "&b{0}&a теперь наследует разрешения (пермы) от &b{1}&a на сервере &b{2}&a for a duration of &b{3}&a."
-set-temp-inherit-server-world-success: "&b{0}&a теперь наследует разрешения (пермы) от &b{1}&a на сервере &b{2}&a, мире &b{3}&a, на срок &b{4}&a."
-unset-inherit-success: "&b{0}&a больше не наследует разрешения (пермы) от &b{1}&a."
-unset-inherit-server-success: "&b{0}&a больше не наследует разрешения (пермы) &b{1}&a на сервере &b{2}&a."
-unset-inherit-server-world-success: "&b{0}&a больше не наследует разрешения (пермы) &b{1}&a на сервере &b{2}&a, мире &b{3}&a."
-unset-temp-inherit-success: "&b{0}&a больше не наследует временные разрешения (пермы) &b{1}&a."
-unset-temp-inherit-server-success: "&b{0}&a больше не наследует временные разрешения (пермы) &b{1}&a на сервере &b{2}&a."
-unset-temp-inherit-server-world-success: "&b{0}&a больше не наследует временные разрешения (пермы) &b{1}&a на сервере &b{2}&a, мире &b{3}&a."
-clear-success: "&b{0}&a's разрешения (пермы) были очищены. (&b{1}&a узлы были удалены.)"
-clear-success-singular: "&b{0}&a's разрешения (пермы) были очищены. (&b{1}&a узел удален.)"
-parent-clear-success: "&b{0}&a's родители очищены. (&b{1}&a узлы были удалены.)"
-parent-clear-success-singular: "&b{0}&a's родители очищены. (&b{1}&a узел удален.)"
-meta-clear-success: "&b{0}&a's Meta очищена. (&b{1}&a узлы были удалены.)"
-meta-clear-success-singular: "&b{0}&a's Meta очищена. (&b{1}&a узел удален.)"
-illegal-date-error: "Не удалось выполнить синтаксический анализ даты '{0}'."
-past-date-error: "Вы не можете установить дату в прошлом!"
-chat-meta-prefix-header: "&b{0}'s Префиксы"
-chat-meta-suffix-header: "&b{0}'s Суффиксы"
-meta-header: "&b{0}'s Meta"
-chat-meta-entry: "&b-> {0} &f- &f\"{1}&f\" &8(&7унаследованный от &a{2}&8)"
-chat-meta-entry-with-context: "&b-> {0} &f- &f\"{1}&f\" &8(&7унаследованный от &a{2}&8){3}"
-meta-entry: "&b-> &a{0} &f= &f\"{1}&f\" &8(&7унаследованный от &a{2}&8)"
-meta-entry-with-context: "&b-> &a{0} &f= &f\"{1}&f\" &8(&7унаследованный от &a{2}&8){3}"
-chat-meta-prefix-none: "&b{0} не имеет префиксов."
-chat-meta-suffix-none: "&b{0} не имеет суффиксов."
-meta-none: "&b{0} не имеет meta."
-meta-invalid-priority: "Недопустимый приоритет '{0}'. Ожидается число."
-already-has-prefix: "{0} Уже имеет этот набор префиксов."
-already-has-suffix: "{0} Уже имеет этот набор суффиксов."
-does-not-have-prefix: "{0} Не имеет этого набора префиксов."
-does-not-have-suffix: "{0} Не имеет этого набора суффиксов."
-addprefix-success: "&b{0}&a имеет префикс &f\"{1}&f\"&a установленный в приоритете &b{2}&a."
-addprefix-server-success: "&b{0}&a имеет префикс &f\"{1}&f\"&a установленный в приоритете &b{2}&a на сервере &b{3}&a."
-addprefix-server-world-success: "&b{0}&a имеет префикс &f\"{1}&f\"&a установленный в приоритете &b{2}&a на сервере &b{3}&a, мире &b{4}&a."
-removeprefix-success: "&b{0}&a имеет префикс &f\"{1}&f\"&a в приоритете &b{2}&a удалено."
-removeprefix-server-success: "&b{0}&a имеет префикс &f\"{1}&f\"&a в приоритете &b{2}&a удалено на сервере &b{3}&a."
-removeprefix-server-world-success: "&b{0}&a имеет префикс &f\"{1}&f\"&a в приоритете &b{2}&a удалено на сервере &b{3}&a, мире &b{4}&a."
-addsuffix-success: "&b{0}&a имеет суффикс &f\"{1}&f\"&a установленный в приоритете &b{2}&a."
-addsuffix-server-success: "&b{0}&a имеет суффикс &f\"{1}&f\"&a установленный в приоритете &b{2}&a на сервере &b{3}&a."
-addsuffix-server-world-success: "&b{0}&a имеет суффикс &f\"{1}&f\"&a установленный в приоритете &b{2}&a on server &b{3}&a, мире &b{4}&a."
-removesuffix-success: "&b{0}&a имеет суффикс &f\"{1}&f\"&a в приоритете &b{2}&a удалено."
-removesuffix-server-success: "&b{0}&a имеет суффикс &f\"{1}&f\"&a в приоритете &b{2}&a удалено на сервере &b{3}&a."
-removesuffix-server-world-success: "&b{0}&a имеет суффикс &f\"{1}&f\"&a в приоритете &b{2}&a удалено на сервере &b{3}&a, мире &b{4}&a."
-add-temp-prefix-success: "&b{0}&a имеет префикс &f\"{1}&f\"&a установленный в приоритете &b{2}&a на срок &b{3}&a."
-add-temp-prefix-server-success: "&b{0}&a имеет префикс &f\"{1}&f\"&a установленный в приоритете of &b{2}&a на сервере &b{3}&a, на срок &b{4}&a."
-add-temp-prefix-server-world-success: "&b{0}&a имеет префикс &f\"{1}&f\"&a установленный в приоритете of &b{2}&a на сервере &b{3}&a, мире &b{4}&a, на срок &b{5}&a."
-remove-temp-prefix-success: "&b{0}&a Имел временный префикс &f\"{1}&f\"&a в приоритете &b{2}&a удалено."
-remove-temp-prefix-server-success: "&b{0}&a Имел временный префикс &f\"{1}&f\"&a в приоритете &b{2}&a удалено на сервере &b{3}&a."
-remove-temp-prefix-server-world-success: "&b{0}&a Имел временный префикс &f\"{1}&f\"&a в приоритете &b{2}&a удалено на сервере &b{3}&a, мире &b{4}&a."
-add-temp-suffix-success: "&b{0}&a имел суффикс &f\"{1}&f\"&a установленный в приоритете &b{2}&a на срок &b{3}&a."
-add-temp-suffix-server-success: "&b{0}&a имел суффикс &f\"{1}&f\"&a установленный в приоритете &b{2}&a на сервере &b{3}&a, на срок &b{4}&a."
-add-temp-suffix-server-world-success: "&b{0}&a имел суффикс &f\"{1}&f\"&a установленный в приоритете &b{2}&a на сервере &b{3}&a, мире &b{4}&a, на срок &b{5}&a."
-remove-temp-suffix-success: "&b{0}&a Имел временный суффикс &f\"{1}&f\"&a в приоритете &b{1}&a удалено."
-remove-temp-suffix-server-success: "&b{0}&a Имел временный суффикс &f\"{1}&f\"&a в приоритете &b{2}&a удалено на сервере &b{3}&a."
-remove-temp-suffix-server-world-success: "&b{0}&a Имел временный суффикс &f\"{1}&f\"&a в приоритете &b{2}&a удалено на сервере &b{3}&a, мире &b{4}&a."
-already-has-meta: "{0} Уже установлено, что установлена ​​пара мета-значения ключа."
-set-meta-success: "&aУстановить метазначение для ключа &f\"{0}&f\"&a к &f\"{1}&f\"&a для &b{2}&a."
-set-meta-server-success: "&aУстановить метазначение для ключа &f\"{0}&f\"&a к &f\"{1}&f\"&a для &b{2}&a на сервере &b{3}&a."
-set-meta-server-world-success: "&aУстановить метазначение для ключа &f\"{0}&f\"&a к &f\"{1}&f\"&a для &b{2}&a на сервере &b{3}&a, мире &b{4}&a."
-set-meta-temp-success: "&aУстановить метазначение для ключа &f\"{0}&f\"&a к &f\"{1}&f\"&a для &b{2}&a на срок &b{3}&a."
-set-meta-temp-server-success: "&aУстановить метазначение для ключа &f\"{0}&f\"&a к &f\"{1}&f\"&a для &b{2}&a на сервере &b{3}&a на срок &b{4}&a."
-set-meta-temp-server-world-success: "&aУстановить метазначение для ключа &f\"{0}&f\"&a к &f\"{1}&f\"&a для &b{2}&a на сервере &b{3}&a, мире &b{4}&a, на срок &b{5}&a."
-unset-meta-success: "&aСбросить метазначение с помощью ключа &f\"{0}&f\"&a для &b{1}&a."
-unset-meta-server-success: "&aСбросить метазначение с помощью ключа &f\"{0}&f\"&a для &b{1}&a на сервере &b{2}&a."
-unset-meta-server-world-success: "&aСбросить метазначение с помощью ключа &f\"{0}&f\"&a для &b{1}&a на сервере &b{2}&a, мире &b{3}&a."
-unset-meta-temp-success: "&aUnset temporary meta value with key &f\"{0}&f\"&a для &b{1}&a."
-unset-meta-temp-server-success: "&aСбросить временное мета-значение с помощью ключа &f\"{0}&f\"&a для &b{1}&a на сервере &b{2}&a."
-unset-meta-temp-server-world-success: "&aСбросить временное мета-значение с помощью ключа &f\"{0}&f\"&a для &b{1}&a на сервере &b{2}&a, мире &b{3}&a."
-bulk-change-type-error: "Недопустимый тип. ожидание 'server' или 'world'."
-bulk-change-success: "&aПрименение изменения успешно. {0} записей изменено."
-user-info-general: >
-  {PREFIX}&b&l> &bИнформация о пользователе: &f{0}\n
-  {PREFIX}&f- &3UUID: &f{1}\n
-  {PREFIX}&f- &3Статус: {2}\n
-  {PREFIX}&f- &3Первичная группа: &f{3}\n
-  {PREFIX}&f- &aГрафы:\n
-  {PREFIX}&f-    &3Разрешения (пермы): &a{4}\n
-  {PREFIX}&f-    &3Временные разрешения (пермы): &a{5}\n
-  {PREFIX}&f-    &3Префиксы: &a{6}\n
-  {PREFIX}&f-    &3Суффиксы: &a{7}\n
-  {PREFIX}&f-    &3Meta: &a{8}
-user-info-data: >
-  {PREFIX}&f- &aКэшированные данные:\n
-  {PREFIX}&f-    &3Загружается: {0}\n
-  {PREFIX}&f-    &3Текущие контексты: {1}\n
-  {PREFIX}&f-    &3Текущие префиксы: {2}\n
-  {PREFIX}&f-    &3Текущие суффиксы: {3}
-info-parent-header: "&f- &aРодительские группы:"
-info-temp-parent-header: "&f- &aВременные родительские группы:"
-user-getuuid: "&bUUID для &b{0}&b это &b{1}&b."
-user-removegroup-error-primary: "Вы не можете удалить пользователя из своей основной группы."
-user-primarygroup-success: "&b{0}&a's для основной группы установил значение &b{1}&a."
-user-primarygroup-warn-option: "&cВнимание: метод расчета основной группы, используемый этим сервером &7({0}) &cМожет не отражать это изменение."
-user-primarygroup-error-alreadyhas: "Пользователь уже установил эту группу в качестве основной группы."
-user-primarygroup-error-notmember: "&b{0}&a еще не был членом &b{1}&a, Добавить его сейчас."
-user-track-error-not-contain-group: "Указанный пользователь не находится ни в каких группах на этом  пути (track)."
-user-track-added-to-first: "&b{0}&a Не находится ни в каких группах на этом пути (track), поэтому они были добавлены в первую группу, &b{1}&a."
-user-track-added-to-first-server: "&b{0}&a Не находится ни в каких группах на этом пути (track), поэтому они были добавлены в первую группу, &b{1}&a, на сервере &b{2}&a."
-user-track-added-to-first-server-world: "&b{0}&a Не находится ни в каких группах на этом пути (track), поэтому они были добавлены в первую группу, &b{1}&a, на сервере &b{2}&a, мире &b{3}&a."
-user-promote-success: "&aПродвижение пользователя по пути (track) &b{0}&a от &b{1}&a к &b{2}&a."
-user-promote-success-server: "&aПродвижение пользователя по пути (track) &b{0}&a от &b{1}&a к &b{2}&a на сервере &b{3}&a."
-user-promote-success-server-world: "&aПродвижение пользователя по пути (track) &b{0}&a от &b{1}&a к &b{2}&a на сервере &b{3}&a, мире &b{4}&a."
-user-promote-error-endoftrack: "Конец пути (track) &4{0}&c ,был достигнут. Не удалось продвинуть пользователя."
-user-promote-error-malformed: >
-  {PREFIX}Следующая группа на пути (track), {0}, более не существует. Не удалось продвинуть пользователя.\n
-  {PREFIX}Создайте группу или удалите ее с пути (track) и повторите попытку.
-user-demote-success: "&aПонижение пользователя по пути (track) &b{0}&a от &b{1}&a к &b{2}&a."
-user-demote-success-server: "&aПонижение пользователя по пути (track) &b{0}&a от &b{1}&a к &b{2}&a на сервере &b{3}&a."
-user-demote-success-server-world: "&aПонижение пользователя по пути (track) &b{0}&a от &b{1}&a к &b{2}&a на сервере &b{3}&a, мире &b{4}&a."
-user-demote-endoftrack: "Конец пути (track) &4{0}&c был достингут, поэтому &4{1}&c был удален из &4{2}&c."
-user-demote-error-malformed: >
-  {PREFIX}Предыдущая группа на пути (track), {0}, более не существуют. Невозможно понизить рейтинг пользователя.\n
-  {PREFIX}Создайте группу или удалите ее с пути (track) и повторите попытку.
-user-showpos: >
-  &aпоказывает &b{0}&a's позицию на пути (track) &b{1}&a.\n
-  {2}
-group-info-general: >
-  {PREFIX}&b&l> &bИнфо о группе: &f{0}\n
-  {PREFIX}&f- &3Отображаемое имя: &f{1}\n
-  {PREFIX}&f- &3Значение: &f{2}\n
-  {PREFIX}&f- &aГрафы:\n
-  {PREFIX}&f-    &3Разрешения (пермы): &a{3}\n
-  {PREFIX}&f-    &3Временные разрешения (пермы): &a{4}\n
-  {PREFIX}&f-    &3Префиксы: &a{5}\n
-  {PREFIX}&f-    &3Суффиксы: &a{6}\n
-  {PREFIX}&f-    &3Meta: &a{7}
-group-set-weight: "&aУстановить значение &b{0}&a для группы &b{1}&a."
-track-info: >
-  {PREFIX}&b&l> &bпоказать путь (track): &f{0}\n
-  {PREFIX}&f- &7Путь: &f{1}
-track-clear: "&b{0}&a's путь (track) групп был очищен."
-track-append-success: "&aГруппа &b{0}&a успешно добавлен в путь (track) &b{1}&a."
-track-insert-success: "&aГруппа &b{0}&a был успешно добавлен в путь (track) &b{1}&a на позиции &b{2}&a."
-track-insert-error-number: "Ожидаемое число, но вместо этого получено: {0}"
-track-insert-error-invalid-pos: "Невозможно вставить в позицию {0}. Индекс вне пределов."
-track-remove-success: "&aгруппа &b{0}&a Успешно удален с пути (track) &b{1}&a."
-log-load-error: "Не удалось загрузить лог."
-log-invalid-page: "Недействительный номер страницы."
-log-invalid-page-range: "Недопустимый номер страницы. Введите значение от 1 до {0}."
-log-no-entries: "&bНет логов для отображения."
-log-entry: "&b#{0} -> &8(&7{1} ago&8) {2}"
-log-notify-toggle-on: "&aВключен&b вывод лога."
-log-notify-toggle-off: "&cОтключен&b вывод лога."
-log-notify-already-on: "Вы уже получаете оповещения."
-log-notify-already-off: "Вы не получаете оповещений."
-log-notify-unknown: "Состояние неизвестно. Ожидание \"on\" или \"off\"."
-log-search-header: "&aПросмотр недавних действий для запроса &b{0} &a(page &f{1}&a of &f{2}&a)"
-log-recent-header: "&aПоследние действия (page &f{0}&a of &f{1}&a)"
-log-recent-by-header: "&aПоказывать последние действия &b{0} &a(page &f{1}&a of &f{2}&a)"
-log-history-user-header: "&aОтображение истории для пользователя &b{0} &a(page &f{1}&a of &f{2}&a)"
-log-history-group-header: "&aОтображение истории для группы &b{0} &a(page &f{1}&a of &f{2}&a)"
-log-history-track-header: "&aОтображение истории для пути (track) &b{0} &a(page &f{1}&a of &f{2}&a)"
-log-export-already-exists: "Ошибка: файл {0} уже существует."
-log-export-not-writable: "Ошибка: файл {0} недоступен для записи."
-log-export-empty: "Журнал пуст и поэтому не может быть экспортирован."
-log-export-failure: "Произошла непредвиденная ошибка во время записи в файл."
-log-export-success: "&aФайл журнала успешно экспортирован в &b{0}&a."
-import-already-running: "Другой процесс импорта уже запущен. Дождитесь завершения и повторите попытку."
-export-already-running: "Еще один процесс экспорта уже запущен. Дождитесь завершения и повторите попытку."
-import-log-doesnt-exist: "Ошибка: файл {0} не существует."
-import-log-not-readable: "Ошибка: файл {0} не читается."
-import-log-failure: "Произошла непредвиденная ошибка при чтении лога."
-import-progress: "&b(Импортировать) &b-> &f{0} &fПроцент завершен &7- &b{1}&f/&b{2} &fОперации в комплекте с &c{3} &fошибками."
-import-progress-sin: "&b(Импортировать) &b-> &f{0} &fПроцент завершен &7- &b{1}&f/&b{2} &fОперации в комплекте с &c{3} &fошибками."
-import-start: "&b(Импортировать) &b-> &fЗапуск процесса импорта."
-import-end-complete: "&b(Импортировать) &a&lЗАВЕРШЕНО &7- заняло &b{0} &7секунд - &7Нет ошибок."
-import-end-complete-err: "&b(Импортировать) &a&lЗАВЕРШЕНО &7- заняло &b{0} &7секунд - &c{1} ошибок."
-import-end-complete-err-sin: "&b(Импортировать) &a&lЗАВЕРШЕНО &7- заняло &b{0} &7секунд - &c{1} ошибок."
-import-end-error-header: >
-  {PREFIX}&b(Import) &7------------> &fОтображение ошибки #&b{0} &7<------------\n
-  {PREFIX}&b(Import) &fВыполняя: &3Команду #{1}\n
-  {PREFIX}&b(Import) &fКоманда: &7{2}\n
-  {PREFIX}&b(Import) &fТип: &3{3}\n
-  {PREFIX}&b(Import) &fВывод:
-import-end-error-content: "&b(Импортировать) &b-> &c{0}"
-import-end-error-footer: "&b(Импортировать) &7<------------------------------------------>"

CONTRIBUTING.md

@@ -0,0 +1,26 @@
+### :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).
+
+### :bug: Reporting bugs?
+
+Before reporting a bug or issue, please make sure that the issue is actually being caused by or related to LuckPerms. We get a lot of reports which are caused by other software - please double check!
+
+If you're unsure, feel free to ask using the above resources BEFORE making a report.
+
+Bugs or issues should be reported using the [GitHub Issues tab](https://github.com/lucko/LuckPerms/issues).
+
+### :pencil: Want to contribute code?
+#### Pull Requests
+If you make any changes or improvements to the plugin which you think would be beneficial to others, please consider making a pull request to merge your changes back into the upstream project. (especially if your changes are bug fixes!)
+
+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. 
+
+#### Project Layout
+The project is split up into 5 seperate 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** - Each use the common module to implement plugins on the respective server platforms.

LICENSE.txt

@@ -1,6 +1,7 @@
-MIT License
+The MIT License.
 
-Copyright (c) 2016 Lucko (Luck) <luck@lucko.me>
+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

README.md

@@ -1,44 +1,46 @@
-![alt text](https://i.imgur.com/7TwJZ5e.png "Banner")
-# LuckPerms [![Build Status](https://ci.lucko.me/job/LuckPerms/badge/icon)](https://ci.lucko.me/job/LuckPerms/)
+![alt text](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://maven-badges.herokuapp.com/maven-central/me.lucko.luckperms/luckperms-api/badge.svg)](https://maven-badges.herokuapp.com/maven-central/me.lucko.luckperms/luckperms-api)
+
 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 also includes an extensive API for developers, and support for a variety of Minecraft server software & data storage options.
 
-[See the charts below](https://github.com/lucko/LuckPerms#luckperms-vs-other-plugins) for a partial list of features & comparison with other providers.
-
-* [Spigot Plugin Release Page](https://www.spigotmc.org/resources/luckperms-an-advanced-permissions-system.28140/ "Spigot Plugin Page")
-* [Sponge Plugin Release Page](https://forums.spongepowered.org/t/luckperms-an-advanced-permissions-system/14274 "Sponge Plugin Page")
+Still not convinced? More information can be found on the wiki, under: [Why LuckPerms?](https://github.com/lucko/LuckPerms/wiki/Why-LuckPerms)
 
 ## Useful Links
-* **Development Builds** - <https://ci.lucko.me/job/LuckPerms>
-* **Javadocs** - <https://luckperms.lucko.me/javadocs/>
-* **Wiki** - <https://github.com/lucko/LuckPerms/wiki>
+
+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).
 
 ## Building
-LuckPerms uses Maven to handle dependencies.
+LuckPerms uses Gradle to handle dependencies & building.
 
 #### Requirements
-* Maven 3.3.x (the older versions will not work.)
+* Java 8 JDK or newer
 * Git
 
-#### Then run
+#### Compiling from source
 ```sh
 git clone https://github.com/lucko/LuckPerms.git
-mvn clean package
+cd LuckPerms/
+./gradlew build
 ```
 
+You can find the output jars in the `build/libs` directories.
+
+## Contributing
+#### Pull Requests
+If you make any changes or improvements to the plugin which you think would be beneficial to others, please consider making a pull request to merge your changes back into the upstream project. (especially if your changes are bug fixes!)
+
+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. 
+
+#### Project Layout
+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.
+
 ## 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.
-
-## LuckPerms vs Other Plugins
-### Bukkit
-![alt text](https://luckperms.lucko.me/assets/bukkit-compare.png "Feature comparison")
-
-### Sponge
-![alt text](https://luckperms.lucko.me/assets/sponge-compare.png "Feature comparison")
-
-
-## Thanks
-[![JProfiler](https://www.ej-technologies.com/images/product_banners/jprofiler_large.png)](http://www.ej-technologies.com/products/jprofiler/overview.html)
-
-Thanks to ej-technologies for granting LuckPerms an open source licence to their [Java Profiling Software](http://www.ej-technologies.com/products/jprofiler/overview.html "Java Profiler").

api/build.gradle

@@ -0,0 +1,93 @@
+project.version = '4.3'
+
+dependencies {
+    compileOnly 'com.google.guava:guava:19.0'
+    compileOnly 'org.checkerframework:checker-qual:2.5.5'
+}
+
+// disabled by default
+if (false && project.hasProperty('sonatypeUsername') && project.hasProperty('sonatypePassword')) {
+    apply plugin: 'signing'
+
+    javadoc {
+        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/'
+        )
+        options.addStringOption('Xdoclint:none', '-quiet')
+    }
+
+    task javadocJar(type: Jar, dependsOn: javadoc) {
+        classifier 'javadoc'
+        from javadoc.destinationDir
+    }
+
+    task sourcesJar(type: Jar) {
+        classifier 'sources'
+        from sourceSets.main.allSource
+    }
+
+    artifacts {
+        archives javadocJar
+        archives sourcesJar
+    }
+
+    signing {
+        useGpgCmd()
+        sign configurations.archives
+    }
+
+    uploadArchives {
+        repositories {
+            mavenDeployer {
+                beforeDeployment { MavenDeployment deployment -> signing.signPom(deployment) }
+
+                repository(url: 'https://oss.sonatype.org/service/local/staging/deploy/maven2/') {
+                    authentication(userName: sonatypeUsername, password: sonatypePassword)
+                }
+
+                pom {
+                    project {
+                        name 'LuckPerms API'
+                        description 'An advanced permissions plugin for Bukkit/Spigot, BungeeCord, Sponge, Nukkit and Velocity.'
+                        url 'https://github.com/lucko/LuckPerms'
+
+                        licenses {
+                            license {
+                                name 'MIT'
+                                url 'https://opensource.org/licenses/MIT'
+                            }
+                        }
+
+                        developers {
+                            developer {
+                                name 'Luck'
+                                email 'git@lucko.me'
+                                url 'https://github.com/lucko'
+                            }
+                        }
+
+                        scm {
+                            connection 'scm:git:https://github.com/lucko/LuckPerms.git'
+                            developerConnection 'scm:git:git@github.com:lucko/LuckPerms.git'
+                            url 'https://github.com/lucko/LuckPerms'
+
+                        }
+
+                        ciManagement {
+                            system 'Jenkins'
+                            url 'https://ci.lucko.me/job/LuckPerms'
+                        }
+
+                        issueManagement {
+                            system 'GitHub'
+                            url 'https://github.com/lucko/LuckPerms/issues'
+                        }
+                    }
+                }
+            }
+        }
+    }
+}

api/pom.xml

@@ -1,38 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-         xmlns="http://maven.apache.org/POM/4.0.0"
-         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
-    <parent>
-        <artifactId>luckperms</artifactId>
-        <groupId>me.lucko.luckperms</groupId>
-        <version>3.1-SNAPSHOT</version>
-    </parent>
-    <modelVersion>4.0.0</modelVersion>
-
-    <artifactId>luckperms-api</artifactId>
-    <build>
-        <finalName>LuckPerms-API-${release.version}</finalName>
-        <plugins>
-            <plugin>
-                <groupId>org.apache.maven.plugins</groupId>
-                <artifactId>maven-compiler-plugin</artifactId>
-                <version>${compiler.version}</version>
-                <configuration>
-                    <source>1.8</source>
-                    <target>1.8</target>
-                </configuration>
-            </plugin>
-        </plugins>
-    </build>
-
-    <dependencies>
-        <!-- guava -->
-        <dependency>
-            <groupId>com.google.guava</groupId>
-            <artifactId>guava</artifactId>
-            <version>19.0</version>
-            <scope>provided</scope>
-        </dependency>
-    </dependencies>
-
-</project>

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

@@ -1,5 +1,8 @@
 /*
- * Copyright (c) 2016 Lucko (Luck) <luck@lucko.me>
+ * 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
@@ -24,48 +27,62 @@ package me.lucko.luckperms;
 
 import me.lucko.luckperms.api.LuckPermsApi;
 
+import org.checkerframework.checker.nullness.qual.NonNull;
+
 import java.util.Optional;
 
 /**
- * Singleton for the {@link LuckPermsApi}.
+ * Provides static access to the {@link LuckPermsApi}.
  *
- * <p>Ideally, the ServiceManager for the platform should be used to obtain and cache an instance, however, this can be
- * used if you need static access.</p>
+ * <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 api = null;
+    private static LuckPermsApi instance = null;
 
     /**
-     * Gets an instance of {@link LuckPermsApi}, throwing {@link IllegalStateException} if the API is not loaded.
+     * 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 LuckPermsApi getApi() {
-        if (api == null) {
+    public static @NonNull LuckPermsApi getApi() {
+        if (instance == null) {
             throw new IllegalStateException("API is not loaded.");
         }
-        return api;
+        return instance;
     }
 
     /**
-     * Gets an instance of {@link LuckPermsApi} safely.
+     * Gets an instance of {@link LuckPermsApi}, if it is loaded.
      *
-     * <p> Unlike {@link LuckPerms#getApi}, this method will not throw an {@link IllegalStateException} if the API is
-     * not loaded, rather return an empty {@link Optional}.
+     * <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 Optional<LuckPermsApi> getApiSafe() {
-        return Optional.ofNullable(api);
+    public static @NonNull Optional<LuckPermsApi> getApiSafe() {
+        return Optional.ofNullable(instance);
     }
 
-    static void registerProvider(LuckPermsApi luckPermsApi) {
-        api = luckPermsApi;
+    /**
+     * 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() {
-        api = null;
+        LuckPerms.instance = null;
     }
 
     private LuckPerms() {

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

@@ -0,0 +1,93 @@
+/*
+ * 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.concurrent.CompletableFuture;
+
+/**
+ * Represents the object responsible for handling action logging.
+ *
+ * @since 4.1
+ */
+public interface ActionLogger {
+
+    /**
+     * Returns a new {@link LogEntry.Builder} instance
+     *
+     * @return a new builder
+     */
+    LogEntry.@NonNull Builder newEntryBuilder();
+
+    /**
+     * Gets a {@link Log} instance from the plugin storage.
+     *
+     * @return a log instance
+     * @see Storage#getLog()
+     */
+    @NonNull CompletableFuture<Log> getLog();
+
+    /**
+     * Submits a log entry to the plugin to be handled.
+     *
+     * <p>This method submits the log to the storage provider and broadcasts
+     * it.</p>
+     *
+     * <p>It is therefore roughly equivalent to calling
+     * {@link #submitToStorage(LogEntry)} and {@link #broadcastAction(LogEntry)},
+     * 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,
+     * use this one.</p>
+     *
+     * @param entry the entry to submit
+     * @return a future which will complete when the action is done
+     */
+    @NonNull CompletableFuture<Void> submit(@NonNull LogEntry 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);
+
+    /**
+     * Submits a log entry to the plugins log broadcasting handler.
+     *
+     * <p>If enabled, this method will also dispatch the log entry via the
+     * plugins {@link MessagingService}.</p>
+     *
+     * @param entry the entry to submit
+     * @return a future which will complete when the action is done
+     */
+    @NonNull CompletableFuture<Void> broadcastAction(@NonNull LogEntry entry);
+
+}

api/src/main/java/me/lucko/luckperms/api/ChatMetaType.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 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,5 +1,8 @@
 /*
- * Copyright (c) 2016 Lucko (Luck) <luck@lucko.me>
+ * 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
@@ -22,203 +25,329 @@
 
 package me.lucko.luckperms.api;
 
+import com.google.common.collect.ImmutableSet;
+
 import me.lucko.luckperms.api.context.ContextSet;
+import me.lucko.luckperms.api.context.ImmutableContextSet;
+
+import org.checkerframework.checker.nullness.qual.NonNull;
+
+import java.util.EnumSet;
+import java.util.Objects;
+import java.util.Set;
 
 /**
- * Context and options for a permission lookup.
+ * Encapsulates the {@link ContextSet contexts} and {@link LookupSetting settings} for
+ * a permission or meta lookup.
  *
- * <p>All values are immutable.</p>
+ * <p>This class is immutable.</p>
  *
  * @since 2.11
  */
 public class Contexts {
-    public static final String SERVER_KEY = "server";
-    public static final String WORLD_KEY = "world";
-    private static final Contexts ALLOW_ALL = new Contexts(ContextSet.empty(), true, true, true, true, true, true);
 
     /**
-     * Gets a context that will allow all nodes
-     *
-     * @return a context that will not apply any filters
+     * The context key used to denote the subjects server
      */
-    public static Contexts allowAll() {
-        return ALLOW_ALL;
+    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.
+     */
+    private static final EnumSet<LookupSetting> DEFAULT_SETTINGS = EnumSet.of(
+            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(), ImmutableSet.copyOf(DEFAULT_SETTINGS));
+
+    /**
+     * Gets the {@link FullySatisfiedContexts} instance.
+     *
+     * @return a context that will satisfy all contextual requirements.
+     */
+    public static @NonNull Contexts allowAll() {
+        return FullySatisfiedContexts.getInstance();
     }
 
-    public static Contexts of(ContextSet context, boolean includeGlobal, boolean includeGlobalWorld, boolean applyGroups, boolean applyGlobalGroups, boolean applyGlobalWorldGroups, boolean op) {
-        return new Contexts(context, includeGlobal, includeGlobalWorld, applyGroups, applyGlobalGroups, applyGlobalWorldGroups, op);
+    /**
+     * 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");
+        EnumSet<LookupSetting> settings = formSettings(
+                includeNodesSetWithoutServer,
+                includeNodesSetWithoutWorld,
+                resolveInheritance,
+                applyParentsWithoutServer,
+                applyParentsWithoutWorld,
+                isOp
+        );
+        if (contextSet.isEmpty() && DEFAULT_SETTINGS.equals(settings)) {
+            return GLOBAL;
+        }
+        return new Contexts(contextSet.makeImmutable(), ImmutableSet.copyOf(settings));
+    }
+
+    private static EnumSet<LookupSetting> asEnumSet(Set<LookupSetting> settings) {
+        if (settings instanceof EnumSet<?>) {
+            return ((EnumSet<LookupSetting>) settings);
+        } else {
+            return EnumSet.copyOf(settings);
+        }
+    }
+
+    /**
+     * 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");
+
+        EnumSet<LookupSetting> settingsCopy = asEnumSet(settings);
+        if (contextSet.isEmpty() && DEFAULT_SETTINGS.equals(settingsCopy)) {
+            return GLOBAL;
+        }
+
+        return new Contexts(contextSet.makeImmutable(), ImmutableSet.copyOf(settingsCopy));
     }
 
     /**
      * The contexts that apply for this lookup
-     * The keys for servers and worlds are defined as static values.
      */
-    private final ContextSet context;
+    private final ImmutableContextSet contextSet;
 
     /**
-     * The mode to parse defaults on Bukkit
+     * The settings for this lookup
+     */
+    private final ImmutableSet<LookupSetting> settings;
+
+    // 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.
      *
-     * @since 2.12
+     * @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)}
      */
-    private final boolean op;
+    @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.settings = ImmutableSet.copyOf(formSettings(
+                includeNodesSetWithoutServer,
+                includeNodesSetWithoutWorld,
+                resolveInheritance,
+                applyParentsWithoutServer,
+                applyParentsWithoutWorld,
+                isOp
+        ));
+        this.hashCode = calculateHashCode();
+    }
 
-    /**
-     * If global or non server specific nodes should be applied
-     */
-    private final boolean includeGlobal;
-
-    /**
-     * If global or non world specific nodes should be applied
-     */
-    private final boolean includeGlobalWorld;
-
-    /**
-     * If parent groups should be applied
-     */
-    private final boolean applyGroups;
-
-    /**
-     * If global or non server specific group memberships should be applied
-     */
-    private final boolean applyGlobalGroups;
-
-    /**
-     * If global or non world specific group memberships should be applied
-     */
-    private final boolean applyGlobalWorldGroups;
-
-    public Contexts(ContextSet context, boolean includeGlobal, boolean includeGlobalWorld, boolean applyGroups, boolean applyGlobalGroups, boolean applyGlobalWorldGroups, boolean op) {
-        if (context == null) {
-            throw new NullPointerException("context");
-        }
-
-        this.context = context.makeImmutable();
-        this.includeGlobal = includeGlobal;
-        this.includeGlobalWorld = includeGlobalWorld;
-        this.applyGroups = applyGroups;
-        this.applyGlobalGroups = applyGlobalGroups;
-        this.applyGlobalWorldGroups = applyGlobalWorldGroups;
-        this.op = op;
+    protected Contexts(@NonNull ImmutableContextSet contextSet, @NonNull ImmutableSet<LookupSetting> settings) {
+        this.contextSet = contextSet;
+        this.settings = settings;
+        this.hashCode = calculateHashCode();
     }
 
     /**
-     * Gets the contexts that apply for this lookup
+     * Gets the {@link ContextSet} which represent these {@link Contexts}.
      *
-     * @return an immutable set of context key value pairs
+     * @return an immutable context from this instance
      * @since 2.13
      */
-    public ContextSet getContexts() {
-        return this.context;
+    public @NonNull ContextSet getContexts() {
+        return this.contextSet;
     }
 
     /**
-     * Gets if OP defaults should be included
+     * Gets the set of {@link LookupSetting}s which represent these {@link Contexts}.
      *
-     * @return true if op defaults should be included
+     * @return the settings
+     * @since 4.2
      */
+    public @NonNull Set<LookupSetting> getSettings() {
+        return this.settings;
+    }
+
+    /**
+     * 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 this.settings.contains(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 this.op;
+        return hasSetting(LookupSetting.IS_OP);
     }
 
     /**
-     * Gets if global or non server specific nodes should be applied
+     * Gets the value of {@link LookupSetting#INCLUDE_NODES_SET_WITHOUT_SERVER}.
      *
-     * @return true if global or non server specific nodes should be applied
+     * @return the value
+     * @see LookupSetting#INCLUDE_NODES_SET_WITHOUT_SERVER
+     * @deprecated in favour of {@link #hasSetting(LookupSetting)}
      */
+    @Deprecated
     public boolean isIncludeGlobal() {
-        return this.includeGlobal;
+        return hasSetting(LookupSetting.INCLUDE_NODES_SET_WITHOUT_SERVER);
     }
 
     /**
-     * Gets if global or non world specific nodes should be applied
+     * Gets the value of {@link LookupSetting#INCLUDE_NODES_SET_WITHOUT_WORLD}.
      *
-     * @return true if global or non world specific nodes should be applied
+     * @return the value
+     * @see LookupSetting#INCLUDE_NODES_SET_WITHOUT_WORLD
+     * @deprecated in favour of {@link #hasSetting(LookupSetting)}
      */
+    @Deprecated
     public boolean isIncludeGlobalWorld() {
-        return this.includeGlobalWorld;
+        return hasSetting(LookupSetting.INCLUDE_NODES_SET_WITHOUT_WORLD);
     }
 
     /**
-     * Gets if parent groups should be applied
+     * Gets the value of {@link LookupSetting#RESOLVE_INHERITANCE}.
      *
-     * @return true if parent groups should be applied
+     * @return the value
+     * @see LookupSetting#RESOLVE_INHERITANCE
+     * @deprecated in favour of {@link #hasSetting(LookupSetting)}
      */
+    @Deprecated
     public boolean isApplyGroups() {
-        return this.applyGroups;
+        return hasSetting(LookupSetting.RESOLVE_INHERITANCE);
     }
 
     /**
-     * Gets if global or non server specific group memberships should be applied
+     * Gets the value of {@link LookupSetting#APPLY_PARENTS_SET_WITHOUT_SERVER}.
      *
-     * @return true if global or non server specific group memberships should be applied
+     * @return the value
+     * @see LookupSetting#APPLY_PARENTS_SET_WITHOUT_SERVER
+     * @deprecated in favour of {@link #hasSetting(LookupSetting)}
      */
+    @Deprecated
     public boolean isApplyGlobalGroups() {
-        return this.applyGlobalGroups;
+        return hasSetting(LookupSetting.APPLY_PARENTS_SET_WITHOUT_SERVER);
     }
 
     /**
-     * Gets if global or non world specific group memberships should be applied
+     * Gets the value of {@link LookupSetting#APPLY_PARENTS_SET_WITHOUT_WORLD}.
      *
-     * @return true if global or non world specific group memberships should be applied
+     * @return the value
+     * @see LookupSetting#APPLY_PARENTS_SET_WITHOUT_WORLD
+     * @deprecated in favour of {@link #hasSetting(LookupSetting)}
      */
+    @Deprecated
     public boolean isApplyGlobalWorldGroups() {
-        return this.applyGlobalWorldGroups;
+        return hasSetting(LookupSetting.APPLY_PARENTS_SET_WITHOUT_WORLD);
     }
 
-    public String toString() {
-        return "Contexts(" +
-                "context=" + this.getContexts() + ", " +
-                "op=" + this.isOp() + ", " +
-                "includeGlobal=" + this.isIncludeGlobal() + ", " +
-                "includeGlobalWorld=" + this.isIncludeGlobalWorld() + ", " +
-                "applyGroups=" + this.isApplyGroups() + ", " +
-                "applyGlobalGroups=" + this.isApplyGlobalGroups() + ", " +
-                "applyGlobalWorldGroups=" + this.isApplyGlobalWorldGroups() +
-                ")";
+    @Override
+    public @NonNull String toString() {
+        return "Contexts(contextSet=" + this.contextSet + ", settings=" + this.settings + ")";
     }
 
-    /*
-     * Ugly auto-generated lombok code
-     */
-
-    /**
-     * Check for equality
-     *
-     * @param o the other
-     * @return true if equal
-     * @since 2.12
-     */
+    @Override
     public boolean equals(Object o) {
         if (o == this) return true;
+        if (o == allowAll()) return false;
         if (!(o instanceof Contexts)) return false;
-        final Contexts other = (Contexts) o;
-        return (this.getContexts() == null ? other.getContexts() == null : this.getContexts().equals(other.getContexts())) &&
-                this.isOp() == other.isOp() &&
-                this.isIncludeGlobal() == other.isIncludeGlobal() &&
-                this.isIncludeGlobalWorld() == other.isIncludeGlobalWorld() &&
-                this.isApplyGroups() == other.isApplyGroups() &&
-                this.isApplyGlobalGroups() == other.isApplyGlobalGroups() &&
-                this.isApplyGlobalWorldGroups() == other.isApplyGlobalWorldGroups();
+        final Contexts that = (Contexts) o;
+        return this.contextSet.equals(that.contextSet) && this.settings.equals(that.settings);
     }
 
-    /**
-     * Gets the hashcode
-     *
-     * @return the hashcode
-     * @since 2.12
-     */
-    public int hashCode() {
+    private int calculateHashCode() {
         final int PRIME = 59;
         int result = 1;
-        final Object contexts = this.getContexts();
-        result = result * PRIME + (contexts == null ? 43 : contexts.hashCode());
-        result = result * PRIME + (this.isOp() ? 79 : 97);
-        result = result * PRIME + (this.isIncludeGlobal() ? 79 : 97);
-        result = result * PRIME + (this.isIncludeGlobalWorld() ? 79 : 97);
-        result = result * PRIME + (this.isApplyGroups() ? 79 : 97);
-        result = result * PRIME + (this.isApplyGlobalGroups() ? 79 : 97);
-        result = result * PRIME + (this.isApplyGlobalWorldGroups() ? 79 : 97);
+        result = result * PRIME + this.contextSet.hashCode();
+        result = result * PRIME + this.settings.hashCode();
         return result;
     }
 
+    @Override
+    public int hashCode() {
+        return this.hashCode;
+    }
+
+    private static EnumSet<LookupSetting> formSettings(boolean includeNodesSetWithoutServer, boolean includeNodesSetWithoutWorld, boolean resolveInheritance, boolean applyParentsWithoutServer, boolean applyParentsWithoutWorld, boolean isOp) {
+        EnumSet<LookupSetting> settings = EnumSet.noneOf(LookupSetting.class);
+        if (includeNodesSetWithoutServer) {
+            settings.add(LookupSetting.INCLUDE_NODES_SET_WITHOUT_SERVER);
+        }
+        if (includeNodesSetWithoutWorld) {
+            settings.add(LookupSetting.INCLUDE_NODES_SET_WITHOUT_WORLD);
+        }
+        if (resolveInheritance) {
+            settings.add(LookupSetting.RESOLVE_INHERITANCE);
+        }
+        if (applyParentsWithoutServer) {
+            settings.add(LookupSetting.APPLY_PARENTS_SET_WITHOUT_SERVER);
+        }
+        if (applyParentsWithoutWorld) {
+            settings.add(LookupSetting.APPLY_PARENTS_SET_WITHOUT_WORLD);
+        }
+        if (isOp) {
+            settings.add(LookupSetting.IS_OP);
+        }
+        return settings;
+    }
+
 }

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

@@ -1,5 +1,8 @@
 /*
- * Copyright (c) 2016 Lucko (Luck) <luck@lucko.me>
+ * 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
@@ -22,44 +25,41 @@
 
 package me.lucko.luckperms.api;
 
-import me.lucko.luckperms.exceptions.ObjectAlreadyHasException;
-import me.lucko.luckperms.exceptions.ObjectLacksException;
+/**
+ * Represents the result of a data mutation call on a LuckPerms object.
+ *
+ * <p>Usually as the result to a call on a {@link PermissionHolder} or {@link Track}.</p>
+ */
+public enum DataMutateResult implements MutateResult {
 
-import java.util.function.Supplier;
+    /**
+     * Indicates the mutation was a success
+     */
+    SUCCESS(true),
 
-public enum DataMutateResult {
+    /**
+     * Indicates the mutation failed because the subject of the action already has something
+     */
+    ALREADY_HAS(false),
 
-    SUCCESS(true, null),
-    ALREADY_HAS(false, ObjectAlreadyHasException::new),
-    LACKS(false, ObjectLacksException::new),
-    FAIL(false, RuntimeException::new);
+    /**
+     * Indicates the mutation failed because the subject of the action lacks something
+     */
+    LACKS(false),
 
-    private boolean value;
-    private final Supplier<? extends Exception> exceptionSupplier;
+    /**
+     * Indicates the mutation failed
+     */
+    FAIL(false);
 
-    DataMutateResult(boolean value, Supplier<? extends Exception> exceptionSupplier) {
-        this.value = value;
-        this.exceptionSupplier = exceptionSupplier;
+    private final boolean success;
+
+    DataMutateResult(boolean success) {
+        this.success = success;
     }
 
-    public void throwException() {
-        if (exceptionSupplier != null) {
-            sneakyThrow(exceptionSupplier.get());
-        }
+    @Override
+    public boolean wasSuccess() {
+        return this.success;
     }
-
-    public boolean asBoolean() {
-        return value;
-    }
-
-    // allows us to throw checked exceptions without declaring it, as #throwException throws a number of
-    // exception types.
-    private static void sneakyThrow(Throwable t) {
-        sneakyThrow0(t);
-    }
-
-    private static <T extends Throwable> void sneakyThrow0(Throwable t) throws T {
-        throw (T) t;
-    }
-
 }

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

@@ -0,0 +1,127 @@
+/*
+ * 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.Optional;
+
+/**
+ * Encapsulates the result of {@link User}s demotion along a {@link Track}.
+ *
+ * @since 4.2
+ */
+public interface DemotionResult extends MutateResult {
+
+    /**
+     * Gets the status of the result.
+     *
+     * @return the status
+     */
+    @NonNull Status getStatus();
+
+    @Override
+    default boolean wasSuccess() {
+        return getStatus().wasSuccess();
+    }
+
+    /**
+     * Gets the name of the group the user was demoted from, if applicable.
+     *
+     * <p>Will only be present for results with a {@link #getStatus() status} of
+     * {@link Status#SUCCESS} or {@link Status#REMOVED_FROM_FIRST_GROUP}.</p>
+     *
+     * <p>The value will also be set for results with the {@link Status#MALFORMED_TRACK} status,
+     * with this value marking the group which no longer exists.</p>
+     *
+     * @return the group the user was demoted from.
+     */
+    @NonNull Optional<String> getGroupFrom();
+
+    /**
+     * Gets the name of the group the user was demoted from, if applicable.
+     *
+     * <p>Will only be present for results with a {@link #getStatus() status} of
+     * {@link Status#SUCCESS}.</p>
+     *
+     * @return the group the user was demoted to.
+     */
+    @NonNull Optional<String> getGroupTo();
+
+    /**
+     * The result status
+     */
+    enum Status implements MutateResult {
+
+        /**
+         * Indicates that the user was demoted normally.
+         */
+        SUCCESS(true),
+
+        /**
+         * Indicates that the user was removed from the first group in the track.
+         *
+         * <p>This usually occurs when the user is currently on the first group, and was demoted
+         * "over the start" of the track.</p>
+         */
+        REMOVED_FROM_FIRST_GROUP(true),
+
+        /**
+         * Indicates that the previous group in the track no longer exists.
+         */
+        MALFORMED_TRACK(false),
+
+        /**
+         * Indicates that the user isn't a member of any of the groups on this track.
+         */
+        NOT_ON_TRACK(false),
+
+        /**
+         * Indicates that the implementation was unable to determine the users current position on
+         * this track.
+         *
+         * <p>This usually occurs when the user is on more than one group on the track.</p>
+         */
+        AMBIGUOUS_CALL(false),
+
+        /**
+         * An undefined failure occurred.
+         */
+        UNDEFINED_FAILURE(false);
+
+        private final boolean success;
+
+        Status(boolean success) {
+            this.success = success;
+        }
+
+        @Override
+        public boolean wasSuccess() {
+            return this.success;
+        }
+    }
+
+}

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

@@ -0,0 +1,84 @@
+/*
+ * 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.UUID;
+
+/**
+ * Represents an entity on the server.
+ *
+ * <p>This does not relate directly to a "Minecraft Entity". The closest
+ * comparison is to a "CommandSender" or "CommandSource" in Bukkit/Sponge.</p>
+ *
+ * <p>The various types of {@link Entity} are detailed in {@link Type}.</p>
+ *
+ * @since 4.1
+ */
+public interface Entity {
+
+    /**
+     * Gets the unique id of the entity, if it has one.
+     *
+     * <p>For players, this returns their uuid assigned by the server.</p>
+     *
+     * @return the uuid of the object, if available
+     */
+    @Nullable UUID getUniqueId();
+
+    /**
+     * Gets the name of the object
+     *
+     * @return the object name
+     */
+    @NonNull String getName();
+
+    /**
+     * Gets the entities type.
+     *
+     * @return the type
+     */
+    @NonNull Type getType();
+
+    /**
+     * The different types of {@link Entity}
+     */
+    enum Type {
+
+        /**
+         * Represents a player connected to the server
+         */
+        PLAYER,
+
+        /**
+         * Represents the server console
+         */
+        CONSOLE
+    }
+
+}

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

@@ -0,0 +1,81 @@
+/*
+ * 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.ImmutableSet;
+
+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(), ImmutableSet.copyOf(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/Group.java

@@ -1,5 +1,8 @@
 /*
- * Copyright (c) 2016 Lucko (Luck) <luck@lucko.me>
+ * 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
@@ -22,14 +25,16 @@
 
 package me.lucko.luckperms.api;
 
-import me.lucko.luckperms.exceptions.ObjectAlreadyHasException;
-import me.lucko.luckperms.exceptions.ObjectLacksException;
+import me.lucko.luckperms.api.caching.GroupData;
+import me.lucko.luckperms.api.context.ContextSet;
+
+import org.checkerframework.checker.nullness.qual.NonNull;
+import org.checkerframework.checker.nullness.qual.Nullable;
 
-import java.util.List;
 import java.util.OptionalInt;
 
 /**
- * A group which holds permission data.
+ * An inheritable holder of permission data.
  */
 public interface Group extends PermissionHolder {
 
@@ -38,249 +43,48 @@ public interface Group extends PermissionHolder {
      *
      * @return the name of the group
      */
-    String getName();
+    @NonNull String getName();
 
     /**
-     * Check to see if a group inherits a group
+     * Gets the groups "display name", if it has one that differs from it's actual name.
      *
-     * @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.
-     */
-    boolean inheritsGroup(Group group);
-
-    /**
-     * Check to see if the group inherits a group on a specific server
+     * <p>The lookup is made using the current servers active context.</p>
      *
-     * @param group  The group to check membership of
-     * @param server The server to check on
-     * @return true if the group inherits the group on the server
-     * @throws NullPointerException     if the group or server is null
-     * @throws IllegalStateException    if the group instance was not obtained from LuckPerms.
-     * @throws IllegalArgumentException if the server is invalid
-     */
-    boolean inheritsGroup(Group group, String server);
-
-    /**
-     * Check to see if the group inherits a group on a specific server and world
+     * <p>Will return <code>null</code> if the groups display name is equal to it's
+     * {@link #getName() actual name}.</p>
      *
-     * @param group  The group to check membership of
-     * @param server The server to check on
-     * @param world  The world to check on
-     * @return true if the group inherits the group on the server and world
-     * @throws NullPointerException     if the group, server or world is null
-     * @throws IllegalStateException    if the group instance was not obtained from LuckPerms.
-     * @throws IllegalArgumentException if the server or world is invalid
+     * @return the display name
+     * @since 4.3
      */
-    boolean inheritsGroup(Group group, String server, String world);
+    @Nullable String getDisplayName();
 
     /**
-     * Make this group inherit another group
+     * Gets the groups "display name", if it has one that differs from it's actual name.
      *
-     * @param group the group to be inherited
-     * @throws ObjectAlreadyHasException if the group already inherits the group
-     * @throws NullPointerException      if the group is null
-     * @throws IllegalStateException     if the group instance was not obtained from LuckPerms.
-     * @deprecated in favour of {@link NodeFactory#makeGroupNode(Group)}
-     */
-    @Deprecated
-    void setInheritGroup(Group group) throws ObjectAlreadyHasException;
-
-    /**
-     * Make this group inherit another group on a specific server
+     * <p>Will return <code>null</code> if the groups display name is equal to it's
+     * {@link #getName() actual name}.</p>
      *
-     * @param group  the group to be inherited
-     * @param server The server to inherit the group on
-     * @throws ObjectAlreadyHasException if the group already inherits the group on that server
-     * @throws NullPointerException      if the group or server is null
-     * @throws IllegalStateException     if the group instance was not obtained from LuckPerms.
-     * @throws IllegalArgumentException  if the server is invalid
-     * @deprecated in favour of {@link NodeFactory#makeGroupNode(Group)}
+     * @param contextSet the contexts to lookup in
+     * @return the display name
+     * @since 4.3
      */
-    @Deprecated
-    void setInheritGroup(Group group, String server) throws ObjectAlreadyHasException;
+    @Nullable String getDisplayName(@NonNull ContextSet contextSet);
 
     /**
-     * Make this group inherit another group on a specific server and world
-     *
-     * @param group  the group to be inherited
-     * @param server The server to inherit the group on
-     * @param world  The world to inherit the group on
-     * @throws ObjectAlreadyHasException if the group already inherits the group on that server and world
-     * @throws NullPointerException      if the group, server or world is null
-     * @throws IllegalStateException     if the group instance was not obtained from LuckPerms.
-     * @throws IllegalArgumentException  if the server or world is invalid
-     * @deprecated in favour of {@link NodeFactory#makeGroupNode(Group)}
-     */
-    @Deprecated
-    void setInheritGroup(Group group, String server, String world) throws ObjectAlreadyHasException;
-
-    /**
-     * Make this group inherit another group temporarily
-     *
-     * @param group    the group to be inherited
-     * @param expireAt the unix time when the group should expire
-     * @throws ObjectAlreadyHasException if the group already inherits the group temporarily
-     * @throws NullPointerException      if the group is null
-     * @throws IllegalStateException     if the group instance was not obtained from LuckPerms.
-     * @throws IllegalArgumentException  if the expiry time is in the past
-     * @deprecated in favour of {@link NodeFactory#makeGroupNode(Group)}
-     */
-    @Deprecated
-    void setInheritGroup(Group group, long expireAt) throws ObjectAlreadyHasException;
-
-    /**
-     * Make this group inherit another group on a specific server temporarily
-     *
-     * @param group    the group to be inherited
-     * @param server   The server inherit add the group on
-     * @param expireAt when the group should expire
-     * @throws ObjectAlreadyHasException if the group already inherits the group on that server temporarily
-     * @throws NullPointerException      if the group or server is null
-     * @throws IllegalStateException     if the group instance was not obtained from LuckPerms.
-     * @throws IllegalArgumentException  if the expiry time is in the past or the server is invalid
-     * @deprecated in favour of {@link NodeFactory#makeGroupNode(Group)}
-     */
-    @Deprecated
-    void setInheritGroup(Group group, String server, long expireAt) throws ObjectAlreadyHasException;
-
-    /**
-     * Make this group inherit another group on a specific server and world temporarily
-     *
-     * @param group    the group to be inherited
-     * @param server   The server to inherit the group on
-     * @param world    The world to inherit the group on
-     * @param expireAt when the group should expire
-     * @throws ObjectAlreadyHasException if the group already inherits the group on that server and world temporarily
-     * @throws NullPointerException      if the group, server or world is null
-     * @throws IllegalStateException     if the group instance was not obtained from LuckPerms.
-     * @throws IllegalArgumentException  if the expiry time is in the past or the server/world is invalid
-     * @deprecated in favour of {@link NodeFactory#makeGroupNode(Group)}
-     */
-    @Deprecated
-    void setInheritGroup(Group group, String server, String world, long expireAt) throws ObjectAlreadyHasException;
-
-    /**
-     * Remove a previously set inheritance rule
-     *
-     * @param group the group to uninherit
-     * @throws ObjectLacksException  if the group does not already inherit the group
-     * @throws NullPointerException  if the group is null
-     * @throws IllegalStateException if the group instance was not obtained from LuckPerms.
-     * @deprecated in favour of {@link NodeFactory#makeGroupNode(Group)}
-     */
-    @Deprecated
-    void unsetInheritGroup(Group group) throws ObjectLacksException;
-
-    /**
-     * Remove a previously set inheritance rule
-     *
-     * @param group     the group to uninherit
-     * @param temporary if the group being removed is temporary
-     * @throws ObjectLacksException  if the group does not already inherit the group
-     * @throws NullPointerException  if the group is null
-     * @throws IllegalStateException if the group instance was not obtained from LuckPerms.
-     * @deprecated in favour of {@link NodeFactory#makeGroupNode(Group)}
-     */
-    @Deprecated
-    void unsetInheritGroup(Group group, boolean temporary) throws ObjectLacksException;
-
-    /**
-     * Remove a previously set inheritance rule on a specific server
-     *
-     * @param group  the group to uninherit
-     * @param server The server to remove the group on
-     * @throws ObjectLacksException     if the group does not already inherit the group on that server
-     * @throws NullPointerException     if the group or server is null
-     * @throws IllegalStateException    if the group instance was not obtained from LuckPerms.
-     * @throws IllegalArgumentException if the server is invalid
-     * @deprecated in favour of {@link NodeFactory#makeGroupNode(Group)}
-     */
-    @Deprecated
-    void unsetInheritGroup(Group group, String server) throws ObjectLacksException;
-
-    /**
-     * Remove a previously set inheritance rule on a specific server and world
-     *
-     * @param group  the group to uninherit
-     * @param server The server to remove the group on
-     * @param world  The world to remove the group on
-     * @throws ObjectLacksException     if the group does not already inherit the group
-     * @throws NullPointerException     if the group, server or world is null
-     * @throws IllegalStateException    if the group instance was not obtained from LuckPerms.
-     * @throws IllegalArgumentException if the server or world is invalid
-     * @deprecated in favour of {@link NodeFactory#makeGroupNode(Group)}
-     */
-    @Deprecated
-    void unsetInheritGroup(Group group, String server, String world) throws ObjectLacksException;
-
-    /**
-     * Remove a previously set inheritance rule on a specific server
-     *
-     * @param group     the group to uninherit
-     * @param server    The server to remove the group on
-     * @param temporary if the group being removed is temporary
-     * @throws ObjectLacksException     if the group does not already inherit the group
-     * @throws NullPointerException     if the group or server is null
-     * @throws IllegalStateException    if the group instance was not obtained from LuckPerms.
-     * @throws IllegalArgumentException if the expiry time is in the past or the server is invalid
-     * @deprecated in favour of {@link NodeFactory#makeGroupNode(Group)}
-     */
-    @Deprecated
-    void unsetInheritGroup(Group group, String server, boolean temporary) throws ObjectLacksException;
-
-    /**
-     * Remove a previously set inheritance rule on a specific server and world
-     *
-     * @param group     the group to uninherit
-     * @param server    The server to remove the group on
-     * @param world     The world to remove the group on
-     * @param temporary if the group being removed was set temporarily
-     * @throws ObjectLacksException     if the group does not already inherit the group
-     * @throws NullPointerException     if the group, server or world is null
-     * @throws IllegalStateException    if the group instance was not obtained from LuckPerms.
-     * @throws IllegalArgumentException if the expiry time is in the past or the server/world is invalid
-     * @deprecated in favour of {@link NodeFactory#makeGroupNode(Group)}
-     */
-    @Deprecated
-    void unsetInheritGroup(Group group, String server, String world, boolean temporary) throws ObjectLacksException;
-
-    /**
-     * Get a {@link List} of all of the groups the group inherits, on all servers
-     *
-     * @return a {@link List} of group names
-     */
-    List<String> getGroupNames();
-
-    /**
-     * Get a {@link List} of the groups the group inherits on a specific server
-     *
-     * @param server the server to check
-     * @return a {@link List} of group names
-     * @throws NullPointerException     if the server is null
-     * @throws IllegalArgumentException if the server is invalid
-     */
-    List<String> getLocalGroups(String server);
-
-
-    /**
-     * Get a {@link List} of the groups the group inherits on a specific server and world
-     *
-     * @param server the server to check
-     * @param world  the world to check
-     * @return a {@link List} of group names
-     * @throws NullPointerException     if the server or world is null
-     * @throws IllegalArgumentException if the server or world is invalid
-     */
-    List<String> getLocalGroups(String server, String world);
-
-    /**
-     * Gets the weight of this group, is present.
+     * Gets the weight of this group, if present.
      *
      * @return the group weight
      * @since 2.17
      */
-    OptionalInt getWeight();
+    @NonNull OptionalInt getWeight();
+
+    /**
+     * Gets the groups's {@link GroupData} cache.
+     *
+     * @return the groups cached data.
+     * @since 4.0
+     */
+    @Override
+    @NonNull GroupData getCachedData();
 
 }

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

@@ -1,5 +1,8 @@
 /*
- * Copyright (c) 2016 Lucko (Luck) <luck@lucko.me>
+ * 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
@@ -22,13 +25,15 @@
 
 package me.lucko.luckperms.api;
 
-import com.google.common.collect.Multimap;
+import me.lucko.luckperms.api.context.ContextSet;
+
+import org.checkerframework.checker.nullness.qual.NonNull;
 
 import java.util.Optional;
 import java.util.OptionalLong;
 
 /**
- * A relationship between a Holder and a permission
+ * A relationship between a {@link PermissionHolder} and a permission.
  *
  * @param <T> the identifier type of the holder
  * @since 2.17
@@ -40,14 +45,14 @@ public interface HeldPermission<T> {
      *
      * @return the holder
      */
-    T getHolder();
+    @NonNull T getHolder();
 
     /**
      * Gets the permission being held
      *
      * @return the permission
      */
-    String getPermission();
+    @NonNull String getPermission();
 
     /**
      * Gets the value of the permission
@@ -61,14 +66,14 @@ public interface HeldPermission<T> {
      *
      * @return the server
      */
-    Optional<String> getServer();
+    @NonNull Optional<String> getServer();
 
     /**
      * Gets the world where the permission is held
      *
      * @return the world
      */
-    Optional<String> getWorld();
+    @NonNull Optional<String> getWorld();
 
     /**
      * Gets the time in unix time when the permission will expire
@@ -78,17 +83,17 @@ public interface HeldPermission<T> {
     OptionalLong getExpiry();
 
     /**
-     * Gets the context for the permission.
+     * Gets the extra context for the permission.
      *
-     * @return the context
+     * @return the extra context
      */
-    Multimap<String, String> getContext();
+    ContextSet getContexts();
 
     /**
      * Converts this permission into a Node
      *
      * @return a Node copy of this permission
      */
-    Node asNode();
+    @NonNull Node asNode();
 
 }

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

@@ -1,5 +1,8 @@
 /*
- * Copyright (c) 2016 Lucko (Luck) <luck@lucko.me>
+ * 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
@@ -22,145 +25,93 @@
 
 package me.lucko.luckperms.api;
 
-import me.lucko.luckperms.api.data.DatastoreConfiguration;
+import org.checkerframework.checker.nullness.qual.NonNull;
 
 import java.util.Map;
 
 /**
- * Read-only access to the LuckPerms configuration settings
+ * Wrapper around parts of the LuckPerms configuration file
  */
 public interface LPConfiguration {
 
     /**
-     * Returns the name of this server
+     * Gets the name of this server
+     *
      * @return the name of this server
      */
-    String getServer();
+    @NonNull String getServer();
 
     /**
-     * Returns how often a sync task will run in minutes
-     * @return how often a sync task will run in minutes
-     */
-    int getSyncTime();
-
-    /**
-     * Returns if the users on this server will have their global permissions applied
+     * 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();
 
     /**
-     * Returns if the users on this server will have their global world permissions applied
+     * 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();
 
     /**
-     * Returns true if the platform is applying global groups
+     * Gets if the platform is applying global groups
+     *
      * @return true if the platform is applying global groups
      * @since 2.9
      */
     boolean getApplyGlobalGroups();
 
     /**
-     * Returns true if the platform is applying global world groups
+     * Gets if the platform is applying global world groups
+     *
      * @return true if the platform is applying global world groups
      * @since 2.9
      */
     boolean getApplyGlobalWorldGroups();
 
     /**
-     * Returns the online mode setting
-     * @return the online mode setting
-     */
-    boolean getOnlineMode();
-
-    /**
-     * Returns if LuckPerms is applying wildcard permissions
-     * @return if LuckPerms is applying wildcard permissions
-     */
-    boolean getApplyWildcards();
-
-    /**
-     * Returns if LuckPerms is resolving and applying regex permissions
-     * @return if LuckPerms is resolving and applying regex permissions
-     */
-    boolean getApplyRegex();
-
-    /**
-     * Returns if LuckPerms is expanding shorthand permissions
-     * @return if LuckPerms is expanding shorthand permissions
-     */
-    boolean getApplyShorthand();
-
-    /**
-     * Returns if LuckPerms will send notifications to users when permissions are modified
-     * @return if LuckPerms will send notifications to users when permissions are modified
-     * @since 2.7
-     */
-    boolean getLogNotify();
-
-    /**
-     * Returns true if the vanilla op system is enabled
-     * @return true if the vanilla op system is enabled
-     * @since 2.8
-     */
-    boolean getEnableOps();
-
-    /**
-     * Returns true if opped players are allowed to use LuckPerms commands
-     * @return true if opped players are allowed to use LuckPerms commands
-     * @since 2.8
-     */
-    boolean getCommandsAllowOp();
-
-    /**
-     * Returns true if auto op is enabled
-     * @return true if auto op is enabled
-     * @since 2.9
-     */
-    boolean getAutoOp();
-
-    /**
-     * Returns the name of the server used within Vault operations
-     * @return the name of the server used within Vault operations
-     * @since 2.7
-     */
-    String getVaultServer();
-
-    /**
-     * Returns true if global permissions should be considered when retrieving meta or player groups
-     * @return true if global permissions should be considered when retrieving meta or player groups
-     * @since 2.7
-     */
-    boolean getVaultIncludeGlobal();
-
-    /**
-     * Returns the values set for data storage in the configuration
-     * @return the values set for data storage in the configuration
-     */
-    DatastoreConfiguration getDatastoreConfig();
-
-    /**
-     * Returns the storage method string from the configuration
+     * Gets the storage method string from the configuration
+     *
      * @return the storage method string from the configuration
      */
-    String getStorageMethod();
+    @NonNull String getStorageMethod();
 
     /**
-     * Returns true if split storage is enabled
+     * Gets true if split storage is enabled
+     *
      * @return true if split storage is enabled
      * @since 2.7
      */
     boolean getSplitStorage();
 
     /**
-     * Returns a map of split storage options
+     * 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
      */
-    Map<String, String> getSplitStorageOptions();
+    @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/LocalizedNode.java

@@ -1,5 +1,8 @@
 /*
- * Copyright (c) 2016 Lucko (Luck) <luck@lucko.me>
+ * 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
@@ -22,26 +25,36 @@
 
 package me.lucko.luckperms.api;
 
+import org.checkerframework.checker.nullness.qual.NonNull;
+
 /**
- * A node with a traceable origin
+ * An extension of {@link Node}, providing information about
+ * where the node originated from.
  *
  * @since 2.11
  */
 public interface LocalizedNode extends Node {
 
     /**
-     * Gets the delegate node
+     * Gets the delegate node.
+     *
+     * <p>Result is never another {@link LocalizedNode} instance.</p>
      *
      * @return the node this instance is representing
      */
-    Node getNode();
+    @NonNull Node getNode();
 
     /**
-     * Gets the location where the {@link Node} is inherited from
+     * Gets the location where the {@link Node} is inherited from.
      *
-     * @return where the node was inherited from. Will not return null.
-     * @see PermissionHolder#getObjectName()
+     * <p>The resultant string is the {@link PermissionHolder#getObjectName() object name} of the
+     * permission holder the node was inherited from.</p>
+     *
+     * <p>If the node was not inherited, the {@link PermissionHolder#getObjectName() object name}
+     * of the permission holder itself (the one that defined the node) will be returned.</p>
+     *
+     * @return where the node was inherited from.
      */
-    String getLocation();
+    @NonNull String getLocation();
 
 }

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

@@ -1,5 +1,8 @@
 /*
- * Copyright (c) 2016 Lucko (Luck) <luck@lucko.me>
+ * 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
@@ -22,160 +25,60 @@
 
 package me.lucko.luckperms.api;
 
-import java.util.SortedMap;
+import org.checkerframework.checker.nullness.qual.NonNull;
+
 import java.util.SortedSet;
 import java.util.UUID;
 
 /**
  * Represents the internal LuckPerms log.
  *
- * <p>The returned instance provides a copy of the data at the time of retrieval. 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>
+ * <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>
+ *
+ * <p>All methods are thread safe, and return immutable and thread safe collections.</p>
  */
 public interface Log {
 
     /**
-     * @return a {@link SortedSet} of all of the {@link LogEntry} objects in this {@link Log}
-     */
-    SortedSet<LogEntry> getContent();
-
-    /**
-     * @return all content in this log
-     */
-    SortedSet<LogEntry> getRecent();
-
-    /**
-     * Gets the recent content separated by page
+     * Gets the {@link LogEntry}s that make up this log.
      *
-     * @param pageNo the page number
-     * @return the page content
-     * @throws IllegalArgumentException if the pageNo is less than 1
-     * @throws IllegalStateException if the log doesn't contain enough entries to populate the page. See {@link #getRecentMaxPages()}}
+     * @return the content
      */
-    SortedMap<Integer, LogEntry> getRecent(int pageNo);
-
-    /**
-     * @return the max page number allowed in the {@link #getRecent(int)} method
-     */
-    int getRecentMaxPages();
-
+    @NonNull SortedSet<LogEntry> getContent();
 
     /**
+     * Gets the entries in the log performed by the given actor.
+     *
      * @param actor the uuid of the actor to filter by
-     * @return all content in this log where is actor = uuid
+     * @return the content for the given actor
      */
-    SortedSet<LogEntry> getRecent(UUID actor);
+    @NonNull SortedSet<LogEntry> getContent(@NonNull UUID actor);
 
     /**
-     * Gets the recent content for the uuid, separated into pages
+     * Gets the log content for a given user
      *
-     * @param pageNo the page number
-     * @param actor  the uuid of the actor to filter by
-     * @return the page content
-     * @throws IllegalArgumentException if the pageNo is less than 1
-     * @throws IllegalStateException if the log doesn't contain enough entries to populate the page. See {@link #getRecentMaxPages(UUID)}}
-     */
-    SortedMap<Integer, LogEntry> getRecent(int pageNo, UUID actor);
-
-    /**
-     * @param actor the actor to filter by
-     * @return the max page number allowed in the {@link #getRecent(int, UUID)} method
-     */
-    int getRecentMaxPages(UUID actor);
-
-
-    /**
      * @param uuid the uuid to filter by
      * @return all content in this log where the user = uuid
      */
-    SortedSet<LogEntry> getUserHistory(UUID uuid);
+    @NonNull SortedSet<LogEntry> getUserHistory(@NonNull UUID uuid);
 
     /**
-     * Gets the user history content, separated by pages
+     * Gets the log content for a given group
      *
-     * @param pageNo the page number
-     * @param uuid   the uuid of the acted user to filter by
-     * @return the page content
-     * @throws IllegalArgumentException if the pageNo is less than 1
-     * @throws IllegalStateException if the log doesn't contain enough entries to populate the page. See {@link #getUserHistoryMaxPages(UUID)}}
-     */
-    SortedMap<Integer, LogEntry> getUserHistory(int pageNo, UUID uuid);
-
-    /**
-     * @param uuid the uuid to filter by
-     * @return the max page number allowed in the {@link #getUserHistory(int, UUID)} method
-     */
-    int getUserHistoryMaxPages(UUID uuid);
-
-
-    /**
      * @param name the name to filter by
      * @return all content in this log where the group = name
      */
-    SortedSet<LogEntry> getGroupHistory(String name);
+    @NonNull SortedSet<LogEntry> getGroupHistory(@NonNull String name);
 
     /**
-     * Gets the group history content, separated by pages
+     * Gets the log content for a given track
      *
-     * @param pageNo the page number
-     * @param name   the name of the acted group to filter by
-     * @return the page content
-     * @throws IllegalArgumentException if the pageNo is less than 1
-     * @throws IllegalStateException if the log doesn't contain enough entries to populate the page. See {@link #getGroupHistoryMaxPages(String)}}
-     */
-    SortedMap<Integer, LogEntry> getGroupHistory(int pageNo, String name);
-
-    /**
-     * @param name the name to filter by
-     * @return the max page number allowed in the {@link #getGroupHistory(int, String)} method
-     */
-    int getGroupHistoryMaxPages(String name);
-
-
-    /**
      * @param name the name to filter by
      * @return all content in this log where the track = name
      */
-    SortedSet<LogEntry> getTrackHistory(String name);
+    @NonNull SortedSet<LogEntry> getTrackHistory(@NonNull String name);
 
-    /**
-     * Gets the track history content, separated by pages
-     *
-     * @param pageNo the page number
-     * @param name   the name of the acted track to filter by
-     * @return the page content
-     */
-    SortedMap<Integer, LogEntry> getTrackHistory(int pageNo, String name);
-
-    /**
-     * @param name the name to filter by
-     * @return the max page number allowed in the {@link #getTrackHistory(int, String)} method
-     * @throws IllegalArgumentException if the pageNo is less than 1
-     * @throws IllegalStateException if the log doesn't contain enough entries to populate the page. See {@link #getTrackHistoryMaxPages(String)}}
-     */
-    int getTrackHistoryMaxPages(String name);
-
-
-    /**
-     * @param query the query to filter by
-     * @return all content in this log where the content matches query
-     */
-    SortedSet<LogEntry> getSearch(String query);
-
-    /**
-     * Gets the search content, separated by pages
-     *
-     * @param pageNo the page number
-     * @param query  the query to filter by
-     * @return the page content
-     * @throws IllegalArgumentException if the pageNo is less than 1
-     * @throws IllegalStateException if the log doesn't contain enough entries to populate the page. See {@link #getSearchMaxPages(String)}}
-     */
-    SortedMap<Integer, LogEntry> getSearch(int pageNo, String query);
-
-    /**
-     * @param query the query to filter by
-     * @return the max page number allowed in the {@link #getSearch(int, String)} method
-     */
-    int getSearchMaxPages(String query);
 }

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

@@ -1,5 +1,8 @@
 /*
- * Copyright (c) 2016 Lucko (Luck) <luck@lucko.me>
+ * 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
@@ -22,297 +25,185 @@
 
 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;
 
 /**
- * A single entry in the log
+ * Represents a logged action.
  *
- * <p>Implements {@link Comparable} ordering based upon the timestamp of the entry.</p>
+ * @see ActionLogger#newEntryBuilder() for creating an instance
  */
-public class LogEntry implements Comparable<LogEntry> {
-    private static final String FORMAT = "&8(&e%s&8) [&a%s&8] (&b%s&8) &7--> &f%s";
+public interface LogEntry extends Comparable<LogEntry> {
 
-    public static LogEntryBuilder builder() {
-        return new LogEntryBuilder();
-    }
+    /**
+     * Gets the time in unix seconds when the action occurred.
+     *
+     * @return the timestamp
+     */
+    long getTimestamp();
 
-    private long timestamp;
-    private UUID actor;
-    private String actorName;
-    private char type;
-    private UUID acted;
-    private String actedName;
-    private String action;
+    /**
+     * 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();
 
-    public LogEntry(long timestamp, UUID actor, String actorName, char type, UUID acted, String actedName, String action) {
-        if (actor == null) {
-            throw new NullPointerException("actor");
-        }
-        if (actorName == null) {
-            throw new NullPointerException("actorName");
-        }
-        if (actedName == null) {
-            throw new NullPointerException("actedName");
-        }
-        if (action == null) {
-            throw new NullPointerException("action");
-        }
+    /**
+     * Gets the name describing the actor.
+     *
+     * @return the name of the actor
+     */
+    @NonNull String getActorName();
 
-        this.timestamp = timestamp;
-        this.actor = actor;
-        this.actorName = actorName;
-        this.type = type;
-        this.acted = acted;
-        this.actedName = actedName;
-        this.action = action;
-    }
+    /**
+     * Gets the type of action.
+     *
+     * @return the action type
+     */
+    @NonNull Type getType();
 
-    protected LogEntry() {
-        this.timestamp = 0L;
-        this.actor = null;
-        this.actorName = null;
-        this.type = Character.MIN_VALUE;
-        this.acted = null;
-        this.actedName = null;
-        this.action = null;
-    }
+    /**
+     * 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();
 
-    @Override
-    public int compareTo(LogEntry o) {
-        return equals(o) ? 0 : (Long.compare(timestamp, o.getTimestamp()) == 0 ? 1 : Long.compare(timestamp, o.getTimestamp()));
-    }
+    /**
+     * Gets the name describing the object which was acted upon
+     *
+     * @return the name of the acted object
+     */
+    @NonNull String getActedName();
 
-    public boolean matchesSearch(String query) {
-        query = query.toLowerCase();
-        return actorName.toLowerCase().contains(query) || actedName.toLowerCase().contains(query)
-                || action.toLowerCase().contains(query);
-    }
+    /**
+     * 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();
 
-    public String getFormatted() {
-        return String.format(FORMAT,
-                String.valueOf(actorName).equals("null") ? actor.toString() : actorName,
-                Character.toString(type),
-                actedName,
-                action
-        );
-    }
+    /**
+     * Represents the type of a {@link LogEntry}.
+     *
+     * @since 3.3
+     */
+    enum Type {
+        USER('U'), GROUP('G'), TRACK('T');
 
-    public long getTimestamp() {
-        return timestamp;
-    }
-
-    void setTimestamp(long timestamp) {
-        this.timestamp = timestamp;
-    }
-
-    public UUID getActor() {
-        return actor;
-    }
-
-    void setActor(UUID actor) {
-        this.actor = actor;
-    }
-
-    public String getActorName() {
-        return actorName;
-    }
-
-    void setActorName(String actorName) {
-        this.actorName = actorName;
-    }
-
-    public char getType() {
-        return type;
-    }
-
-    void setType(char type) {
-        this.type = type;
-    }
-
-    public UUID getActed() {
-        return acted;
-    }
-
-    void setActed(UUID acted) {
-        this.acted = acted;
-    }
-
-    public String getActedName() {
-        return actedName;
-    }
-
-    void setActedName(String actedName) {
-        this.actedName = actedName;
-    }
-
-    public String getAction() {
-        return action;
-    }
-
-    void setAction(String action) {
-        this.action = action;
-    }
-
-    @Override
-    public String toString() {
-        return "LogEntry(" +
-                "timestamp=" + this.getTimestamp() + ", " +
-                "actor=" + this.getActor() + ", " +
-                "actorName=" + this.getActorName() + ", " +
-                "type=" + this.getType() + ", " +
-                "acted=" + this.getActed() + ", " +
-                "actedName=" + this.getActedName() + ", " +
-                "action=" + this.getAction() +
-                ")";
-    }
-
-    @Override
-    public boolean equals(Object o) {
-        if (o == this) return true;
-        if (!(o instanceof LogEntry)) return false;
-        final LogEntry other = (LogEntry) o;
-        return this.getTimestamp() == other.getTimestamp() &&
-                (this.getActor() == null ? other.getActor() == null : this.getActor().equals(other.getActor())) &&
-                (this.getActorName() == null ? other.getActorName() == null : this.getActorName().equals(other.getActorName())) &&
-                this.getType() == other.getType() &&
-                (this.getActed() == null ? other.getActed() == null : this.getActed().equals(other.getActed())) &&
-                (this.getActedName() == null ? other.getActedName() == null : this.getActedName().equals(other.getActedName())) &&
-                (this.getAction() == null ? other.getAction() == null : this.getAction().equals(other.getAction()));
-    }
-
-    @Override
-    public int hashCode() {
-        final int PRIME = 59;
-        int result = 1;
-        result = result * PRIME + (int) (this.getTimestamp() >>> 32 ^ this.getTimestamp());
-        result = result * PRIME + (this.getActor() == null ? 43 : this.getActor().hashCode());
-        result = result * PRIME + (this.getActorName() == null ? 43 : this.getActorName().hashCode());
-        result = result * PRIME + this.getType();
-        result = result * PRIME + (this.getActed() == null ? 43 : this.getActed().hashCode());
-        result = result * PRIME + (this.getActedName() == null ? 43 : this.getActedName().hashCode());
-        result = result * PRIME + (this.getAction() == null ? 43 : this.getAction().hashCode());
-        return result;
-    }
-
-    public static class LogEntryBuilder extends AbstractLogEntryBuilder<LogEntry, LogEntry.LogEntryBuilder> {
-
-        @Override
-        protected LogEntry createObj() {
-            return new LogEntry();
-        }
-
-        @Override
-        protected LogEntryBuilder getThis() {
-            return this;
-        }
-
-    }
-
-    public static abstract class AbstractLogEntryBuilder<T extends LogEntry, B extends AbstractLogEntryBuilder<T, B>> {
-        private T obj;
-        private B thisObj;
-
-        public AbstractLogEntryBuilder() {
-            obj = createObj();
-            thisObj = getThis();
-        }
-
-        protected abstract T createObj();
-
-        protected abstract B getThis();
-
-        public long getTimestamp() {
-            return obj.getTimestamp();
-        }
-
-        public UUID getActor() {
-            return obj.getActor();
-        }
-
-        public String getActorName() {
-            return obj.getActorName();
-        }
-
-        public char getType() {
-            return obj.getType();
-        }
-
-        public UUID getActed() {
-            return obj.getActed();
-        }
-
-        public String getActedName() {
-            return obj.getActedName();
-        }
-
-        public String getAction() {
-            return obj.getAction();
-        }
-
-        public B timestamp(long timestamp) {
-            obj.setTimestamp(timestamp);
-            return thisObj;
-        }
-
-        public B actor(UUID actor) {
-            obj.setActor(actor);
-            return thisObj;
-        }
-
-        public B actorName(String actorName) {
-            obj.setActorName(actorName);
-            return thisObj;
-        }
-
-        public B type(char type) {
-            obj.setType(type);
-            return thisObj;
-        }
-
-        public B acted(UUID acted) {
-            obj.setActed(acted);
-            return thisObj;
-        }
-
-        public B actedName(String actedName) {
-            obj.setActedName(actedName);
-            return thisObj;
-        }
-
-        public B action(String action) {
-            obj.setAction(action);
-            return thisObj;
-        }
-
-        public T build() {
-            if (getActor() == null) {
-                throw new NullPointerException("actor");
+        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);
             }
-            if (getActorName() == null) {
-                throw new NullPointerException("actorName");
-            }
-            if (getActedName() == null) {
-                throw new NullPointerException("actedName");
-            }
-            if (getAction() == null) {
-                throw new NullPointerException("action");
-            }
-
-            return obj;
         }
 
-        @Override
-        public String toString() {
-            return "LogEntry.LogEntryBuilder(" +
-                    "timestamp=" + this.getTimestamp() + ", " +
-                    "actor=" + this.getActor() + ", " +
-                    "actorName=" + this.getActorName() + ", " +
-                    "type=" + this.getType() + ", " +
-                    "acted=" + this.getActed() + ", " +
-                    "actedName=" + this.getActedName() + ", " +
-                    "action=" + this.getAction() +
-                    ")";
+        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

@@ -0,0 +1,64 @@
+/*
+ * 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;
+
+/**
+ * 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
+}

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

@@ -1,5 +1,8 @@
 /*
- * Copyright (c) 2016 Lucko (Luck) <luck@lucko.me>
+ * 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
@@ -22,86 +25,224 @@
 
 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.Optional;
 import java.util.Set;
 import java.util.UUID;
+import java.util.concurrent.CompletableFuture;
 
 /**
- * The root API interface for LuckPerms
+ * 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 {
 
     /**
-     * Schedules an update task to run
+     * Gets information about the platform LuckPerms is running on.
+     *
+     * @return the platform info
+     * @since 4.0
      */
-    void runUpdateTask();
+    @NonNull PlatformInfo getPlatformInfo();
 
     /**
-     * Gets the API version
-     * @return the version of the API running on the platform
-     * @since 2.6
+     * 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
      */
-    double getApiVersion();
+    @NonNull UserManager getUserManager();
 
     /**
-     * Gets the plugin version
-     * @return the version of the plugin running on the platform
+     * 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
      */
-    String getVersion();
+    @NonNull GroupManager getGroupManager();
 
     /**
-     * Gets the platform LuckPerms is running on
-     * @return the platform LuckPerms is running on
-     * @since 2.7
+     * 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
      */
-    PlatformType getPlatformType();
+    @NonNull TrackManager getTrackManager();
 
     /**
-     * Gets the event bus, used for subscribing to events
+     * 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
      */
-    EventBus getEventBus();
+    @NonNull EventBus getEventBus();
 
     /**
-     * Gets a wrapped {@link LPConfiguration} instance, with read only access
+     * Gets a representation of the plugins configuration
      *
-     * @return a configuration instance
+     * @return the configuration
      */
-    LPConfiguration getConfiguration();
+    @NonNull LPConfiguration getConfiguration();
 
     /**
-     * Gets a wrapped {@link Storage} instance.
+     * 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
      */
-    Storage getStorage();
+    @NonNull Storage getStorage();
 
     /**
-     * Gets the messaging service in use on the platform, if present.
+     * Gets the {@link MessagingService}, if present.
      *
-     * @return an optional that may contain a messaging service instance.
+     * <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.
      */
-    Optional<MessagingService> getMessagingService();
+    @NonNull Optional<MessagingService> getMessagingService();
 
     /**
-     * Gets the {@link Logger} wrapping used by the platform
+     * Registers a {@link MessengerProvider} for use by the platform.
      *
-     * @return the logger instance
+     * <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
      */
-    Logger getLogger();
+    void registerMessengerProvider(@NonNull MessengerProvider messengerProvider);
 
     /**
-     * Gets a wrapped {@link UuidCache} instance, providing read access to the LuckPerms internal uuid caching system
+     * Gets the {@link ActionLogger}.
      *
-     * @return a uuid cache instance
+     * <p>The action logger is responsible for saving and broadcasting defined
+     * actions occurring on the platform.</p>
+     *
+     * @return the action logger
+     * @since 4.1
      */
-    UuidCache getUuidCache();
+    @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 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
@@ -110,18 +251,20 @@ public interface LuckPermsApi {
      * @return a {@link User} object, if one matching the uuid is loaded, or null if not
      * @throws NullPointerException if the uuid is null
      */
-    User getUser(UUID uuid);
+    default @Nullable User getUser(@NonNull UUID uuid) {
+        return getUserManager().getUser(uuid);
+    }
 
     /**
      * Gets a wrapped user object from the user storage.
      *
-     * <p>This method does not return null, unlike {@link #getUser(UUID)}</p>
-     *
      * @param uuid the uuid of the user to get
      * @return an optional {@link User} object
      * @throws NullPointerException if the uuid is null
      */
-    Optional<User> getUserSafe(UUID uuid);
+    default @NonNull Optional<User> getUserSafe(@NonNull UUID uuid) {
+        return getUserManager().getUserOpt(uuid);
+    }
 
     /**
      * Gets a wrapped user object from the user storage
@@ -130,25 +273,29 @@ public interface LuckPermsApi {
      * @return a {@link User} object, if one matching the uuid is loaded, or null if not
      * @throws NullPointerException if the name is null
      */
-    User getUser(String name);
+    default @Nullable User getUser(@NonNull String name) {
+        return getUserManager().getUser(name);
+    }
 
     /**
      * Gets a wrapped user object from the user storage.
      *
-     * <p>This method does not return null, unlike {@link #getUser(String)}</p>
-     *
      * @param name the username of the user to get
      * @return an optional {@link User} object
      * @throws NullPointerException if the name is null
      */
-    Optional<User> getUserSafe(String name);
+    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
      */
-    Set<User> getUsers();
+    default @NonNull Set<User> getUsers() {
+        return getUserManager().getLoadedUsers();
+    }
 
     /**
      * Check if a user is loaded in memory
@@ -157,16 +304,19 @@ public interface LuckPermsApi {
      * @return true if the user is loaded
      * @throws NullPointerException if the uuid is null
      */
-    boolean isUserLoaded(UUID uuid);
+    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
-     * @since 2.6
      */
-    void cleanupUser(User user);
+    default void cleanupUser(@NonNull User user) {
+        getUserManager().cleanupUser(user);
+    }
 
     /**
      * Gets a wrapped group object from the group storage
@@ -175,7 +325,9 @@ public interface LuckPermsApi {
      * @return a {@link Group} object, if one matching the name exists, or null if not
      * @throws NullPointerException if the name is null
      */
-    Group getGroup(String name);
+    default @Nullable Group getGroup(@NonNull String name) {
+        return getGroupManager().getGroup(name);
+    }
 
     /**
      * Gets a wrapped group object from the group storage.
@@ -186,14 +338,18 @@ public interface LuckPermsApi {
      * @return an optional {@link Group} object
      * @throws NullPointerException if the name is null
      */
-    Optional<Group> getGroupSafe(String name);
+    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
      */
-    Set<Group> getGroups();
+    default @NonNull Set<Group> getGroups() {
+        return getGroupManager().getLoadedGroups();
+    }
 
     /**
      * Check if a group is loaded in memory
@@ -202,16 +358,21 @@ public interface LuckPermsApi {
      * @return true if the group is loaded
      * @throws NullPointerException if the name is null
      */
-    boolean isGroupLoaded(String name);
+    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
+     * @return a {@link Track} object, if one matching the name exists, or null
+     * if not
      * @throws NullPointerException if the name is null
      */
-    Track getTrack(String name);
+    default @Nullable Track getTrack(@NonNull String name) {
+        return getTrackManager().getTrack(name);
+    }
 
     /**
      * Gets a wrapped track object from the track storage.
@@ -222,14 +383,18 @@ public interface LuckPermsApi {
      * @return an optional {@link Track} object
      * @throws NullPointerException if the name is null
      */
-    Optional<Track> getTrackSafe(String name);
+    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
      */
-    Set<Track> getTracks();
+    default @NonNull Set<Track> getTracks() {
+        return getTrackManager().getLoadedTracks();
+    }
 
     /**
      * Check if a track is loaded in memory
@@ -238,14 +403,19 @@ public interface LuckPermsApi {
      * @return true if the track is loaded
      * @throws NullPointerException if the name is null
      */
-    boolean isTrackLoaded(String name);
+    default boolean isTrackLoaded(@NonNull String name) {
+        return getTrackManager().isLoaded(name);
+    }
 
     /**
-     * Gets the node factory instance for the platform
+     * Returns a new LogEntry Builder instance
      *
-     * @return the node factory
+     * @return a new builder
+     * @since 4.0
      */
-    NodeFactory getNodeFactory();
+    default LogEntry.@NonNull Builder newLogEntryBuilder() {
+        return getActionLogger().newEntryBuilder();
+    }
 
     /**
      * Returns a permission builder instance
@@ -256,15 +426,19 @@ public interface LuckPermsApi {
      * @throws NullPointerException     if the permission is null
      * @since 2.6
      */
-    Node.Builder buildNode(String permission) throws IllegalArgumentException;
+    default Node.@NonNull Builder buildNode(@NonNull String permission) throws IllegalArgumentException {
+        return getNodeFactory().newBuilder(permission);
+    }
 
     /**
      * Register a custom context calculator to the server
      *
-     * @param contextCalculator the context calculator to register. The type MUST be the player class of the platform.
+     * @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.
      */
-    void registerContextCalculator(ContextCalculator<?> contextCalculator);
+    default void registerContextCalculator(@NonNull ContextCalculator<?> calculator) {
+        getContextManager().registerCalculator(calculator);
+    }
 
     /**
      * Gets a calculated context instance for the user using the rules of the platform.
@@ -274,7 +448,9 @@ public interface LuckPermsApi {
      * @param user the user to get contexts for
      * @return an optional containing contexts. Will return empty if the user is not online.
      */
-    Optional<Contexts> getContextForUser(User user);
+    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.
@@ -283,6 +459,19 @@ public interface LuckPermsApi {
      * @return a set of contexts.
      * @since 2.17
      */
-    ContextSet getContextForPlayer(Object player);
+    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/MessagingService.java

@@ -1,5 +1,8 @@
 /*
- * Copyright (c) 2016 Lucko (Luck) <luck@lucko.me>
+ * 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
@@ -22,6 +25,8 @@
 
 package me.lucko.luckperms.api;
 
+import org.checkerframework.checker.nullness.qual.NonNull;
+
 /**
  * A means to push changes to other servers using the platforms networking
  *
@@ -30,11 +35,42 @@ package me.lucko.luckperms.api;
 public interface MessagingService {
 
     /**
-     * Uses the messaging service to inform other servers about changes.
+     * Gets the name of this messaging service
      *
-     * <p>This will push the update asynchronously, and this method will return immediately. Calling this method is
-     * equivalent to running "/lp networksync", except will not sync this server.</p>
+     * @return the name of this messaging service
+     * @since 4.1
+     */
+    String getName();
+
+    /**
+     * Uses the messaging service to inform other servers about a general
+     * change.
+     *
+     * <p>The standard response by other servers will be to execute a overall
+     * sync of all live data, equivalent to calling
+     * {@link LuckPermsApi#runUpdateTask()}.</p>
+     *
+     * <p>This will push the update asynchronously, and this method will return
+     * immediately. Note that this method will not cause an update to be
+     * processed on the local server.</p>
      */
     void pushUpdate();
 
+    /**
+     * Uses the messaging service to inform other servers about a change to a
+     * specific user.
+     *
+     * <p>The standard response by other servers is undefined, however the
+     * current implementation will reload the corresponding users data if they
+     * are online.</p>
+     *
+     * <p>This will push the update asynchronously, and this method will return
+     * immediately. Note that this method will not cause an update to be
+     * processed on the local server.</p>
+     *
+     * @param user the user to push the update for
+     * @since 4.1
+     */
+    void pushUserUpdate(@NonNull User user);
+
 }

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

@@ -1,283 +0,0 @@
-/*
- * Copyright (c) 2016 Lucko (Luck) <luck@lucko.me>
- *
- *  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.exceptions.ObjectAlreadyHasException;
-import me.lucko.luckperms.exceptions.ObjectLacksException;
-
-import java.util.HashSet;
-import java.util.Map;
-import java.util.Set;
-
-/**
- * A collection of utilities to help retrieve meta values for {@link PermissionHolder}s
- *
- * @since 2.7
- * @deprecated in favour of using {@link NodeFactory#makeMetaNode(String, String)} or {@link me.lucko.luckperms.api.caching.MetaData}.
- */
-@Deprecated
-public class MetaUtils {
-
-    private static String escapeDelimiters(String s, String... delims) {
-        for (String delim : delims) {
-            s = s.replace(delim, "\\" + delim);
-        }
-        return s;
-    }
-
-    private static String unescapeDelimiters(String s, String... delims) {
-        for (String delim : delims) {
-            s = s.replace("\\" + delim, delim);
-        }
-        return s;
-    }
-
-    /**
-     * Escapes special characters used within LuckPerms, so the string can be saved without issues
-     *
-     * @param s the string to escape
-     * @return an escaped string
-     * @throws NullPointerException if the string is null
-     */
-    public static String escapeCharacters(String s) {
-        if (s == null) {
-            throw new NullPointerException();
-        }
-
-        return escapeDelimiters(s, ".", "/", "-", "$");
-    }
-
-    /**
-     * Unescapes special characters used within LuckPerms, the inverse of {@link #escapeCharacters(String)}
-     *
-     * @param s the string to unescape
-     * @return an unescaped string
-     * @throws NullPointerException if the string is null
-     */
-    public static String unescapeCharacters(String s) {
-        if (s == null) {
-            throw new NullPointerException();
-        }
-
-        s = s.replace("{SEP}", ".");
-        s = s.replace("{FSEP}", "/");
-        s = s.replace("{DSEP}", "$");
-        s = unescapeDelimiters(s, ".", "/", "-", "$");
-
-        return s;
-    }
-
-    /**
-     * Sets a meta value on a holder
-     *
-     * @param holder the holder to apply the meta node to
-     * @param server the server to apply the meta on, can be null
-     * @param world  the world to apply the meta on, can be null
-     * @param key    the meta key
-     * @param value  the meta value
-     * @throws NullPointerException     if the holder, node or value is null
-     * @throws IllegalArgumentException if the node or value is empty
-     */
-    public static void setMeta(PermissionHolder holder, String server, String world, String key, String value) {
-        if (holder == null) throw new NullPointerException("holder");
-        if (key == null) throw new NullPointerException("node");
-        if (value == null) throw new NullPointerException("value");
-        if (key.equals("")) throw new IllegalArgumentException("node is empty");
-        if (value.equals("")) throw new IllegalArgumentException("value is empty");
-
-        key = escapeCharacters(key);
-        value = escapeCharacters(value);
-
-        Set<Node> toRemove = new HashSet<>();
-        for (Node n : holder.getEnduringPermissions()) {
-            if (n.isMeta() && n.getMeta().getKey().equals(key)) {
-                toRemove.add(n);
-            }
-        }
-
-        for (Node n : toRemove) {
-            try {
-                holder.unsetPermission(n);
-            } catch (ObjectLacksException ignored) {}
-        }
-
-        Node.Builder metaNode = LuckPerms.getApi().buildNode("meta." + key + "." + value).setValue(true);
-        if (server != null) {
-            metaNode.setServer(server);
-        }
-        if (world != null) {
-            metaNode.setWorld(world);
-        }
-
-        try {
-            holder.setPermission(metaNode.build());
-        } catch (ObjectAlreadyHasException ignored) {}
-    }
-
-    /**
-     * Gets a meta value for the holder
-     *
-     * @param holder        the holder to get the meta from
-     * @param server        the server to retrieve the meta on, can be null
-     * @param world         the world to retrieve the meta on, can be null
-     * @param node          the node to get
-     * @param defaultValue  the default value to return if the node is not set
-     * @param includeGlobal if global nodes should be considered when retrieving the meta
-     * @return a meta string, or the default value if the user does not have the meta node
-     * @throws NullPointerException     if the holder or node is null
-     * @throws IllegalArgumentException if the node is empty
-     */
-    public static String getMeta(PermissionHolder holder, String server, String world, String node, String defaultValue, boolean includeGlobal) {
-        if (holder == null) throw new NullPointerException("holder");
-        if (node == null) throw new NullPointerException("node");
-        if (node.equals("")) {
-            throw new IllegalArgumentException("node is empty");
-        }
-
-        node = escapeCharacters(node);
-
-        for (Node n : holder.getPermissions()) {
-            if (!n.getValue() || !n.isMeta()) continue;
-
-            if (!n.shouldApplyOnServer(server, includeGlobal, false)) continue;
-            if (!n.shouldApplyOnWorld(world, includeGlobal, false)) continue;
-
-            Map.Entry<String, String> meta = n.getMeta();
-            if (meta.getKey().equalsIgnoreCase(node)) {
-                return unescapeCharacters(meta.getValue());
-            }
-        }
-
-        return defaultValue;
-    }
-
-    private static void setChatMeta(boolean prefix, PermissionHolder holder, String value, int priority, String server, String world) {
-        if (holder == null) throw new NullPointerException("holder");
-        if (value == null || value.equals("")) {
-            throw new IllegalArgumentException("value is null/empty");
-        }
-
-        Node.Builder node = LuckPerms.getApi().buildNode(prefix ? "prefix" : "suffix" + "." + priority + "." + escapeCharacters(value));
-        node.setValue(true);
-        if (server != null) {
-            node.setServer(server);
-        }
-        if (world != null) {
-            node.setWorld(world);
-        }
-
-        try {
-            holder.setPermission(node.build());
-        } catch (ObjectAlreadyHasException ignored) {}
-    }
-
-    /**
-     * Adds a prefix to a holder on a specific server and world
-     *
-     * @param holder   the holder to set the prefix for
-     * @param prefix   the prefix value
-     * @param priority the priority to set the prefix at
-     * @param server   the server to set the prefix on, can be null
-     * @param world    the world to set the prefix on, can be null
-     * @throws NullPointerException     if the holder is null
-     * @throws IllegalArgumentException if the prefix is null or empty
-     */
-    public static void setPrefix(PermissionHolder holder, String prefix, int priority, String server, String world) {
-        setChatMeta(true, holder, prefix, priority, server, world);
-    }
-
-    /**
-     * Adds a suffix to a holder on a specific server and world
-     *
-     * @param holder   the holder to set the suffix for
-     * @param suffix   the suffix value
-     * @param priority the priority to set the suffix at
-     * @param server   the server to set the suffix on, can be null
-     * @param world    the world to set the suffix on, can be null
-     * @throws NullPointerException     if the holder is null
-     * @throws IllegalArgumentException if the suffix is null or empty
-     */
-    public static void setSuffix(PermissionHolder holder, String suffix, int priority, String server, String world) {
-        setChatMeta(false, holder, suffix, priority, server, world);
-    }
-
-    private static String getChatMeta(boolean prefix, PermissionHolder holder, String server, String world, boolean includeGlobal) {
-        if (holder == null) {
-            throw new NullPointerException("holder");
-        }
-
-        int priority = Integer.MIN_VALUE;
-        String meta = null;
-        for (Node n : holder.getAllNodes(Contexts.allowAll())) {
-            if (!n.getValue()) continue;
-
-            if (!n.shouldApplyOnServer(server, includeGlobal, false)) continue;
-            if (!n.shouldApplyOnWorld(world, includeGlobal, false)) continue;
-
-            if (prefix ? !n.isPrefix() : !n.isSuffix()) {
-                continue;
-            }
-
-            Map.Entry<Integer, String> value = prefix ? n.getPrefix() : n.getSuffix();
-            if (value.getKey() > priority) {
-                meta = value.getValue();
-                priority = value.getKey();
-            }
-        }
-
-        return meta == null ? "" : unescapeCharacters(meta);
-    }
-
-    /**
-     * Returns a holders highest priority prefix, if they have one
-     *
-     * @param holder        the holder
-     * @param server        the server to retrieve the prefix on
-     * @param world         the world to retrieve the prefix on
-     * @param includeGlobal if global nodes should be considered when retrieving the prefix
-     * @return a prefix string, if the holder has one, or an empty string if not.
-     * @throws NullPointerException if the holder is null
-     */
-    public static String getPrefix(PermissionHolder holder, String server, String world, boolean includeGlobal) {
-        return getChatMeta(true, holder, server, world, includeGlobal);
-    }
-
-    /**
-     * Returns a holders highest priority suffix, if they have one
-     *
-     * @param holder        the holder
-     * @param server        the server to retrieve the suffix on
-     * @param world         the world to retrieve the suffix on
-     * @param includeGlobal if global nodes should be considered when retrieving the suffix
-     * @return a suffix string, if the holder has one, or an empty string if not.
-     * @throws NullPointerException if the holder is null
-     */
-    public static String getSuffix(PermissionHolder holder, String server, String world, boolean includeGlobal) {
-        return getChatMeta(false, holder, server, world, includeGlobal);
-    }
-
-    private MetaUtils() {
-    }
-
-}

api/src/main/java/me/lucko/luckperms/api/MutateResult.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 me.lucko.luckperms.api;
+
+/**
+ * Represents the result to a "mutation" on an object.
+ *
+ * @since 4.2
+ */
+public interface MutateResult {
+
+    /**
+     * 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.
+     *
+     * @return if the result indicates a success
+     */
+    boolean wasSuccess();
+
+    /**
+     * Gets if the operation which produced this result failed.
+     *
+     * @return if the result indicates a failure
+     */
+    default boolean wasFailure() {
+        return !wasSuccess();
+    }
+
+    /**
+     * 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
+     */
+    default boolean asBoolean() {
+        return wasSuccess();
+    }
+
+}

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

@@ -1,5 +1,8 @@
 /*
- * Copyright (c) 2016 Lucko (Luck) <luck@lucko.me>
+ * 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
@@ -22,84 +25,165 @@
 
 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;
 
 /**
- * An immutable permission node
+ * Represents a LuckPerms "node".
  *
- * <p>Use {@link LuckPermsApi#buildNode(String)} to get an instance.</p>
+ * <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 extends Map.Entry<String, Boolean> {
+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
      */
-    String getPermission();
+    @NonNull String getPermission();
 
     /**
-     * Get what value the permission is set to. A negated node would return <code>false</code>.
+     * Gets the value of the node.
      *
-     * @return the permission's value
+     * <p>A negated setting would result in a value of <code>false</code>.</p>
+     *
+     * @return the nodes value
      */
-    @Override
-    Boolean getValue();
+    boolean getValue();
 
     /**
+     * Gets the value of this node as a {@link Tristate}.
+     *
      * @return the value of this node as a Tristate
      */
-    Tristate getTristate();
+    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
      */
-    boolean isNegated();
+    default boolean isNegated() {
+        return !getValue();
+    }
 
     /**
-     * If this node is set to override explicitly.
-     * This value does not persist across saves, and is therefore only useful for transient nodes
+     * 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
+     * Gets the server this node applies on, if the node is server specific.
      *
      * @return an {@link Optional} containing the server, if one is defined
      */
-    Optional<String> getServer();
+    @NonNull Optional<String> getServer();
 
     /**
-     * Gets the world this node applies on, if the node is world specific
+     * Gets the world this node applies on, if the node is world specific.
      *
      * @return an {@link Optional} containing the world, if one is defined
      */
-    Optional<String> getWorld();
+    @NonNull Optional<String> getWorld();
 
     /**
-     * Returns if this node is server specific
+     * Gets if this node is server specific.
      *
      * @return true if this node is server specific
      */
     boolean isServerSpecific();
 
     /**
-     * Returns if this node is server specific
+     * Gets if this node is server specific.
      *
      * @return true if this node is server specific
      */
     boolean isWorldSpecific();
 
     /**
-     * Returns if this node applies globally, and has no specific context
+     * 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
@@ -107,7 +191,7 @@ public interface Node extends Map.Entry<String, Boolean> {
     boolean appliesGlobally();
 
     /**
-     * Returns if this node has any specific context in order to apply.
+     * 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
@@ -115,288 +199,485 @@ public interface Node extends Map.Entry<String, Boolean> {
     boolean hasSpecificContext();
 
     /**
-     * Returns if this node is able to apply in the given context
+     * Gets if this node should apply in the given context
      *
-     * @param includeGlobal if global server values should apply
-     * @param includeGlobalWorld if global world values should apply
-     * @param server the server being checked against, or null
-     * @param world the world being checked against, or null
-     * @param context the context being checked against, or null
-     * @param applyRegex if regex should be applied
-     * @return true if the node should apply, otherwise false
-     * @since 3.1
-     */
-    boolean shouldApply(boolean includeGlobal, boolean includeGlobalWorld, String server, String world, ContextSet context, boolean applyRegex);
-
-    /**
-     * If this node should apply on a specific server
-     *
-     * @param server        the name of the server
-     * @param includeGlobal if global permissions should apply
-     * @param applyRegex    if regex should be applied
-     * @return true if the node should apply
-     */
-    boolean shouldApplyOnServer(String server, boolean includeGlobal, boolean applyRegex);
-
-    /**
-     * If this node should apply on a specific world
-     *
-     * @param world         the name of the world
-     * @param includeGlobal if global permissions should apply
-     * @param applyRegex    if regex should be applied
-     * @return true if the node should apply
-     */
-    boolean shouldApplyOnWorld(String world, boolean includeGlobal, boolean applyRegex);
-
-    /**
-     * If this node should apply in the given context
-     *
-     * @param context        the context key value pairs
-     * @param worldAndServer if world and server contexts should be checked
+     * @param contextSet the context set
      * @return true if the node should apply
      * @since 2.13
      */
-    boolean shouldApplyWithContext(ContextSet context, boolean worldAndServer);
+    boolean shouldApplyWithContext(@NonNull ContextSet contextSet);
 
     /**
-     * If this node should apply in the given context
+     * Resolves any shorthand parts of this node and returns the full list of
+     * resolved nodes.
      *
-     * @param context the context key value pairs
-     * @return true if the node should apply
-     * @since 2.13
-     */
-    boolean shouldApplyWithContext(ContextSet context);
-
-    /**
-     * Similar to {@link #shouldApplyOnServer(String, boolean, boolean)}, except this method accepts a List
-     *
-     * @param servers       the list of servers
-     * @param includeGlobal if global permissions should apply
-     * @return true if the node should apply
-     */
-    boolean shouldApplyOnAnyServers(List<String> servers, boolean includeGlobal);
-
-    /**
-     * Similar to {@link #shouldApplyOnWorld(String, boolean, boolean)}, except this method accepts a List
-     *
-     * @param worlds        the list of world
-     * @param includeGlobal if global permissions should apply
-     * @return true if the node should apply
-     */
-    boolean shouldApplyOnAnyWorlds(List<String> worlds, boolean includeGlobal);
-
-    /**
-     * Resolves a list of wildcards that match this node
-     *
-     * @param possibleNodes a list of possible permission nodes
-     * @return a list of permissions that match this wildcard
-     */
-    List<String> resolveWildcard(List<String> possibleNodes);
-
-    /**
-     * Resolves any shorthand parts of this node and returns the full list
+     * <p>The list will not contain the exact permission itself.</p>
      *
      * @return a list of full nodes
      */
-    List<String> resolveShorthand();
+    @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
      */
-    boolean isPermanent();
+    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();
+    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
      */
-    Date getExpiry();
+    @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();
+    long getSecondsTilExpiry() throws IllegalStateException;
 
     /**
-     * Return true if the node has expired.
-     * This also returns false if the node is not temporary
+     * 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
+     * Gets the extra contexts required for this node to apply.
      *
      * @return the extra contexts required for this node to apply
      * @since 2.13
      */
-    ContextSet getContexts();
+    @NonNull ContextSet getContexts();
 
     /**
-     * The same as {@link #getContexts()}, but also includes values for "server" and "world" keys if present.
+     * 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
      */
-    ContextSet getFullContexts();
+    @NonNull ContextSet getFullContexts();
 
     /**
-     * Converts this node into a serialized form
+     * Gets if this node is a wildcard permission.
      *
-     * @return a serialized node string
-     * @deprecated because this serialized form is no longer used by the implementation.
-     */
-    @Deprecated
-    String toSerializedNode();
-
-    /**
-     * Returns if this is a group node
-     *
-     * @return true if this is a group node
-     */
-    boolean isGroupNode();
-
-    /**
-     * Returns the name of the group
-     *
-     * @return the name of the group
-     * @throws IllegalStateException if this is not a group node. See {@link #isGroupNode()}
-     */
-    String getGroupName();
-
-    /**
-     * Returns if this node is a wildcard node
-     *
-     * @return true if this node is a wildcard node
+     * @return true if this node is a wildcard permission
      */
     boolean isWildcard();
 
     /**
-     * Gets the level of this wildcard, higher is more specific
+     * 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();
+    int getWildcardLevel() throws IllegalStateException;
 
     /**
-     * Returns if this node is a meta node
+     * Gets if this node has any extra {@link NodeType} data attached to it.
      *
-     * @return true if this node is a meta node
+     * @return if this node has any type data
+     * @since 4.2
      */
-    boolean isMeta();
+    boolean hasTypeData();
 
     /**
-     * Gets the meta value from this node
+     * Gets the type data corresponding to the given <code>key</code>, if present.
      *
-     * @return the meta value
-     * @throws IllegalStateException if this node is not a meta node
+     * @param key the key
+     * @param <T> the {@link NodeType} type
+     * @return the data, if present
+     * @since 4.2
      */
-    Map.Entry<String, String> getMeta();
+    <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
      */
-    boolean isPrefix();
+    default boolean isPrefix() {
+        return getTypeData(PrefixType.KEY).isPresent();
+    }
 
     /**
-     * Gets the prefix value from this node
+     * Gets the prefix entry if this node has {@link PrefixType} type data,
+     * throwing an exception if the data is not present.
      *
-     * @return the prefix value
-     * @throws IllegalStateException if this node is a not a prefix node
+     * @return the meta entry
+     * @throws IllegalStateException if this node doesn't have {@link PrefixType} data
      */
-    Map.Entry<Integer, String> getPrefix();
+    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
      */
-    boolean isSuffix();
+    default boolean isSuffix() {
+        return getTypeData(SuffixType.KEY).isPresent();
+    }
 
     /**
-     * Gets the suffix value from this node
+     * Gets the suffix entry if this node has {@link SuffixType} type data,
+     * throwing an exception if the data is not present.
      *
-     * @return the suffix value
-     * @throws IllegalStateException if this node is a not a suffix node
+     * @return the meta entry
+     * @throws IllegalStateException if this node doesn't have {@link SuffixType} data
      */
-    Map.Entry<Integer, String> getSuffix();
+    default Map.@NonNull Entry<Integer, String> getSuffix() throws IllegalStateException {
+        return typeData(SuffixType.KEY).getAsEntry();
+    }
 
     /**
-     * Checks if this Node is equal to another node
+     * 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 #equalsIgnoringValue(Node) for a less strict implementation of this method
+     * @see StandardNodeEquality#EXACT
      */
+    @Override
     boolean equals(Object obj);
 
     /**
-     * Similar to {@link Node#equals(Object)}, except doesn't take note of the value
+     * Gets if this Node is equal to another node as defined by the given
+     * {@link StandardNodeEquality} predicate.
      *
-     * @param other the other node
-     * @return true if the two nodes are almost equal
+     * @param other             the other node
+     * @param equalityPredicate the predicate
+     * @return true if this node is considered equal
+     * @since 4.1
      */
-    boolean equalsIgnoringValue(Node other);
+    boolean standardEquals(Node other, StandardNodeEquality equalityPredicate);
 
     /**
-     * Similar to {@link Node#equals(Object)}, except doesn't take note of the expiry time or value
+     * Gets if this Node is equal to another node as defined by the given
+     * {@link NodeEqualityPredicate}.
      *
-     * @param other the other node
-     * @return true if the two nodes are almost equal
+     * @param other             the other node
+     * @param equalityPredicate the predicate
+     * @return true if this node is considered equal
+     * @since 4.1
      */
-    boolean almostEquals(Node other);
+    default boolean equals(Node other, NodeEqualityPredicate equalityPredicate) {
+        return equalityPredicate.areEqual(this, other);
+    }
 
     /**
-     * Similar to {@link Node#equals(Object)}, except doesn't take note of the value or if the node is temporary
+     * 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)}
      */
-    boolean equalsIgnoringValueOrTemp(Node other);
+    @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 {
-        Builder setNegated(boolean negated);
-
-        Builder setValue(boolean value);
 
         /**
-         * Warning: this value does not persist, and disappears when the holder is re-loaded.
-         * It is therefore only useful for transient nodes.
+         * 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 setOverride(boolean override);
+        Builder copyFrom(@NonNull Node node);
 
-        Builder setExpiry(long expireAt);
+        /**
+         * Sets the value of negated for the node.
+         *
+         * @param negated the value
+         * @return the builder
+         * @see Node#isNegated()
+         */
+        @NonNull Builder setNegated(boolean negated);
 
-        Builder setWorld(String world);
+        /**
+         * Sets the value of the node.
+         *
+         * @param value the value
+         * @return the builder
+         * @see Node#getValue()
+         */
+        @NonNull Builder setValue(boolean value);
 
-        Builder setServer(String server) throws IllegalArgumentException;
+        /**
+         * 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);
 
-        Builder withExtraContext(String key, String value);
+        /**
+         * 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);
 
-        Builder withExtraContext(Map<String, String> map);
+        /**
+         * 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);
+        }
 
-        Builder withExtraContext(Set<Map.Entry<String, String>> context);
+        /**
+         * Marks that the node being built should never expire.
+         *
+         * @return the builder
+         * @since 4.2
+         */
+        @NonNull Builder clearExpiry();
 
-        Builder withExtraContext(Map.Entry<String, String> entry);
+        /**
+         * Sets the world value for the node.
+         *
+         * @param world the world value
+         * @return the builder
+         * @see Node#getWorld()
+         */
+        @NonNull Builder setWorld(@Nullable String world);
 
-        Builder withExtraContext(ContextSet set);
+        /**
+         * Sets the server value for the node.
+         *
+         * @param server the world value
+         * @return the builder
+         * @see Node#getServer()
+         */
+        @NonNull Builder setServer(@Nullable String server);
 
-        Node build();
+        /**
+         * 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

@@ -0,0 +1,52 @@
+/*
+ * 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
+     *
+     * @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,5 +1,8 @@
 /*
- * Copyright (c) 2016 Lucko (Luck) <luck@lucko.me>
+ * 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
@@ -22,24 +25,15 @@
 
 package me.lucko.luckperms.api;
 
+import org.checkerframework.checker.nullness.qual.NonNull;
+
 /**
- * Builds {@link Node} instances
+ * Assists with constructing {@link Node} instances.
  *
  * @since 2.17
  */
 public interface NodeFactory {
 
-    /**
-     * Creates a node from a serialised node string
-     *
-     * @param serialisedPermission the serialised permission string
-     * @param value                the value of the node
-     * @return a node instance
-     * @throws NullPointerException if the permission is null
-     */
-    Node fromSerialisedNode(String serialisedPermission, boolean value);
-
-
     /**
      * Creates a new node builder from a given base permission string
      *
@@ -47,7 +41,7 @@ public interface NodeFactory {
      * @return a node builder instance
      * @throws NullPointerException if the permission is null
      */
-    Node.Builder newBuilder(String permission);
+    Node.@NonNull Builder newBuilder(@NonNull String permission);
 
     /**
      * Creates a node builder instance from an existing node
@@ -56,17 +50,7 @@ public interface NodeFactory {
      * @return a node builder instance
      * @throws NullPointerException if the other node is null
      */
-    Node.Builder newBuilderFromExisting(Node other);
-
-    /**
-     * Creates a node builder from a serialised node string
-     *
-     * @param serialisedPermission the serialised permission string
-     * @param value                the value of the node
-     * @return a node builder instance
-     * @throws NullPointerException if the permission is null
-     */
-    Node.Builder newBuilderFromSerialisedNode(String serialisedPermission, boolean value);
+    Node.@NonNull Builder newBuilderFromExisting(@NonNull Node other);
 
 
     /**
@@ -78,7 +62,17 @@ public interface NodeFactory {
      * @throws IllegalStateException if the group instance was not obtained from LuckPerms.
      * @since 3.1
      */
-    Node.Builder makeGroupNode(Group group);
+    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
@@ -88,7 +82,19 @@ public interface NodeFactory {
      * @return a node builder instance
      * @throws NullPointerException if the key or value is null
      */
-    Node.Builder makeMetaNode(String key, String value);
+    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
@@ -98,7 +104,7 @@ public interface NodeFactory {
      * @return a node builder instance
      * @throws NullPointerException if the prefix is null
      */
-    Node.Builder makePrefixNode(int priority, String prefix);
+    Node.@NonNull Builder makePrefixNode(int priority, @NonNull String prefix);
 
     /**
      * Creates a node builder from a prefix string and priority
@@ -108,6 +114,6 @@ public interface NodeFactory {
      * @return a node builder instance
      * @throws NullPointerException if the suffix is null
      */
-    Node.Builder makeSuffixNode(int priority, String suffix);
+    Node.@NonNull Builder makeSuffixNode(int priority, @NonNull String suffix);
 
 }

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

@@ -0,0 +1,114 @@
+/*
+ * 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.UserManager;
+
+import org.checkerframework.checker.nullness.qual.NonNull;
+import org.checkerframework.checker.nullness.qual.Nullable;
+
+import java.util.Set;
+import java.util.UUID;
+
+/**
+ * Encapsulates the result of an operation to save uuid data about a player.
+ *
+ * <p>The corresponding method can be found at
+ * {@link UserManager#savePlayerData(UUID, String)}.</p>
+ *
+ * @since 4.2
+ */
+public interface PlayerSaveResult {
+
+    /**
+     * Gets the status returned by the operation
+     *
+     * @return the status
+     */
+    @NonNull Set<Status> getStatus();
+
+    /**
+     * Gets if the result includes a certain status code.
+     *
+     * @param status the status to check for
+     * @return if the result includes the status
+     */
+    boolean includes(@NonNull Status status);
+
+    /**
+     * Gets the old username involved in the result
+     *
+     * @return the old username
+     * @see Status#USERNAME_UPDATED
+     */
+    @Nullable String getOldUsername();
+
+    /**
+     * Gets the other uuids involved in the result
+     *
+     * @return the other uuids
+     * @see Status#OTHER_UUIDS_PRESENT_FOR_USERNAME
+     */
+    @Nullable Set<UUID> getOtherUuids();
+
+    /**
+     * The various states the result can take
+     */
+    enum Status {
+
+        /**
+         * There was no existing data saved for either the uuid or username
+         */
+        CLEAN_INSERT,
+
+        /**
+         * There was existing data for the player, no change was needed.
+         */
+        NO_CHANGE,
+
+        /**
+         * There was already a record for the UUID saved, but it was for a different username.
+         *
+         * <p>This is normal, players are able to change their usernames.</p>
+         */
+        USERNAME_UPDATED,
+
+        /**
+         * There was already a record for the username saved, but it was under a different uuid.
+         *
+         * <p>This is a bit of a cause for concern. It's possible that "player1" has changed
+         * their username to "player2", and "player3" has changed their username to "player1".
+         * If the original "player1" doesn't join after changing their name, this conflict could
+         * occur.</p>
+         *
+         * <p>However, what's more likely is that the server is not setup to authenticate
+         * correctly. Usually this is a problem with BungeeCord "ip-forwarding", but could be
+         * that the user of the plugin is running a network off a shared database with one
+         * server in online mode and another in offline mode.</p>
+         */
+        OTHER_UUIDS_PRESENT_FOR_USERNAME,
+    }
+}

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

@@ -0,0 +1,127 @@
+/*
+ * 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.Optional;
+
+/**
+ * Encapsulates the result of {@link User}s promotion along a {@link Track}.
+ *
+ * @since 4.2
+ */
+public interface PromotionResult extends MutateResult {
+
+    /**
+     * Gets the status of the result.
+     *
+     * @return the status
+     */
+    @NonNull Status getStatus();
+
+    @Override
+    default boolean wasSuccess() {
+        return getStatus().wasSuccess();
+    }
+
+    /**
+     * Gets the name of the group the user was promoted from, if applicable.
+     *
+     * <p>Will only be present for results with a {@link #getStatus() status} of
+     * {@link Status#SUCCESS}.</p>
+     *
+     * @return the group the user was promoted from.
+     */
+    @NonNull Optional<String> getGroupFrom();
+
+    /**
+     * Gets the name of the group the user was promoted from, if applicable.
+     *
+     * <p>Will only be present for results with a {@link #getStatus() status} of
+     * {@link Status#SUCCESS} or {@link Status#ADDED_TO_FIRST_GROUP}.</p>
+     *
+     * <p>The value will also be set for results with the {@link Status#MALFORMED_TRACK} status,
+     * with this value marking the group which no longer exists.</p>
+     *
+     * @return the group the user was promoted to.
+     */
+    @NonNull Optional<String> getGroupTo();
+
+    /**
+     * The result status
+     */
+    enum Status implements MutateResult {
+
+        /**
+         * Indicates that the user was promoted normally.
+         */
+        SUCCESS(true),
+
+        /**
+         * Indicates that the user was added to the first group in the track.
+         *
+         * <p>This usually occurs when the user isn't already on any of the groups in the track.</p>
+         */
+        ADDED_TO_FIRST_GROUP(true),
+
+        /**
+         * Indicates that the next group in the track no longer exists.
+         */
+        MALFORMED_TRACK(false),
+
+        /**
+         * Indicates that the user is already a member of the group at the end of the track,
+         * and as such cannot be promoted any further.
+         */
+        END_OF_TRACK(false),
+
+        /**
+         * Indicates that the implementation was unable to determine the users current position on
+         * this track.
+         *
+         * <p>This usually occurs when the user is on more than one group on the track.</p>
+         */
+        AMBIGUOUS_CALL(false),
+
+        /**
+         * An undefined failure occurred.
+         */
+        UNDEFINED_FAILURE(false);
+
+        private final boolean success;
+
+        Status(boolean success) {
+            this.success = success;
+        }
+
+        @Override
+        public boolean wasSuccess() {
+            return this.success;
+        }
+    }
+
+}

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

@@ -0,0 +1,78 @@
+/*
+ * 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;
+
+/**
+ * Standard {@link NodeEqualityPredicate}s.
+ *
+ * @since 4.1
+ */
+public enum StandardNodeEquality implements NodeEqualityPredicate {
+
+    /**
+     * Represents an exact match.
+     *
+     * <p>All attributes of the nodes must match for them to be considered
+     * equal.</p>
+     */
+    EXACT,
+
+    /**
+     * All attributes must match, except for
+     * {@link Node#getValue() value}, which is ignored.
+     */
+    IGNORE_VALUE,
+
+    /**
+     * All attributes must match, except for the
+     * {@link Node#getExpiry() expiry time}, which is ignored.
+     *
+     * <p>Note that with this setting, whether a node is temporary or not is
+     * still considered.</p>
+     */
+    IGNORE_EXPIRY_TIME,
+
+    /**
+     * All attributes must match, except for
+     * {@link Node#getValue() value} and the
+     * {@link Node#getExpiry() expiry time}, which are ignored.
+     */
+    IGNORE_EXPIRY_TIME_AND_VALUE,
+
+    /**
+     * All attributes must match, except for
+     * {@link Node#getValue() value} and the if the node is
+     * {@link Node#isTemporary() temporary}, which are ignored.
+     */
+    IGNORE_VALUE_OR_IF_TEMPORARY;
+
+    @Override
+    public boolean areEqual(@NonNull Node o1, @NonNull Node o2) {
+        return o1.standardEquals(o2, this);
+    }
+}

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

@@ -1,5 +1,8 @@
 /*
- * Copyright (c) 2016 Lucko (Luck) <luck@lucko.me>
+ * 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
@@ -22,23 +25,21 @@
 
 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;
-import java.util.function.Consumer;
 
 /**
- * A means of loading and saving data to/from the Storage provider.
- *
- * <p>All methods return {@link CompletableFuture}s, which will be populated with the result once the data has been
- * loaded asynchronously. Care should be taken when using the methods to ensure that the main server thread is not
- * blocked.</p>
- *
- * <p>Methods such as {@link CompletableFuture#get()} and equivalent should <strong>not</strong> be called on the main
- * server thread. If you need to use the result of these operations on the main server thread, please register a
- * callback using {@link CompletableFuture#thenAcceptAsync(Consumer, Executor)} and {@link #getSyncExecutor()}.</p>
+ * A means of loading and saving permission data to/from the backend.
  *
  * @since 2.14
  */
@@ -49,81 +50,86 @@ public interface Storage {
      *
      * @return the name of the implementation
      */
-    String getName();
+    @NonNull String getName();
 
     /**
-     * Return whether the storage instance is allowing logins on the platform.
+     * 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();
 
-    /**
-     * Returns an executor which will run all passed runnables on the main server thread.
-     *
-     * @return an executor instance
-     */
-    Executor getSyncExecutor();
-
-    /**
-     * Returns an executor which will run all passed runnables asynchronously using the platforms scheduler and thread
-     * pools.
-     *
-     * @return an executor instance
-     */
-    Executor getAsyncExecutor();
-
     /**
      * 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)}.
      */
-    CompletableFuture<Boolean> logAction(LogEntry entry);
+    @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()}
      */
-    CompletableFuture<Log> 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. (if you want to specify <code>null</code> here, just input "null" as a
-     *                 string.)
+     * @param username the users username, or null if it is not known.
      * @return if the operation completed successfully
-     * @throws NullPointerException if uuid or username is null
+     * @throws NullPointerException if uuid is null
+     * @deprecated in favour of {@link UserManager#loadUser(UUID, String)}
      */
-    CompletableFuture<Boolean> loadUser(UUID uuid, String username);
+    @Deprecated
+    @NonNull CompletableFuture<Boolean> loadUser(@NonNull UUID uuid, @Nullable String username);
 
     /**
-     * Saves a user object back to storage. You should call this after you make any changes to a user.
+     * 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)}
      */
-    CompletableFuture<Boolean> saveUser(User user);
-
-    /**
-     * Removes users from the main storage who are "default". This is called every time the plugin loads.
-     *
-     * @return true if the operation completed successfully
-     */
-    CompletableFuture<Boolean> cleanupUsers();
+    @Deprecated
+    @NonNull CompletableFuture<Boolean> saveUser(@NonNull User user);
 
     /**
      * Gets a set all "unique" user UUIDs.
-     * "Unique" meaning the user isn't just a member of the "default" group.
+     *
+     * <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()}
      */
-    CompletableFuture<Set<UUID>> getUniqueUsers();
+    @Deprecated
+    @NonNull CompletableFuture<Set<UUID>> getUniqueUsers();
 
     /**
      * Searches for a list of users with a given permission.
@@ -132,8 +138,10 @@ public interface Storage {
      * @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)}
      */
-    CompletableFuture<List<HeldPermission<UUID>>> getUsersWithPermission(String permission);
+    @Deprecated
+    @NonNull CompletableFuture<List<HeldPermission<UUID>>> getUsersWithPermission(@NonNull String permission);
 
     /**
      * Creates and loads a group into the plugins local storage
@@ -142,8 +150,10 @@ public interface Storage {
      * @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)}
      */
-    CompletableFuture<Boolean> createAndLoadGroup(String name);
+    @Deprecated
+    @NonNull CompletableFuture<Boolean> createAndLoadGroup(@NonNull String name);
 
     /**
      * Loads a group into the plugins local storage.
@@ -152,25 +162,33 @@ public interface Storage {
      * @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)}
      */
-    CompletableFuture<Boolean> loadGroup(String name);
+    @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()}
      */
-    CompletableFuture<Boolean> loadAllGroups();
+    @Deprecated
+    @NonNull CompletableFuture<Boolean> loadAllGroups();
 
     /**
-     * Saves a group back to storage. You should call this after you make any changes to a group.
+     * 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)}
      */
-    CompletableFuture<Boolean> saveGroup(Group group);
+    @Deprecated
+    @NonNull CompletableFuture<Boolean> saveGroup(@NonNull Group group);
 
     /**
      * Permanently deletes a group from storage.
@@ -179,8 +197,10 @@ public interface Storage {
      * @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)}
      */
-    CompletableFuture<Boolean> deleteGroup(Group group);
+    @Deprecated
+    @NonNull CompletableFuture<Boolean> deleteGroup(@NonNull Group group);
 
     /**
      * Searches for a list of groups with a given permission.
@@ -189,8 +209,10 @@ public interface Storage {
      * @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)}
      */
-    CompletableFuture<List<HeldPermission<String>>> getGroupsWithPermission(String permission);
+    @Deprecated
+    @NonNull CompletableFuture<List<HeldPermission<String>>> getGroupsWithPermission(@NonNull String permission);
 
     /**
      * Creates and loads a track into the plugins local storage
@@ -199,8 +221,10 @@ public interface Storage {
      * @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)}
      */
-    CompletableFuture<Boolean> createAndLoadTrack(String name);
+    @Deprecated
+    @NonNull CompletableFuture<Boolean> createAndLoadTrack(@NonNull String name);
 
     /**
      * Loads a track into the plugins local storage.
@@ -209,15 +233,19 @@ public interface Storage {
      * @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)}
      */
-    CompletableFuture<Boolean> loadTrack(String name);
+    @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()}
      */
-    CompletableFuture<Boolean> loadAllTracks();
+    @Deprecated
+    @NonNull CompletableFuture<Boolean> loadAllTracks();
 
     /**
      * Saves a track back to storage. You should call this after you make any changes to a track.
@@ -226,8 +254,10 @@ public interface Storage {
      * @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)}
      */
-    CompletableFuture<Boolean> saveTrack(Track track);
+    @Deprecated
+    @NonNull CompletableFuture<Boolean> saveTrack(@NonNull Track track);
 
     /**
      * Permanently deletes a track from storage
@@ -236,8 +266,10 @@ public interface Storage {
      * @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)}
      */
-    CompletableFuture<Boolean> deleteTrack(Track track);
+    @Deprecated
+    @NonNull CompletableFuture<Boolean> deleteTrack(@NonNull Track track);
 
     /**
      * Saves UUID caching data to the global cache
@@ -247,8 +279,9 @@ public interface Storage {
      * @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)}
      */
-    CompletableFuture<Boolean> saveUUIDData(String username, UUID uuid);
+    @NonNull CompletableFuture<Boolean> saveUUIDData(@NonNull String username, @NonNull UUID uuid);
 
     /**
      * Gets a UUID from a username
@@ -257,8 +290,9 @@ public interface Storage {
      * @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)}
      */
-    CompletableFuture<UUID> getUUID(String username);
+    @NonNull CompletableFuture<UUID> getUUID(@NonNull String username);
 
     /**
      * Gets a username from a UUID
@@ -267,7 +301,32 @@ public interface Storage {
      * @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)}
      */
-    CompletableFuture<String> getName(UUID 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/TemporaryDataMutateResult.java

@@ -0,0 +1,55 @@
+/*
+ * 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;
+
+/**
+ * Extension of {@link DataMutateResult} for temporary set operations.
+ *
+ * @since 4.3
+ */
+public interface TemporaryDataMutateResult {
+
+    /**
+     * Gets the underlying result.
+     *
+     * @return the result
+     */
+    @NonNull DataMutateResult getResult();
+
+    /**
+     * Gets the node that resulted from any {@link TemporaryMergeBehaviour}
+     * processing.
+     *
+     * <p>If no processing took place, the same instance will be returned by
+     * this method.</p>
+     *
+     * @return the resultant node
+     */
+    @NonNull Node getMergedNode();
+
+}

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

@@ -0,0 +1,58 @@
+/*
+ * 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;
+
+/**
+ * Controls how the implementation should behave when new temporary nodes are set
+ * that would otherwise conflict with existing entries.
+ *
+ * <p>The default behaviour of {@link PermissionHolder#setPermission(Node)} is
+ * to return a result of {@link DataMutateResult#ALREADY_HAS} when an equivalent
+ * node is found. This can be replicated using {@link #FAIL_WITH_ALREADY_HAS}.</p>
+ *
+ * <p>However, the {@link PermissionHolder#setPermission(Node, TemporaryMergeBehaviour)}
+ * method allows this behaviour to be customized for temporary permissions.</p>
+ *
+ * @since 4.3
+ */
+public enum TemporaryMergeBehaviour {
+
+    /**
+     * Expiry durations will be added to the existing expiry time of a permission.
+     */
+    ADD_NEW_DURATION_TO_EXISTING,
+
+    /**
+     * Expiry durations will be replaced if the new duration is longer than the current one.
+     */
+    REPLACE_EXISTING_IF_DURATION_LONGER,
+
+    /**
+     * The operation will fail if an existing temporary node is present.
+     */
+    FAIL_WITH_ALREADY_HAS
+
+}

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

@@ -1,5 +1,8 @@
 /*
- * Copyright (c) 2016 Lucko (Luck) <luck@lucko.me>
+ * 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
@@ -22,30 +25,35 @@
 
 package me.lucko.luckperms.api;
 
-import me.lucko.luckperms.exceptions.ObjectAlreadyHasException;
-import me.lucko.luckperms.exceptions.ObjectLacksException;
+import me.lucko.luckperms.api.context.ContextSet;
+
+import org.checkerframework.checker.nullness.qual.NonNull;
+import org.checkerframework.checker.nullness.qual.Nullable;
 
 import java.util.List;
 
 /**
- * An ordered collection of groups for easy promotions and demotions
+ * An ordered chain of {@link Group}s.
  */
 public interface Track {
 
     /**
      * Gets the name of this track
+     *
      * @return the name of this track
      */
-    String getName();
+    @NonNull String getName();
 
     /**
-     * Gets an ordered list of the groups on this track
+     * Gets a list of the groups on this track
      *
-     * <p>Index 0 is the first/lowest group in (or start of) the track</p>
+     * <p>Index 0 is the first/lowest group in (or start of) the track.</p>
+     *
+     * <p>The returned collection is immutable, and cannot be modified.</p>
      *
      * @return an ordered {@link List} of the groups on this track
      */
-    List<String> getGroups();
+    @NonNull List<String> getGroups();
 
     /**
      * Gets the number of groups on this track
@@ -57,65 +65,87 @@ public interface Track {
     /**
      * Gets the next group on the track, after the one provided
      *
+     * <p>{@code null} is returned if the group is not on the track.</p>
+     *
      * @param current the group before the group being requested
      * @return the group name, or null if the end of the track has been reached
-     * @throws ObjectLacksException  if the track does not contain the group given
      * @throws NullPointerException  if the group is null
      * @throws IllegalStateException if the group instance was not obtained from LuckPerms.
      */
-    String getNext(Group current) throws ObjectLacksException;
+    @Nullable String getNext(@NonNull Group current);
 
     /**
      * Gets the previous group on the track, before the one provided
      *
+     * <p>{@code null} is returned if the group is not on the track.</p>
+     *
      * @param current the group after the group being requested
      * @return the group name, or null if the start of the track has been reached
-     * @throws ObjectLacksException  if the track does not contain the group given
      * @throws NullPointerException  if the group is null
      * @throws IllegalStateException if the group instance was not obtained from LuckPerms.
      */
-    String getPrevious(Group current) throws ObjectLacksException;
+    @Nullable String getPrevious(@NonNull Group current);
+
+    /**
+     * Promotes the given user along this track.
+     *
+     * @param user       the user to promote
+     * @param contextSet the contexts to promote the user in
+     * @return the result of the action
+     * @since 4.2
+     */
+    @NonNull PromotionResult promote(@NonNull User user, @NonNull ContextSet contextSet);
+
+    /**
+     * Demotes the given user along this track.
+     *
+     * @param user       the user to demote
+     * @param contextSet the contexts to demote the user in
+     * @return the result of the action
+     * @since 4.2
+     */
+    @NonNull DemotionResult demote(@NonNull User user, @NonNull ContextSet contextSet);
 
     /**
      * Appends a group to the end of this track
      *
      * @param group the group to append
-     * @throws ObjectAlreadyHasException if the group is already on this track somewhere
-     * @throws NullPointerException      if the group is null
-     * @throws IllegalStateException     if the group instance was not obtained from LuckPerms.
+     * @return the result of the operation
+     * @throws NullPointerException  if the group is null
+     * @throws IllegalStateException if the group instance was not obtained from LuckPerms.
      */
-    void appendGroup(Group group) throws ObjectAlreadyHasException;
+    @NonNull DataMutateResult appendGroup(@NonNull Group group);
 
     /**
      * Inserts a group at a certain position on this track
      *
      * @param group    the group to be inserted
      * @param position the index position (a value of 0 inserts at the start)
-     * @throws ObjectAlreadyHasException if the group is already on this track somewhere
+     * @return the result of the operation
      * @throws IndexOutOfBoundsException if the position is less than 0 or greater than the size of the track
      * @throws NullPointerException      if the group is null
      * @throws IllegalStateException     if the group instance was not obtained from LuckPerms.
      */
-    void insertGroup(Group group, int position) throws ObjectAlreadyHasException, IndexOutOfBoundsException;
+    @NonNull DataMutateResult insertGroup(@NonNull Group group, int position) throws IndexOutOfBoundsException;
 
     /**
      * Removes a group from this track
      *
      * @param group the group to remove
-     * @throws ObjectLacksException  if the group is not on this track
+     * @return the result of the operation
      * @throws NullPointerException  if the group is null
      * @throws IllegalStateException if the group instance was not obtained from LuckPerms.
      */
-    void removeGroup(Group group) throws ObjectLacksException;
+    @NonNull DataMutateResult removeGroup(@NonNull Group group);
 
     /**
      * Removes a group from this track
      *
      * @param group the group to remove
-     * @throws ObjectLacksException if the group is not on this track
+     * @return the result of the operation
      * @throws NullPointerException if the group is null
      */
-    void removeGroup(String group) throws ObjectLacksException;
+    @NonNull DataMutateResult removeGroup(@NonNull String group);
 
     /**
      * Checks if a group features on this track
@@ -125,7 +155,7 @@ public interface Track {
      * @throws NullPointerException  if the group is null
      * @throws IllegalStateException if the group instance was not obtained from LuckPerms.
      */
-    boolean containsGroup(Group group);
+    boolean containsGroup(@NonNull Group group);
 
     /**
      * Checks if a group features on this track
@@ -134,7 +164,7 @@ public interface Track {
      * @return true if the group is on this track
      * @throws NullPointerException if the group is null
      */
-    boolean containsGroup(String group);
+    boolean containsGroup(@NonNull String group);
 
     /**
      * Clear all of the groups from this track

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

@@ -1,5 +1,8 @@
 /*
- * Copyright (c) 2016 Lucko (Luck) <luck@lucko.me>
+ * 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
@@ -22,37 +25,59 @@
 
 package me.lucko.luckperms.api;
 
+import org.checkerframework.checker.nullness.qual.NonNull;
+
 /**
- * Represents a permission setting.
+ * Represents three different states of a setting.
  *
- * <p>Consider a value of {@link #FALSE} to be a "negated" setting, and a value of {@link #UNDEFINED} to be a
- * non-existent value.</p>
+ * <p>Possible values:</p>
+ * <p></p>
+ * <ul>
+ *     <li>{@link #TRUE} - a positive setting</li>
+ *     <li>{@link #FALSE} - a negative (negated) setting</li>
+ *     <li>{@link #UNDEFINED} - a non-existent setting</li>
+ * </ul>
  */
 public enum Tristate {
 
     /**
-     * A value indicating a holder has a permission set.
+     * A value indicating a positive setting
      */
     TRUE(true),
 
     /**
-     * A value indicating a holder has a negated value for a permission.
+     * A value indicating a negative (negated) setting
      */
     FALSE(false),
 
     /**
-     * A value indicating a holder doesn't have a value for a permission set.
+     * A value indicating a non-existent setting
      */
     UNDEFINED(false);
 
     /**
-     * Converts from {@link Boolean} a boolean
+     * Returns a {@link Tristate} from a boolean
      *
-     * @param b the boolean
-     * @return {@link #TRUE} or {@link #FALSE}, depending on the value of the boolean.
+     * @param val the boolean value
+     * @return {@link #TRUE} or {@link #FALSE}, if the value is <code>true</code> or <code>false</code>, respectively.
      */
-    public static Tristate fromBoolean(boolean b) {
-        return b ? TRUE : FALSE;
+    public static @NonNull Tristate fromBoolean(boolean val) {
+        return val ? TRUE : FALSE;
+    }
+
+    /**
+     * Returns a {@link Tristate} from a nullable boolean.
+     *
+     * <p>Unlike {@link #fromBoolean(boolean)}, this method returns {@link #UNDEFINED}
+     * if the value is null.</p>
+     *
+     * @param val the boolean value
+     * @return {@link #UNDEFINED}, {@link #TRUE} or {@link #FALSE}, if the value
+     *         is <code>null</code>, <code>true</code> or <code>false</code>, respectively.
+     * @since 4.1
+     */
+    public static @NonNull Tristate fromNullableBoolean(Boolean val) {
+        return val == null ? UNDEFINED : val ? TRUE : FALSE;
     }
 
     private final boolean booleanValue;
@@ -69,6 +94,6 @@ public enum Tristate {
      * @return a boolean representation of the Tristate.
      */
     public boolean asBoolean() {
-        return booleanValue;
+        return this.booleanValue;
     }
 }

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

@@ -1,5 +1,8 @@
 /*
- * Copyright (c) 2016 Lucko (Luck) <luck@lucko.me>
+ * 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
@@ -23,15 +26,14 @@
 package me.lucko.luckperms.api;
 
 import me.lucko.luckperms.api.caching.UserData;
-import me.lucko.luckperms.exceptions.ObjectAlreadyHasException;
-import me.lucko.luckperms.exceptions.ObjectLacksException;
 
-import java.util.List;
-import java.util.Optional;
+import org.checkerframework.checker.nullness.qual.NonNull;
+import org.checkerframework.checker.nullness.qual.Nullable;
+
 import java.util.UUID;
 
 /**
- * A player holding permission data
+ * A player which holds permission data.
  */
 public interface User extends PermissionHolder {
 
@@ -40,284 +42,67 @@ public interface User extends PermissionHolder {
      *
      * @return the users Mojang assigned unique id
      */
-    UUID getUuid();
+    @NonNull UUID getUuid();
 
     /**
      * Gets the users username
      *
-     * @return the Users Username
+     * <p>Returns null if no username is known for the user.</p>
+     *
+     * @return the users username
      */
-    String getName();
+    @Nullable String getName();
 
     /**
-     * Gets the users primary group
+     * Gets the users current primary group.
+     *
+     * <p>The result of this method depends on which method is configured for primary group
+     * calculation. It may not be the same as any value set through
+     * {@link #setPrimaryGroup(String)}.</p>
      *
      * @return the users primary group
      */
-    String getPrimaryGroup();
+    @NonNull String getPrimaryGroup();
 
     /**
-     * Sets a users primary group
+     * Sets a users primary group.
+     *
+     * <p>This modifies the "stored value" for the users primary group, which may or may not
+     * actually take effect, depending on how the platform is calculating primary groups.</p>
      *
      * @param group the new primary group
-     * @throws ObjectAlreadyHasException if the user already has this set as their primary group
-     * @throws IllegalStateException     if the user is not a member of that group
-     * @throws NullPointerException      if the group is null
+     * @return if the change was applied successfully
+     * @throws IllegalStateException if the user is not a member of that group
+     * @throws NullPointerException  if the group is null
      */
-    void setPrimaryGroup(String group) throws ObjectAlreadyHasException;
+    @NonNull DataMutateResult setPrimaryGroup(@NonNull String group);
+
+    /**
+     * Gets the user's {@link UserData} cache.
+     *
+     * @return the users cached data.
+     * @since 3.2
+     */
+    @Override
+    @NonNull UserData getCachedData();
 
     /**
      * Refresh and re-assign the users permissions.
      *
-     * <p>This request is not buffered, and the refresh call will be ran directly. This should ideally be called on
-     * an asynchronous thread.</p>
+     * @deprecated Calling this method is no longer necessary. Permissions data is now refreshed on
+     * demand, as changes are made. Consider use of {@link #refreshCachedData()}
+     * instead. This method is now implemented as a no-op.
      */
+    @Deprecated
     void refreshPermissions();
 
     /**
-     * Gets the user's {@link UserData} cache, if they have one setup.
-     *
-     * @return an optional, possibly containing the user's cached lookup data.
-     * @since 2.13
-     */
-    Optional<UserData> getUserDataCache();
-
-    /**
-     * Sets up the users data cache, if the don't have one setup already.
+     * Pre-calculates some values in the user's data cache.
      *
      * @since 2.17
+     * @deprecated Use of this method is no longer necessary. It is implemented as a no-op.
      */
+    @Deprecated
     void setupDataCache();
 
-    /**
-     * Check to see if the user is a member of a group
-     *
-     * @param group The group to check membership of
-     * @return true if the user is a member of the group
-     * @throws NullPointerException if the group is null
-     */
-    boolean isInGroup(Group group);
-
-    /**
-     * Check to see if a user is a member of a group on a specific server
-     *
-     * @param group  The group to check membership of
-     * @param server The server to check on
-     * @return true if the user is a member of the group
-     * @throws NullPointerException     if the group or server is null
-     * @throws IllegalArgumentException if the server is invalid
-     */
-    boolean isInGroup(Group group, String server);
-
-    /**
-     * Check to see if a user is a member of a group on a specific server and world
-     *
-     * @param group  The group to check membership of
-     * @param server The server to check on
-     * @param world  The world to check on
-     * @return true if the user is a member of the group
-     * @throws NullPointerException     if the group, server or world is null
-     * @throws IllegalArgumentException if the server or world is invalid
-     */
-    boolean isInGroup(Group group, String server, String world);
-
-    /**
-     * Add a user to a group
-     *
-     * @param group The group to add the user to
-     * @throws ObjectAlreadyHasException if the user is already a member of the group
-     * @throws NullPointerException      if the group is null
-     * @throws IllegalStateException     if the group instance was not obtained from LuckPerms.
-     * @deprecated in favour of {@link NodeFactory#makeGroupNode(Group)}
-     */
-    @Deprecated
-    void addGroup(Group group) throws ObjectAlreadyHasException;
-
-    /**
-     * Add a user to a group on a specific server
-     *
-     * @param group  The group to add the user to
-     * @param server The server to add the group on
-     * @throws ObjectAlreadyHasException if the user is already a member of the group on that server
-     * @throws NullPointerException      if the group or server is null
-     * @throws IllegalStateException     if the group instance was not obtained from LuckPerms.
-     * @throws IllegalArgumentException  if the server is invalid
-     * @deprecated in favour of {@link NodeFactory#makeGroupNode(Group)}
-     */
-    @Deprecated
-    void addGroup(Group group, String server) throws ObjectAlreadyHasException;
-
-    /**
-     * Add a user to a group on a specific server and world
-     *
-     * @param group  The group to add the user to
-     * @param server The server to add the group on
-     * @param world  The world to add the group on
-     * @throws ObjectAlreadyHasException if the user is already a member of the group on that server
-     * @throws NullPointerException      if the group, server or world is null
-     * @throws IllegalStateException     if the group instance was not obtained from LuckPerms.
-     * @throws IllegalArgumentException  if the server or world is invalid
-     * @deprecated in favour of {@link NodeFactory#makeGroupNode(Group)}
-     */
-    @Deprecated
-    void addGroup(Group group, String server, String world) throws ObjectAlreadyHasException;
-
-    /**
-     * Add a user to a group temporarily on a specific server
-     *
-     * @param group    The group to add the user to
-     * @param expireAt when the group should expire
-     * @throws ObjectAlreadyHasException if the user is already a member of the group on that server
-     * @throws NullPointerException      if the group is null
-     * @throws IllegalStateException     if the group instance was not obtained from LuckPerms.
-     * @throws IllegalArgumentException  if the expiry time is in the past
-     * @deprecated in favour of {@link NodeFactory#makeGroupNode(Group)}
-     */
-    @Deprecated
-    void addGroup(Group group, long expireAt) throws ObjectAlreadyHasException;
-
-    /**
-     * Add a user to a group temporarily on a specific server
-     *
-     * @param group    The group to add the user to
-     * @param server   The server to add the group on
-     * @param expireAt when the group should expire
-     * @throws ObjectAlreadyHasException if the user is already a member of the group on that server
-     * @throws NullPointerException      if the group or server is null
-     * @throws IllegalStateException     if the group instance was not obtained from LuckPerms.
-     * @throws IllegalArgumentException  if the expiry time is in the past or the server is invalid
-     * @deprecated in favour of {@link NodeFactory#makeGroupNode(Group)}
-     */
-    @Deprecated
-    void addGroup(Group group, String server, long expireAt) throws ObjectAlreadyHasException;
-
-    /**
-     * Add a user to a group temporarily on a specific server and world
-     *
-     * @param group    The group to add the user to
-     * @param server   The server to add the group on
-     * @param world    The world to add the group on
-     * @param expireAt when the group should expire
-     * @throws ObjectAlreadyHasException if the user is already a member of the group on that server
-     * @throws NullPointerException      if the group, server or world is null
-     * @throws IllegalStateException     if the group instance was not obtained from LuckPerms.
-     * @throws IllegalArgumentException  if the expiry time is in the past or the server/world is invalid
-     * @deprecated in favour of {@link NodeFactory#makeGroupNode(Group)}
-     */
-    @Deprecated
-    void addGroup(Group group, String server, String world, long expireAt) throws ObjectAlreadyHasException;
-
-    /**
-     * Remove the user from a group
-     *
-     * @param group the group to remove the user from
-     * @throws ObjectLacksException  if the user isn't a member of the group
-     * @throws NullPointerException  if the group is null
-     * @throws IllegalStateException if the group instance was not obtained from LuckPerms.
-     * @deprecated in favour of {@link NodeFactory#makeGroupNode(Group)}
-     */
-    @Deprecated
-    void removeGroup(Group group) throws ObjectLacksException;
-
-    /**
-     * Remove the user from a group
-     *
-     * @param group     the group to remove the user from
-     * @param temporary if the group being removed is temporary
-     * @throws ObjectLacksException  if the user isn't a member of the group
-     * @throws NullPointerException  if the group is null
-     * @throws IllegalStateException if the group instance was not obtained from LuckPerms.
-     * @deprecated in favour of {@link NodeFactory#makeGroupNode(Group)}
-     */
-    @Deprecated
-    void removeGroup(Group group, boolean temporary) throws ObjectLacksException;
-
-    /**
-     * Remove the user from a group on a specific server
-     *
-     * @param group  The group to remove the user from
-     * @param server The server to remove the group on
-     * @throws ObjectLacksException     if the user isn't a member of the group
-     * @throws NullPointerException     if the group or server is null
-     * @throws IllegalStateException    if the group instance was not obtained from LuckPerms.
-     * @throws IllegalArgumentException if the server is invalid
-     * @deprecated in favour of {@link NodeFactory#makeGroupNode(Group)}
-     */
-    @Deprecated
-    void removeGroup(Group group, String server) throws ObjectLacksException;
-
-    /**
-     * Remove the user from a group on a specific server and world
-     *
-     * @param group  The group to remove the user from
-     * @param server The server to remove the group on
-     * @param world  The world to remove the group on
-     * @throws ObjectLacksException     if the user isn't a member of the group
-     * @throws NullPointerException     if the group, server or world is null
-     * @throws IllegalStateException    if the group instance was not obtained from LuckPerms.
-     * @throws IllegalArgumentException if the server or world is invalid
-     * @deprecated in favour of {@link NodeFactory#makeGroupNode(Group)}
-     */
-    @Deprecated
-    void removeGroup(Group group, String server, String world) throws ObjectLacksException;
-
-    /**
-     * Remove the user from a group on a specific server
-     *
-     * @param group     The group to remove the user from
-     * @param server    The server to remove the group on
-     * @param temporary if the group being removed is temporary
-     * @throws ObjectLacksException     if the user isn't a member of the group
-     * @throws NullPointerException     if the group or server is null
-     * @throws IllegalStateException    if the group instance was not obtained from LuckPerms.
-     * @throws IllegalArgumentException if the expiry time is in the past or the server is invalid
-     * @deprecated in favour of {@link NodeFactory#makeGroupNode(Group)}
-     */
-    @Deprecated
-    void removeGroup(Group group, String server, boolean temporary) throws ObjectLacksException;
-
-    /**
-     * Remove the user from a group on a specific server and world
-     *
-     * @param group     The group to remove the user from
-     * @param server    The server to remove the group on
-     * @param world     The world to remove the group on
-     * @param temporary if the group being removed is temporary
-     * @throws ObjectLacksException     if the user isn't a member of the group
-     * @throws NullPointerException     if the group, server or world is null
-     * @throws IllegalStateException    if the group instance was not obtained from LuckPerms.
-     * @throws IllegalArgumentException if the expiry time is in the past or the server/world is invalid
-     * @deprecated in favour of {@link NodeFactory#makeGroupNode(Group)}
-     */
-    @Deprecated
-    void removeGroup(Group group, String server, String world, boolean temporary) throws ObjectLacksException;
-
-    /**
-     * Get a {@link List} of all of the groups the user is a member of, on all servers
-     *
-     * @return a {@link List} of group names
-     */
-    List<String> getGroupNames();
-
-    /**
-     * Get a {@link List} of the groups the user is a member of on a specific server
-     *
-     * @param server the server to check
-     * @param world  the world to check
-     * @return a {@link List} of group names
-     * @throws NullPointerException     if the server or world is null
-     * @throws IllegalArgumentException if the server or world is invalid
-     */
-    List<String> getLocalGroups(String server, String world);
-
-    /**
-     * Get a {@link List} of the groups the user is a member of on a specific server
-     *
-     * @param server the server to check
-     * @return a {@link List} of group names
-     * @throws NullPointerException     if the server is null
-     * @throws IllegalArgumentException if the server is invalid
-     */
-    List<String> getLocalGroups(String server);
-
 }

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

@@ -1,5 +1,8 @@
 /*
- * Copyright (c) 2016 Lucko (Luck) <luck@lucko.me>
+ * 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
@@ -22,37 +25,43 @@
 
 package me.lucko.luckperms.api;
 
+import org.checkerframework.checker.nullness.qual.NonNull;
+
 import java.util.UUID;
 
 /**
- * A UUID cache for online users, between external Mojang UUIDs, and internal LuckPerms UUIDs.
+ * A UUID cache for online users, between external Mojang UUIDs, and internal
+ * LuckPerms UUIDs.
  *
- * <p>This UuidCache is a means of allowing users to have the same internal UUID across a network of offline mode
- * servers or mixed offline mode and online mode servers. Platforms running in offline mode generate a UUID for a
- * user when they first join the server, but this UUID will then not be consistent across the network. LuckPerms will
- * instead check the datastore cache, to get a UUID for a user that is consistent across an entire network.
- *
- * <p>If you want to get a user object from the Storage using the api on a server in offline mode, you will need to use
- * this cache, OR use Storage#getUUID, for users that are not online.
- *
- * <p><strong>This is only effective for online players. Use {@link Storage#getUUID(String)} for offline players.</strong></p>
+ * @deprecated this feature is now handled internally - and the API returns a
+ * No-op implementation of this class.
  */
+@Deprecated
 public interface UuidCache {
 
     /**
-     * Gets a users internal "LuckPerms" UUID, from the one given by the server.
+     * Gets a users "internal" LuckPerms UUID, from the one given by the server.
      *
-     * @param external the UUID assigned by the server, through Player#getUniqueId or ProxiedPlayer#getUniqueId
+     * <p>When <code>use-server-uuids</code> is true, this returns the same UUID
+     * instance.</p>
+     *
+     * @param mojangUuid the UUID assigned by the server, through
+     *                   <code>Player#getUniqueId</code> or
+     *                   <code>ProxiedPlayer#getUniqueId</code>
      * @return the corresponding internal UUID
      */
-    UUID getUUID(UUID external);
+    @Deprecated
+    @NonNull UUID getUUID(@NonNull UUID mojangUuid);
 
     /**
-     * Gets a users external, server assigned or Mojang assigned unique id, from the internal one used within LuckPerms.
+     * Gets a users "external", server assigned unique id, from the internal
+     * one used within LuckPerms.
      *
-     * @param internal the UUID used within LuckPerms, through User#getUuid
+     * @param internalUuid the UUID used within LuckPerms, through
+     *                     <code>User#getUuid</code>
      * @return the corresponding external UUID
      */
-    UUID getExternalUUID(UUID internal);
+    @Deprecated
+    @NonNull UUID getExternalUUID(@NonNull UUID internalUuid);
 
 }

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

@@ -0,0 +1,422 @@
+/*
+ * 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/CachedDataContainer.java

@@ -0,0 +1,46 @@
+/*
+ * 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 org.checkerframework.checker.nullness.qual.NonNull;
+
+/**
+ * Holds cached lookup data in a specific set of contexts.
+ *
+ * @since 4.1
+ */
+public interface CachedDataContainer {
+
+    /**
+     * Gets the contexts this container is holding data for.
+     *
+     * @return the contexts this container is caching
+     */
+    @NonNull Contexts getContexts();
+
+}

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

@@ -1,5 +1,8 @@
 /*
- * Copyright (c) 2016 Lucko (Luck) <luck@lucko.me>
+ * 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
@@ -20,38 +23,23 @@
  *  SOFTWARE.
  */
 
-package me.lucko.luckperms.common.event.impl;
-
-import lombok.AllArgsConstructor;
-import lombok.Getter;
-import lombok.ToString;
+package me.lucko.luckperms.api.caching;
 
+import me.lucko.luckperms.api.Contexts;
 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.node.NodeClearEvent;
-import me.lucko.luckperms.common.event.AbstractEvent;
 
-import java.util.Set;
-
-@Getter
-@ToString
-@AllArgsConstructor
-public class EventNodeClear extends AbstractEvent implements NodeClearEvent {
-
-    private final PermissionHolder target;
-    private final Set<Node> dataBefore;
-    private final Set<Node> dataAfter;
-
-    @Override
-    public boolean isUser() {
-        return target instanceof User;
-    }
-
-    @Override
-    public boolean isGroup() {
-        return target instanceof 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

@@ -0,0 +1,117 @@
+/*
+ * 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,5 +1,8 @@
 /*
- * Copyright (c) 2016 Lucko (Luck) <luck@lucko.me>
+ * 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
@@ -22,22 +25,53 @@
 
 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
+ * Holds cached meta lookup data for a specific set of contexts.
  *
  * @since 2.13
  */
-public interface MetaData {
+public interface MetaData extends CachedDataContainer {
 
     /**
-     * Gets an immutable copy of the meta this user has
+     * 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
      */
-    Map<String, String> getMeta();
+    @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
@@ -45,7 +79,7 @@ public interface MetaData {
      *
      * @return a sorted map of prefixes
      */
-    SortedMap<Integer, String> getPrefixes();
+    @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
@@ -53,20 +87,36 @@ public interface MetaData {
      *
      * @return a sorted map of suffixes
      */
-    SortedMap<Integer, String> getSuffixes();
+    @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
      */
-    String getPrefix();
+    @Nullable String getPrefix();
 
     /**
      * Gets the user's highest priority suffix, or null if the user has no suffixes
      *
      * @return a suffix string, or null
      */
-    String getSuffix();
+    @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/caching/PermissionData.java

@@ -1,5 +1,8 @@
 /*
- * Copyright (c) 2016 Lucko (Luck) <luck@lucko.me>
+ * 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
@@ -24,23 +27,25 @@ package me.lucko.luckperms.api.caching;
 
 import me.lucko.luckperms.api.Tristate;
 
+import org.checkerframework.checker.nullness.qual.NonNull;
+
 import java.util.Map;
 
 /**
- * Holds cached Permission lookup data for a specific set of contexts
+ * Holds cached permission lookup data for a specific set of contexts.
  *
  * @since 2.13
  */
-public interface PermissionData {
+public interface PermissionData extends CachedDataContainer {
 
     /**
-     * Gets a permission value for the given permission node
+     * Gets a permission check result for the given permission node.
      *
      * @param permission the permission node
      * @return a tristate result
      * @throws NullPointerException if permission is null
      */
-    Tristate getPermissionValue(String permission);
+    @NonNull Tristate getPermissionValue(@NonNull String permission);
 
     /**
      * Invalidates the underlying permission calculator cache.
@@ -54,6 +59,6 @@ public interface PermissionData {
      *
      * @return an immutable set of permissions
      */
-    Map<String, Boolean> getImmutableBacking();
+    @NonNull Map<String, Boolean> getImmutableBacking();
 
 }

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

@@ -1,5 +1,8 @@
 /*
- * Copyright (c) 2016 Lucko (Luck) <luck@lucko.me>
+ * 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
@@ -23,114 +26,20 @@
 package me.lucko.luckperms.api.caching;
 
 import me.lucko.luckperms.api.Contexts;
-
-import java.util.Set;
+import me.lucko.luckperms.api.User;
 
 /**
- * Holds cached permission and meta lookup data for a {@link me.lucko.luckperms.api.User}.
+ * Holds cached permission and meta lookup data for a {@link User}.
  *
- * <p>Data is only likely to be available for online users. 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>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 2.13
  */
-public interface UserData {
-
-    /**
-     * Gets PermissionData from the cache, given a specified context.
-     *
-     * <p>If the data is not cached, it is calculated. Therefore, this call could be costly.</p>
-     *
-     * @param contexts the contexts to get the permission data in
-     * @return a permission data instance
-     * @throws NullPointerException if contexts is null
-     */
-    PermissionData getPermissionData(Contexts contexts);
-
-    /**
-     * Gets MetaData from the cache, given a specified context.
-     *
-     * <p>If the data is not cached, it is calculated. Therefore, this call could be costly.</p>
-     *
-     * @param contexts the contexts to get the permission data in
-     * @return a meta data instance
-     * @throws NullPointerException if contexts is null
-     */
-    MetaData getMetaData(Contexts contexts);
-
-    /**
-     * Calculates permission data, bypassing the cache.
-     *
-     * @param contexts the contexts to get permission data in
-     * @return a permission data instance
-     * @throws NullPointerException if contexts is null
-     */
-    PermissionData calculatePermissions(Contexts contexts);
-
-    /**
-     * Calculates meta data, bypassing the cache.
-     *
-     * @param contexts the contexts to get meta data in
-     * @return a meta data instance
-     * @throws NullPointerException if contexts is null
-     */
-    MetaData calculateMeta(Contexts contexts);
-
-    /**
-     * Calculates permission data and stores it in the cache.
-     *
-     * <p>If there is already data cached for the given contexts, and if the resultant output is different,
-     * the cached value is updated.</p>
-     *
-     * @param contexts the contexts to recalculate in.
-     * @throws NullPointerException if contexts is null
-     */
-    void recalculatePermissions(Contexts contexts);
-
-    /**
-     * Calculates meta data and stores it in the cache.
-     *
-     * <p>If there is already data cached for the given contexts, and if the resultant output is different,
-     * the cached value is updated.</p>
-     *
-     * @param contexts the contexts to recalculate in.
-     * @throws NullPointerException if contexts is null
-     */
-    void recalculateMeta(Contexts contexts);
-
-    /**
-     * Calls {@link #recalculatePermissions(Contexts)} for all current loaded contexts
-     */
-    void recalculatePermissions();
-
-    /**
-     * Calls {@link #recalculateMeta(Contexts)} for all current loaded contexts
-     */
-    void recalculateMeta();
-
-    /**
-     * Calls {@link #preCalculate(Contexts)} for the given contexts
-     *
-     * @param contexts a set of contexts
-     * @throws NullPointerException if contexts is null
-     */
-    void preCalculate(Set<Contexts> contexts);
-
-    /**
-     * Ensures that PermissionData and MetaData is cached for a context.
-     *
-     * <p>If the cache does not contain any data for the context, it will be calculated and saved.</p>
-     *
-     * @param contexts the contexts to pre-calculate for
-     * @throws NullPointerException if contexts is null
-     */
-    void preCalculate(Contexts contexts);
-
-    /**
-     * Invalidates all of the underlying Permission calculators.
-     *
-     * <p>Can be called to allow for an update in defaults.</p>
-     */
-    void invalidatePermissionCalculators();
+public interface UserData extends CachedData {
 
 }

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

@@ -0,0 +1,120 @@
+/*
+ * 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.ImmutableSet;
+import com.google.common.collect.Multimap;
+import com.google.common.collect.SetMultimap;
+
+import org.checkerframework.checker.nullness.qual.NonNull;
+
+import java.util.Collection;
+import java.util.Objects;
+import java.util.Set;
+
+abstract class AbstractContextSet implements ContextSet {
+
+    protected abstract SetMultimap<String, String> backing();
+
+    protected abstract void copyTo(SetMultimap<String, String> other);
+
+    @Override
+    public boolean containsKey(@NonNull String key) {
+        return backing().containsKey(sanitizeKey(key));
+    }
+
+    @Override
+    public @NonNull Set<String> getValues(@NonNull String key) {
+        Collection<String> values = backing().asMap().get(sanitizeKey(key));
+        return values != null ? ImmutableSet.copyOf(values) : ImmutableSet.of();
+    }
+
+    @Override
+    public boolean has(@NonNull String key, @NonNull String value) {
+        return backing().containsEntry(sanitizeKey(key), sanitizeValue(value));
+    }
+
+    @Override
+    public boolean isEmpty() {
+        return backing().isEmpty();
+    }
+
+    @Override
+    public int size() {
+        return backing().size();
+    }
+
+    @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> otherContexts;
+
+        if (that instanceof AbstractContextSet) {
+            otherContexts = ((AbstractContextSet) that).backing();
+        } else {
+            otherContexts = that.toMultimap();
+        }
+
+        return backing().equals(otherContexts);
+    }
+
+    @Override
+    public int hashCode() {
+        return backing().hashCode();
+    }
+
+    static String sanitizeKey(String key) {
+        Objects.requireNonNull(key, "key is null");
+        if (stringIsEmpty(key)) {
+            throw new IllegalArgumentException("key is (effectively) empty");
+        }
+        return key.toLowerCase();
+    }
+
+    static String sanitizeValue(String value) {
+        Objects.requireNonNull(value, "value is null");
+        if (stringIsEmpty(value)) {
+            throw new IllegalArgumentException("value is (effectively) empty");
+        }
+        return value.toLowerCase();
+    }
+
+    private static boolean stringIsEmpty(String s) {
+        if (s.isEmpty()) {
+            return true;
+        }
+        for (char c : s.toCharArray()) {
+            if (c != ' ') {
+                return false;
+            }
+        }
+        return true;
+    }
+
+}

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

@@ -1,5 +1,8 @@
 /*
- * Copyright (c) 2016 Lucko (Luck) <luck@lucko.me>
+ * 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
@@ -22,12 +25,15 @@
 
 package me.lucko.luckperms.api.context;
 
+import org.checkerframework.checker.nullness.qual.NonNull;
+
 /**
- * Calculates whether contexts are applicable to {@link T}
+ * 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
  */
+@FunctionalInterface
 public interface ContextCalculator<T> {
 
     /**
@@ -38,6 +44,6 @@ public interface ContextCalculator<T> {
      * @return the map
      * @since 2.13
      */
-    MutableContextSet giveApplicableContext(T subject, MutableContextSet accumulator);
+    @NonNull MutableContextSet giveApplicableContext(@NonNull T subject, @NonNull MutableContextSet accumulator);
 
 }

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

@@ -0,0 +1,166 @@
+/*
+ * 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 me.lucko.luckperms.api.Contexts;
+import me.lucko.luckperms.api.User;
+
+import org.checkerframework.checker.nullness.qual.NonNull;
+
+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
+ * on specific server implementations. In all cases, the "player" or "subject" type for
+ * the platform must be used.
+ *
+ * Specifically:
+ *
+ * <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>
+ * </ul>
+ *
+ * @since 4.0
+ */
+public interface ContextManager {
+
+    /**
+     * Queries the ContextManager for current context values for the subject.
+     *
+     * @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);
+
+    /**
+     * 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 #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);
+
+    /**
+     * Gets the contexts from the static calculators in this manager.
+     *
+     * <p>Static calculators provide the same context for all subjects, and are
+     * marked as such when registered.</p>
+     *
+     * @return the current active static contexts
+     */
+    @NonNull ImmutableContextSet getStaticContext();
+
+    /**
+     * Gets the contexts from the static calculators in this manager.
+     *
+     * <p>Static calculators provide the same context for all subjects, and are
+     * marked as such when registered.</p>
+     *
+     * @return the current active static contexts
+     */
+    @NonNull Contexts getStaticContexts();
+
+    /**
+     * Forms a {@link Contexts} instance from an {@link ImmutableContextSet}.
+     *
+     * <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
+     */
+    @NonNull Contexts formContexts(@NonNull Object subject, @NonNull ImmutableContextSet contextSet);
+
+    /**
+     * Forms a {@link Contexts} instance from an {@link ImmutableContextSet}.
+     *
+     * <p>This method relies on the plugins configuration to form the
+     * {@link Contexts} instance.</p>
+     *
+     * @param contextSet the context set
+     * @return a contexts instance
+     */
+    @NonNull Contexts formContexts(@NonNull ImmutableContextSet contextSet);
+
+    /**
+     * Registers a context calculator with the manager.
+     *
+     * @param calculator the calculator
+     */
+    void registerCalculator(@NonNull ContextCalculator<?> calculator);
+
+    /**
+     * Registers a static context calculator with the manager.
+     *
+     * <p>Static calculators provide the same context for all subjects.</p>
+     *
+     * @param calculator the calculator
+     */
+    void registerStaticCalculator(@NonNull StaticContextCalculator calculator);
+
+    /**
+     * Invalidates the lookup cache for a given subject
+     *
+     * @param subject the subject
+     */
+    void invalidateCache(@NonNull Object subject);
+
+}

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

@@ -1,5 +1,8 @@
 /*
- * Copyright (c) 2016 Lucko (Luck) <luck@lucko.me>
+ * 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
@@ -24,205 +27,287 @@ package me.lucko.luckperms.api.context;
 
 import com.google.common.collect.Multimap;
 
+import org.checkerframework.checker.nullness.qual.NonNull;
+
+import java.util.Iterator;
 import java.util.Map;
+import java.util.Objects;
 import java.util.Optional;
 import java.util.Set;
 
 /**
- * Holder of contexts.
+ * A set of contexts.
  *
- * <p>Implementations may be either mutable or immutable.</p>
+ * <p>Context in the most basic sense simply means the circumstances where
+ * 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>
+ *
+ * <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 {
+public interface ContextSet extends Iterable<Map.Entry<String, String>> {
 
     /**
-     * Creates an ImmutableContextSet from a context pair
+     * Creates an {@link ImmutableContextSet} from a context pair.
      *
      * @param key   the key
      * @param value the value
-     * @return a new ImmutableContextSet containing one KV pair
+     * @return a new ImmutableContextSet containing one context pair
      * @throws NullPointerException if key or value is null
      */
-    static ImmutableContextSet singleton(String key, String value) {
+    static @NonNull ImmutableContextSet singleton(@NonNull String key, @NonNull String value) {
         return ImmutableContextSet.singleton(key, value);
     }
 
     /**
-     * Creates an ImmutableContextSet from two context pairs
+     * Creates an {@link ImmutableContextSet} from two context pairs.
      *
-     * @param key1 the first key
+     * @param key1   the first key
      * @param value1 the first value
-     * @param key2 the second key
+     * @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 ImmutableContextSet of(String key1, String value1, String key2, String value2) {
+    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 ImmutableContextSet from an existing 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 ImmutableContextSet fromMap(Map<String, String> map) {
-        return ImmutableContextSet.fromMap(map);
-    }
-
-    /**
-     * Creates an ImmutableContextSet from an existing iterable of Map Entries
+     * 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 ImmutableContextSet fromEntries(Iterable<? extends Map.Entry<String, String>> iterable) {
+    static @NonNull ImmutableContextSet fromEntries(@NonNull Iterable<? extends Map.Entry<String, String>> iterable) {
         return ImmutableContextSet.fromEntries(iterable);
     }
 
     /**
-     * Creates an ImmutableContextSet from an existing multimap
+     * 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 ImmutableContextSet fromMultimap(Multimap<String, String> multimap) {
+    static @NonNull ImmutableContextSet fromMultimap(@NonNull Multimap<String, String> multimap) {
         return ImmutableContextSet.fromMultimap(multimap);
     }
 
     /**
-     * Creates an new ImmutableContextSet from an existing set.
-     * Only really useful for converting between mutable and immutable types.
+     * 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 ImmutableContextSet fromSet(ContextSet contextSet) {
+    static @NonNull ImmutableContextSet fromSet(@NonNull ContextSet contextSet) {
         return ImmutableContextSet.fromSet(contextSet);
     }
 
     /**
-     * Creates a new empty ImmutableContextSet.
+     * Returns an empty {@link ImmutableContextSet}.
      *
-     * @return a new ImmutableContextSet
+     * @return an empty ImmutableContextSet
      */
-    static ImmutableContextSet empty() {
+    static @NonNull ImmutableContextSet empty() {
         return ImmutableContextSet.empty();
     }
 
     /**
-     * Check to see if this set is in an immutable form
+     * Gets if this {@link ContextSet} is immutable.
+     *
+     * <p>The state of immutable instances will never change.</p>
      *
      * @return true if the set is immutable
      */
     boolean isImmutable();
 
     /**
-     * If the set is mutable, this method will return an immutable copy. Otherwise just returns itself.
+     * Returns an immutable representation of this {@link ContextSet}.
      *
-     * @return an immutable ContextSet
+     * <p>If the set is already immutable, the same object will be returned.
+     * If the set is mutable, an immutable copy will be made.</p>
+     *
+     * @return an immutable representation of this set
      */
-    ImmutableContextSet makeImmutable();
+    @NonNull ImmutableContextSet makeImmutable();
 
     /**
-     * Creates a mutable copy of this set.
+     * Creates a mutable copy of this {@link ContextSet}.
+     *
+     * <p>A new copy is returned regardless of the
+     * {@link #isImmutable() mutability} of this set.</p>
      *
      * @return a mutable ContextSet
      * @since 2.16
      */
-    MutableContextSet mutableCopy();
+    @NonNull MutableContextSet mutableCopy();
 
     /**
-     * Converts this ContextSet to an immutable {@link Set} of {@link Map.Entry}s.
+     * Returns a {@link Set} of {@link Map.Entry}s 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 an immutable set
      */
-    Set<Map.Entry<String, String>> toSet();
+    @NonNull Set<Map.Entry<String, String>> toSet();
 
     /**
-     * Converts this ContextSet to an immutable {@link Map}
+     * Returns a {@link Map} <b>loosely</b> representing the current state of
+     * this {@link ContextSet}.
      *
-     * <b>NOTE: Use of this method may result in data being lost. ContextSets can contain lots of different values for
-     * one key.</b>
+     * <p>The returned map is immutable, and is a copy of the current set.
+     * (will not update live)</p>
+     *
+     * <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
      */
-    Map<String, String> toMap();
+    @Deprecated
+    @NonNull Map<String, String> toMap();
 
     /**
-     * Converts this ContextSet to an immutable {@link Multimap}
+     * 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
      */
-    Multimap<String, String> toMultimap();
+    @NonNull Multimap<String, String> toMultimap();
 
     /**
-     * Check if the set contains at least one value for the given key.
+     * Returns an {@link Iterator} over each of the context pairs in this set.
+     *
+     * <p>The returned iterator represents the state of the set at the time of creation. It is not
+     * updated as the set changes.</p>
+     *
+     * <p>The iterator does not support {@link Iterator#remove()} calls.</p>
+     *
+     * @return an iterator
+     */
+    @Override
+    @NonNull Iterator<Map.Entry<String, String>> iterator();
+
+    /**
+     * Returns if the {@link ContextSet} contains at least one value for the
+     * given key.
      *
      * @param key the key to check for
      * @return true if the set contains a value for the key
      * @throws NullPointerException if the key is null
      */
-    boolean containsKey(String key);
+    boolean containsKey(@NonNull String key);
 
     /**
-     * Gets a set of all of the values mapped to the given key
+     * Returns a {@link Set} of the values mapped to the given key.
      *
-     * @param key the key to find values for
+     * <p>The returned set is immutable, and only represents the current state
+     * of the {@link ContextSet}. (will not update live)</p>
+     *
+     * @param key the key to get values for
      * @return a set of values
      * @throws NullPointerException if the key is null
      */
-    Set<String> getValues(String key);
+    @NonNull Set<String> getValues(@NonNull String key);
 
     /**
-     * Returns any value from this set matching the key, if present.
+     * Returns any value from this {@link ContextSet} matching the key, if present.
+     *
+     * <p>Note that context keys can be mapped to multiple values.
+     * Use {@link #getValues(String)} to retrieve all associated values.</p>
      *
      * @param key the key to find values for
      * @return an optional containing any match
      * @since 3.1
      */
-    default Optional<String> getAnyValue(String key) {
+    default @NonNull Optional<String> getAnyValue(@NonNull String key) {
         return getValues(key).stream().findAny();
     }
 
     /**
-     * Check if thr set contains a given key mapped to a given value
-     *
-     * @param key   the key to look for
-     * @param value the value to look for (case sensitive)
-     * @return true if the set contains the KV pair
-     * @throws NullPointerException if the key or value is null
-     */
-    boolean has(String key, String value);
-
-    /**
-     * Same as {@link #has(String, String)}, except ignores the case of the value.
+     * Returns if the {@link ContextSet} contains a given context pairing.
      *
      * @param key   the key to look for
      * @param value the value to look for
-     * @return true if the set contains the KV pair
+     * @return true if the set contains the context pair
      * @throws NullPointerException if the key or value is null
      */
-    boolean hasIgnoreCase(String key, String value);
+    boolean has(@NonNull String key, @NonNull String value);
 
     /**
-     * Checks to see if all entries in this context set are also included in another set.
+     * Returns if the {@link ContextSet} contains a given context pairing.
+     *
+     * @param entry the entry to look for
+     * @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) {
+        Objects.requireNonNull(entry, "entry");
+        return has(entry.getKey(), entry.getValue());
+    }
+
+    /**
+     * Returns if this {@link ContextSet} is fully "satisfied" by another set.
+     *
+     * <p>For a context set to "satisfy" another, it must itself contain all of
+     * the context pairings in the other set.</p>
+     *
+     * <p>Mathematically, this method returns true if this set is a <b>subset</b> of the other.</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
      */
-    default boolean isSatisfiedBy(ContextSet 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;
@@ -234,25 +319,24 @@ public interface ContextSet {
             return false;
         } else {
             // neither are empty, we need to compare the individual entries
-            for (Map.Entry<String, String> pair : toSet()) {
-                if (!other.has(pair.getKey(), pair.getValue())) {
+            for (Map.Entry<String, String> context : toSet()) {
+                if (!other.has(context)) {
                     return false;
                 }
             }
-
             return true;
         }
     }
 
     /**
-     * Check if the set is empty
+     * Returns if the {@link ContextSet} is empty.
      *
      * @return true if the set is empty
      */
     boolean isEmpty();
 
     /**
-     * Gets the number of key-value context pairs in the set
+     * Gets the number of context pairs in the {@link ContextSet}.
      *
      * @return the size of the set
      */

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

@@ -1,5 +1,8 @@
 /*
- * Copyright (c) 2016 Lucko (Luck) <luck@lucko.me>
+ * 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
@@ -23,44 +26,50 @@
 package me.lucko.luckperms.api.context;
 
 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.SetMultimap;
 
-import java.util.Collection;
+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 implements ContextSet {
+public final class ImmutableContextSet extends AbstractContextSet implements ContextSet {
     private static final ImmutableContextSet EMPTY = new ImmutableContextSet(ImmutableSetMultimap.of());
 
     /**
-     * Creates an ImmutableContextSet from a context pair
+     * Creates an {@link ImmutableContextSet.Builder}.
      *
-     * @param key   the key
-     * @param value the value
-     * @return a new ImmutableContextSet containing one KV pair
-     * @throws NullPointerException if key or value is null
+     * @return a new ImmutableContextSet builder
+     * @since 4.1
      */
-    public static ImmutableContextSet singleton(String key, String value) {
-        if (key == null) {
-            throw new NullPointerException("key");
-        }
-        if (value == null) {
-            throw new NullPointerException("value");
-        }
-
-        return new ImmutableContextSet(ImmutableSetMultimap.of(key.toLowerCase(), value));
+    public static @NonNull Builder builder() {
+        return new Builder();
     }
 
     /**
-     * Creates an ImmutableContextSet from two context pairs
+     * 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
@@ -70,98 +79,92 @@ public final class ImmutableContextSet implements ContextSet {
      * @throws NullPointerException if any of the keys or values are null
      * @since 3.1
      */
-    public static ImmutableContextSet of(String key1, String value1, String key2, String value2) {
-        if (key1 == null) {
-            throw new NullPointerException("key1");
-        }
-        if (value1 == null) {
-            throw new NullPointerException("value1");
-        }
-        if (key2 == null) {
-            throw new NullPointerException("key2");
-        }
-        if (value2 == null) {
-            throw new NullPointerException("value2");
-        }
-
-        return new ImmutableContextSet(ImmutableSetMultimap.of(key1.toLowerCase(), value1, key2.toLowerCase(), value2));
+    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 ImmutableContextSet from an existing 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 ImmutableContextSet fromMap(Map<String, String> map) {
-        if (map == null) {
-            throw new NullPointerException("map");
-        }
-
-        ImmutableSetMultimap.Builder<String, String> b = ImmutableSetMultimap.builder();
-        for (Map.Entry<String, String> e : map.entrySet()) {
-            b.put(e.getKey().toLowerCase(), e.getValue());
-        }
-
-        return new ImmutableContextSet(b.build());
-    }
-
-    /**
-     * Creates an ImmutableContextSet from an existing iterable of Map Entries
+     * 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 ImmutableContextSet fromEntries(Iterable<? extends Map.Entry<String, String>> iterable) {
-        if (iterable == null) {
-            throw new NullPointerException("iterable");
+    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 MutableContextSet.fromEntries(iterable).makeImmutable();
+        return builder.build();
     }
 
     /**
-     * Creates an ImmutableContextSet from an existing multimap
+     * 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 ImmutableContextSet fromMultimap(Multimap<String, String> multimap) {
-        if (multimap == null) {
-            throw new NullPointerException("multimap");
-        }
-
-        return MutableContextSet.fromMultimap(multimap).makeImmutable();
+    public static @NonNull ImmutableContextSet fromMultimap(@NonNull Multimap<String, String> multimap) {
+        return fromEntries(Objects.requireNonNull(multimap, "multimap").entries());
     }
 
     /**
-     * Creates a new ImmutableContextSet from an existing set.
-     * Only really useful for converting between mutable and immutable types.
+     * 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 ImmutableContextSet fromSet(ContextSet contextSet) {
-        return contextSet.makeImmutable();
+    public static @NonNull ImmutableContextSet fromSet(@NonNull ContextSet contextSet) {
+        return Objects.requireNonNull(contextSet, "contextSet").makeImmutable();
     }
 
     /**
-     * Creates an new empty ContextSet.
+     * Returns an empty {@link ImmutableContextSet}.
      *
-     * @return a new ContextSet
+     * @return an empty ImmutableContextSet
      */
-    public static ImmutableContextSet empty() {
+    public static @NonNull ImmutableContextSet empty() {
         return EMPTY;
     }
 
-    private final SetMultimap<String, String> map;
+    private final ImmutableSetMultimap<String, String> map;
+    private final int hashCode;
 
-    ImmutableContextSet(Multimap<String, String> contexts) {
-        this.map = ImmutableSetMultimap.copyOf(contexts);
+    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
@@ -169,118 +172,183 @@ public final class ImmutableContextSet implements ContextSet {
         return true;
     }
 
-    @Override
-    @Deprecated // This set is already immutable!
-    public ImmutableContextSet makeImmutable() {
+    @Deprecated
+    @Override // This set is already immutable!
+    public @NonNull ImmutableContextSet makeImmutable() {
         return this;
     }
 
     @Override
-    public MutableContextSet mutableCopy() {
+    public @NonNull MutableContextSet mutableCopy() {
         return MutableContextSet.fromSet(this);
     }
 
     @Override
-    public Set<Map.Entry<String, String>> toSet() {
-        return ImmutableSet.copyOf(map.entries());
+    public @NonNull Set<Map.Entry<String, String>> toSet() {
+        return this.map.entries();
     }
 
+    @Deprecated
     @Override
-    public Map<String, String> toMap() {
+    public @NonNull Map<String, String> toMap() {
         ImmutableMap.Builder<String, String> m = ImmutableMap.builder();
-        for (Map.Entry<String, String> e : map.entries()) {
+        for (Map.Entry<String, String> e : this.map.entries()) {
             m.put(e.getKey(), e.getValue());
         }
-
         return m.build();
     }
 
     @Override
-    public Multimap<String, String> toMultimap() {
-        return map;
+    public @NonNull Multimap<String, String> toMultimap() {
+        return this.map;
     }
 
     @Override
-    public boolean containsKey(String key) {
-        if (key == null) {
-            throw new NullPointerException("key");
-        }
-
-        return map.containsKey(key);
+    public @NonNull Iterator<Map.Entry<String, String>> iterator() {
+        return this.map.entries().iterator();
     }
 
     @Override
-    public Set<String> getValues(String key) {
-        if (key == null) {
-            throw new NullPointerException("key");
-        }
-
-        Collection<String> c = map.get(key);
-        return c != null && !c.isEmpty() ? ImmutableSet.copyOf(c) : ImmutableSet.of();
-    }
-
-    @Override
-    public boolean has(String key, String value) {
-        if (key == null) {
-            throw new NullPointerException("key");
-        }
-        if (value == null) {
-            throw new NullPointerException("value");
-        }
-
-        return map.containsEntry(key, value);
-    }
-
-    @Override
-    public boolean hasIgnoreCase(String key, String value) {
-        if (key == null) {
-            throw new NullPointerException("key");
-        }
-        if (value == null) {
-            throw new NullPointerException("value");
-        }
-
-        Collection<String> c = map.get(key);
-        if (c == null || c.isEmpty()) {
-            return false;
-        }
-
-        for (String val : c) {
-            if (val.equalsIgnoreCase(value)) {
-                return true;
-            }
-        }
-        return false;
-    }
-
-    @Override
-    public boolean isEmpty() {
-        return map.isEmpty();
-    }
-
-    @Override
-    public int size() {
-        return map.size();
-    }
-
-    @Override
-    public boolean equals(Object o) {
-        if (o == this) return true;
-        if (!(o instanceof ContextSet)) return false;
-        final ContextSet other = (ContextSet) o;
-
-        final Multimap<String, String> thisContexts = this.toMultimap();
-        final Multimap<String, String> otherContexts = other.toMultimap();
-        return thisContexts == null ? otherContexts == null : thisContexts.equals(otherContexts);
+    public Spliterator<Map.Entry<String, String>> spliterator() {
+        return this.map.entries().spliterator();
     }
 
     @Override
     public int hashCode() {
-        return 59 + (this.map == null ? 43 : this.map.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,5 +1,8 @@
 /*
- * Copyright (c) 2016 Lucko (Luck) <luck@lucko.me>
+ * 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
@@ -30,40 +33,39 @@ import com.google.common.collect.Multimap;
 import com.google.common.collect.Multimaps;
 import com.google.common.collect.SetMultimap;
 
-import java.util.Collection;
+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 implements ContextSet {
+public final class MutableContextSet extends AbstractContextSet implements ContextSet {
 
     /**
-     * Make a singleton MutableContextSet from a context pair
+     * Creates a {@link MutableContextSet} from a context pair.
      *
      * @param key   the key
      * @param value the value
-     * @return a new MutableContextSet containing one KV pair
+     * @return a new MutableContextSet containing one context pair
      * @throws NullPointerException if key or value is null
      */
-    public static MutableContextSet singleton(String key, String value) {
-        if (key == null) {
-            throw new NullPointerException("key");
-        }
-        if (value == null) {
-            throw new NullPointerException("value");
-        }
-
-        MutableContextSet set = new MutableContextSet();
+    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;
     }
 
     /**
-     * Makes a MutableContextSet from two context pairs
+     * Creates a {@link MutableContextSet} from two context pairs.
      *
      * @param key1 the first key
      * @param value1 the first value
@@ -73,90 +75,82 @@ public final class MutableContextSet implements ContextSet {
      * @throws NullPointerException if any of the keys or values are null
      * @since 3.1
      */
-    public static MutableContextSet of(String key1, String value1, String key2, String value2) {
-        if (key1 == null) {
-            throw new NullPointerException("key1");
-        }
-        if (value1 == null) {
-            throw new NullPointerException("value1");
-        }
-        if (key2 == null) {
-            throw new NullPointerException("key2");
-        }
-        if (value2 == null) {
-            throw new NullPointerException("value2");
-        }
-
-        MutableContextSet ret = singleton(key1, value1);
-        ret.add(key2, value2);
-        return ret;
-    }
-
-    /**
-     * Creates a MutableContextSet from an existing 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 MutableContextSet fromMap(Map<String, String> map) {
-        if (map == null) {
-            throw new NullPointerException("map");
-        }
-
-        MutableContextSet set = new MutableContextSet();
-        set.addAll(map);
+    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 MutableContextSet from an existing iterable of Map Entries
+     * 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 MutableContextSet fromEntries(Iterable<? extends Map.Entry<String, String>> iterable) {
-        if (iterable == null) {
-            throw new NullPointerException("iterable");
-        }
-
-        MutableContextSet set = new MutableContextSet();
+    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 MutableContextSet from an existing multimap
+     * 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 MutableContextSet fromMultimap(Multimap<String, String> multimap) {
-        if (multimap == null) {
-            throw new NullPointerException("multimap");
-        }
-
-        return fromEntries(multimap.entries());
+    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 MutableContextSet from an existing set.
-     * Only really useful for converting between mutable and immutable types.
+     * 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 MutableContextSet fromSet(ContextSet contextSet) {
-        if (contextSet == null) {
-            throw new NullPointerException("contextSet");
-        }
+    public static @NonNull MutableContextSet fromSet(@NonNull ContextSet contextSet) {
+        Objects.requireNonNull(contextSet, "contextSet");
 
-        MutableContextSet set = new MutableContextSet();
-        set.addAll(contextSet.toSet());
-        return set;
+        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;
+        }
     }
 
     /**
@@ -164,7 +158,7 @@ public final class MutableContextSet implements ContextSet {
      *
      * @return a new MutableContextSet
      */
-    public static MutableContextSet create() {
+    public static @NonNull MutableContextSet create() {
         return new MutableContextSet();
     }
 
@@ -174,8 +168,20 @@ public final class MutableContextSet implements ContextSet {
         this.map = Multimaps.synchronizedSetMultimap(HashMultimap.create());
     }
 
-    private MutableContextSet(Multimap<String, String> contexts) {
-        this.map = Multimaps.synchronizedSetMultimap(HashMultimap.create(contexts));
+    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
@@ -184,244 +190,159 @@ public final class MutableContextSet implements ContextSet {
     }
 
     @Override
-    public ImmutableContextSet makeImmutable() {
-        return new ImmutableContextSet(map);
-    }
-
-    @Override
-    public MutableContextSet mutableCopy() {
-        return new MutableContextSet(map);
-    }
-
-    @Override
-    public Set<Map.Entry<String, String>> toSet() {
-        return ImmutableSet.copyOf(map.entries());
-    }
-
-    @Override
-    public Map<String, String> toMap() {
-        ImmutableMap.Builder<String, String> m = ImmutableMap.builder();
-        for (Map.Entry<String, String> e : map.entries()) {
-            m.put(e.getKey(), e.getValue());
+    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 Multimap<String, String> toMultimap() {
-        return ImmutableSetMultimap.copyOf(map);
+    public @NonNull Multimap<String, String> toMultimap() {
+        synchronized (this.map) {
+            return ImmutableSetMultimap.copyOf(this.map);
+        }
     }
 
     @Override
-    public boolean containsKey(String key) {
-        if (key == null) {
-            throw new NullPointerException("key");
-        }
-
-        return map.containsKey(key);
+    public @NonNull Iterator<Map.Entry<String, String>> iterator() {
+        return toSet().iterator();
     }
 
     @Override
-    public Set<String> getValues(String key) {
-        if (key == null) {
-            throw new NullPointerException("key");
-        }
-
-        Collection<String> c = map.get(key);
-        return c != null && !c.isEmpty() ? ImmutableSet.copyOf(c) : ImmutableSet.of();
-    }
-
-    @Override
-    public boolean has(String key, String value) {
-        if (key == null) {
-            throw new NullPointerException("key");
-        }
-        if (value == null) {
-            throw new NullPointerException("value");
-        }
-
-        return map.containsEntry(key, value);
-    }
-
-    @Override
-    public boolean hasIgnoreCase(String key, String value) {
-        if (key == null) {
-            throw new NullPointerException("key");
-        }
-        if (value == null) {
-            throw new NullPointerException("value");
-        }
-
-        Collection<String> c = map.get(key);
-        if (c == null || c.isEmpty()) {
-            return false;
-        }
-
-        for (String val : c) {
-            if (val.equalsIgnoreCase(value)) {
-                return true;
-            }
-        }
-        return false;
-    }
-
-    @Override
-    public boolean isEmpty() {
-        return map.isEmpty();
-    }
-
-    @Override
-    public int size() {
-        return map.size();
+    public Spliterator<Map.Entry<String, String>> spliterator() {
+        return toSet().spliterator();
     }
 
     /**
-     * Adds a new key value pair to the 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
      */
-    public void add(String key, String value) {
-        if (key == null) {
-            throw new NullPointerException("key");
-        }
-        if (value == null) {
-            throw new NullPointerException("value");
-        }
-
-        map.put(key.toLowerCase(), value);
+    public void add(@NonNull String key, @NonNull String value) {
+        this.map.put(sanitizeKey(key), sanitizeValue(value));
     }
 
     /**
-     * Adds a new key value pair to the set
+     * Adds a context to this set.
      *
      * @param entry the entry to add
      * @throws NullPointerException if the entry is null
      */
-    public void add(Map.Entry<String, String> entry) {
-        if (entry == null) {
-            throw new NullPointerException("context");
-        }
-
-        map.put(entry.getKey().toLowerCase(), entry.getValue());
+    public void add(Map.@NonNull Entry<String, String> entry) {
+        Objects.requireNonNull(entry, "entry");
+        add(entry.getKey(), entry.getValue());
     }
 
     /**
-     * Adds an iterable containing contexts to the set
+     * 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(Iterable<? extends Map.Entry<String, String>> iterable) {
-        if (iterable == null) {
-            throw new NullPointerException("iterable");
-        }
-
-        for (Map.Entry<String, String> e : iterable) {
-            this.map.put(e.getKey().toLowerCase(), e.getValue());
+    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 entry set of a map to the set
+     * 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(Map<String, String> map) {
-        if (map == null) {
-            throw new NullPointerException("map");
-        }
-        addAll(map.entrySet());
+    public void addAll(@NonNull Map<String, String> map) {
+        addAll(Objects.requireNonNull(map, "map").entrySet());
     }
 
     /**
-     * Adds of of the values in another ContextSet to this set
+     * 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(ContextSet contextSet) {
-        if (contextSet == null) {
-            throw new NullPointerException("contextSet");
+    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());
         }
-
-        this.map.putAll(contextSet.toMultimap());
     }
 
     /**
-     * Remove a key value pair from this set
-     *
-     * @param key   the key to remove
-     * @param value the value to remove (case sensitive)
-     * @throws NullPointerException if the key or value is null
-     */
-    public void remove(String key, String value) {
-        if (key == null) {
-            throw new NullPointerException("key");
-        }
-        if (value == null) {
-            throw new NullPointerException("value");
-        }
-
-        map.entries().removeIf(entry -> entry.getKey().equals(key) && entry.getValue().equals(value));
-    }
-
-    /**
-     * Same as {@link #remove(String, String)}, except ignores the case of the value
+     * 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 removeIgnoreCase(String key, String value) {
-        if (key == null) {
-            throw new NullPointerException("key");
-        }
-        if (value == null) {
-            throw new NullPointerException("value");
-        }
-
-        map.entries().removeIf(e -> e.getKey().equalsIgnoreCase(key) && e.getValue().equalsIgnoreCase(value));
+    public void remove(@NonNull String key, @NonNull String value) {
+        this.map.remove(sanitizeKey(key), sanitizeValue(value));
     }
 
     /**
-     * Removes all pairs with the given key
+     * 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(String key) {
-        if (key == null) {
-            throw new NullPointerException("key");
-        }
-
-        map.removeAll(key.toLowerCase());
+    public void removeAll(@NonNull String key) {
+        this.map.removeAll(sanitizeKey(key));
     }
 
     /**
-     * Clears the set
+     * Removes all contexts from the set.
      */
     public void clear() {
-        map.clear();
-    }
-
-    @Override
-    public boolean equals(Object o) {
-        if (o == this) return true;
-        if (!(o instanceof ContextSet)) return false;
-        final ContextSet other = (ContextSet) o;
-
-        final Multimap<String, String> thisContexts = this.toMultimap();
-        final Multimap<String, String> otherContexts = other.toMultimap();
-        return thisContexts == null ? otherContexts == null : thisContexts.equals(otherContexts);
-    }
-
-    @Override
-    public int hashCode() {
-        return 59 + (this.map == null ? 43 : this.map.hashCode());
+        this.map.clear();
     }
 
     @Override

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

@@ -0,0 +1,61 @@
+/*
+ * 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 org.checkerframework.checker.nullness.qual.NonNull;
+import org.checkerframework.checker.nullness.qual.Nullable;
+
+/**
+ * Extension of {@link ContextCalculator} which provides the same context
+ * regardless of the subject.
+ *
+ * @since 4.0
+ */
+@FunctionalInterface
+public interface StaticContextCalculator extends ContextCalculator<Object> {
+
+    /**
+     * Adds this calculators context to the given accumulator.
+     *
+     * @param accumulator a map of contexts to add to
+     * @return the map
+     */
+    @NonNull MutableContextSet giveApplicableContext(@NonNull MutableContextSet accumulator);
+
+    /**
+     * Gives the subject all of the applicable contexts they meet
+     *
+     * @param subject     the subject to add contexts to
+     * @param accumulator a map of contexts to add to
+     * @return the map
+     */
+    @Deprecated
+    @Override
+    default @NonNull MutableContextSet giveApplicableContext(@Nullable Object subject, @NonNull MutableContextSet accumulator) {
+        return giveApplicableContext(accumulator);
+    }
+
+}

api/src/main/java/me/lucko/luckperms/api/event/Cancellable.java

@@ -1,5 +1,8 @@
 /*
- * Copyright (c) 2016 Lucko (Luck) <luck@lucko.me>
+ * 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
@@ -22,6 +25,8 @@
 
 package me.lucko.luckperms.api.event;
 
+import org.checkerframework.checker.nullness.qual.NonNull;
+
 import java.util.concurrent.atomic.AtomicBoolean;
 
 /**
@@ -34,6 +39,37 @@ public interface Cancellable {
      *
      * @return the cancellation
      */
-    AtomicBoolean getCancellationState();
+    @NonNull @Param(-1) AtomicBoolean getCancellationState();
+
+    /**
+     * Returns true if the event is currently cancelled.
+     *
+     * @return if the event is cancelled
+     * @since 4.1
+     */
+    default boolean isCancelled() {
+        return getCancellationState().get();
+    }
+
+    /**
+     * Returns true if the event is not currently cancelled.
+     *
+     * @return if the event is not cancelled
+     * @since 4.1
+     */
+    default boolean isNotCancelled() {
+        return !isCancelled();
+    }
+
+    /**
+     * Sets the cancellation state of the event.
+     *
+     * @param cancelled the new state
+     * @return the previous state
+     * @since 4.1
+     */
+    default boolean setCancelled(boolean cancelled) {
+        return getCancellationState().getAndSet(cancelled);
+    }
 
 }

api/src/main/java/me/lucko/luckperms/api/event/EventBus.java

@@ -1,5 +1,8 @@
 /*
- * Copyright (c) 2016 Lucko (Luck) <luck@lucko.me>
+ * 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
@@ -22,33 +25,61 @@
 
 package me.lucko.luckperms.api.event;
 
+import org.checkerframework.checker.nullness.qual.NonNull;
+
 import java.util.Set;
 import java.util.function.Consumer;
 
 /**
- * The LuckPerms event bus. Used for subscribing (or registering listeners) to events.
+ * The LuckPerms event bus.
+ *
+ * <p>Used to subscribe (or "listen") to LuckPerms events.</p>
  *
  * @since 3.0
  */
 public interface EventBus {
 
     /**
-     * Subscribe to an event
+     * Registers a new subscription to the given event.
+     *
+     * <p>The returned {@link EventHandler} 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>
      *
      * @param eventClass the event class
      * @param handler    the event handler
      * @param <T>        the event class
      * @return an event handler instance representing this subscription
      */
-    <T extends LuckPermsEvent> EventHandler<T> subscribe(Class<T> eventClass, Consumer<T> handler);
+    @NonNull <T extends LuckPermsEvent> EventHandler<T> subscribe(@NonNull Class<T> eventClass, @NonNull Consumer<? super T> handler);
 
     /**
-     * Gets a set of all registered handlers for a given event
+     * Registers a new subscription to the given event.
+     *
+     * <p>The returned {@link EventHandler} 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
+     * corresponding plugin is disabled.</p>
+     *
+     * @param <T>        the event class
+     * @param plugin     a plugin instance to bind the subscription to.
+     * @param eventClass the event class
+     * @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);
+
+    /**
+     * Gets a set of all registered handlers for a given event.
      *
      * @param eventClass the event to find handlers for
      * @param <T>        the event class
      * @return an immutable set of event handlers
      */
-    <T extends LuckPermsEvent> Set<EventHandler<T>> getHandlers(Class<T> eventClass);
+    @NonNull <T extends LuckPermsEvent> Set<EventHandler<T>> getHandlers(@NonNull Class<T> eventClass);
 
 }

api/src/main/java/me/lucko/luckperms/api/event/EventHandler.java

@@ -1,5 +1,8 @@
 /*
- * Copyright (c) 2016 Lucko (Luck) <luck@lucko.me>
+ * 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
@@ -22,21 +25,23 @@
 
 package me.lucko.luckperms.api.event;
 
+import org.checkerframework.checker.nullness.qual.NonNull;
+
 import java.util.function.Consumer;
 
 /**
- * Represents a handler for a LuckPerms event
+ * Represents a subscription to a {@link LuckPermsEvent}.
  *
  * @param <T> the event class
  */
-public interface EventHandler<T extends LuckPermsEvent> {
+public interface EventHandler<T extends LuckPermsEvent> extends AutoCloseable {
 
     /**
      * Gets the class this handler is listening to
      *
      * @return the event class
      */
-    Class<T> getEventClass();
+    @NonNull Class<T> getEventClass();
 
     /**
      * Returns true if this handler is active
@@ -57,7 +62,7 @@ public interface EventHandler<T extends LuckPermsEvent> {
      *
      * @return the event consumer
      */
-    Consumer<T> getConsumer();
+    @NonNull Consumer<? super T> getConsumer();
 
     /**
      * Gets the number of times this handler has been called
@@ -66,4 +71,8 @@ public interface EventHandler<T extends LuckPermsEvent> {
      */
     int getCallCount();
 
+    @Override
+    default void close() {
+        unregister();
+    }
 }

api/src/main/java/me/lucko/luckperms/api/event/LuckPermsEvent.java

@@ -1,5 +1,8 @@
 /*
- * Copyright (c) 2016 Lucko (Luck) <luck@lucko.me>
+ * 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
@@ -24,8 +27,10 @@ package me.lucko.luckperms.api.event;
 
 import me.lucko.luckperms.api.LuckPermsApi;
 
+import org.checkerframework.checker.nullness.qual.NonNull;
+
 /**
- * The base event interface
+ * A superinterface for all LuckPerms events.
  *
  * @since 3.0
  */
@@ -36,6 +41,6 @@ public interface LuckPermsEvent {
      *
      * @return the api instance
      */
-    LuckPermsApi getApi();
+    @NonNull LuckPermsApi getApi();
 
 }

api/src/main/java/me/lucko/luckperms/api/event/Param.java

@@ -0,0 +1,49 @@
+/*
+ * 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.event;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+/**
+ * Represents the position of a parameter within an event.
+ *
+ * <p>This is an implementation detail and should not be relied upon.</p>
+ */
+@Target(ElementType.METHOD)
+@Retention(RetentionPolicy.RUNTIME)
+public @interface Param {
+
+    /**
+     * Gets the index of the parameter.
+     *
+     * @return the index
+     */
+    int value();
+
+}

api/src/main/java/me/lucko/luckperms/api/event/Sourced.java

@@ -0,0 +1,49 @@
+/*
+ * 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.event;
+
+import me.lucko.luckperms.api.event.source.Source;
+
+import org.checkerframework.checker.nullness.qual.NonNull;
+
+/**
+ * Represents an event with a {@link Source}.
+ *
+ * @since 4.1
+ */
+public interface Sourced {
+
+    /**
+     * Gets the events source.
+     *
+     * <p>Never returns null. In situations where the source is unknown, a
+     * {@link Source} with type {@link Source.Type#UNKNOWN} is returned.</p>
+     *
+     * @return the source
+     */
+    @NonNull @Param(-1) Source getSource();
+
+}

api/src/main/java/me/lucko/luckperms/api/event/cause/CreationCause.java

@@ -1,5 +1,8 @@
 /*
- * Copyright (c) 2016 Lucko (Luck) <luck@lucko.me>
+ * 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

api/src/main/java/me/lucko/luckperms/api/event/cause/DeletionCause.java

@@ -1,5 +1,8 @@
 /*
- * Copyright (c) 2016 Lucko (Luck) <luck@lucko.me>
+ * 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

api/src/main/java/me/lucko/luckperms/api/event/group/GroupCacheLoadEvent.java

@@ -1,5 +1,8 @@
 /*
- * Copyright (c) 2016 Lucko (Luck) <luck@lucko.me>
+ * 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
@@ -20,23 +23,34 @@
  *  SOFTWARE.
  */
 
-package me.lucko.luckperms.common.event.impl;
-
-import lombok.AllArgsConstructor;
-import lombok.Getter;
-import lombok.ToString;
+package me.lucko.luckperms.api.event.group;
 
 import me.lucko.luckperms.api.Group;
-import me.lucko.luckperms.api.event.cause.CreationCause;
-import me.lucko.luckperms.api.event.group.GroupCreateEvent;
-import me.lucko.luckperms.common.event.AbstractEvent;
+import me.lucko.luckperms.api.caching.GroupData;
+import me.lucko.luckperms.api.event.LuckPermsEvent;
+import me.lucko.luckperms.api.event.Param;
 
-@Getter
-@ToString
-@AllArgsConstructor
-public class EventGroupCreate extends AbstractEvent implements GroupCreateEvent {
+import org.checkerframework.checker.nullness.qual.NonNull;
 
-    private final Group group;
-    private final CreationCause cause;
+/**
+ * Called when a groups {@link GroupData} is loaded.
+ *
+ * @since 4.0
+ */
+public interface GroupCacheLoadEvent extends LuckPermsEvent {
+
+    /**
+     * Gets the group whose data was loaded
+     *
+     * @return the group
+     */
+    @NonNull @Param(0) Group getGroup();
+
+    /**
+     * Gets the data that was loaded
+     *
+     * @return the loaded data
+     */
+    @NonNull @Param(1) GroupData getLoadedData();
 
 }

api/src/main/java/me/lucko/luckperms/api/event/group/GroupCreateEvent.java

@@ -1,5 +1,8 @@
 /*
- * Copyright (c) 2016 Lucko (Luck) <luck@lucko.me>
+ * 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
@@ -24,8 +27,11 @@ package me.lucko.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 org.checkerframework.checker.nullness.qual.NonNull;
+
 /**
  * Called when a group is created
  */
@@ -36,13 +42,13 @@ public interface GroupCreateEvent extends LuckPermsEvent {
      *
      * @return the new group
      */
-    Group getGroup();
+    @NonNull @Param(0) Group getGroup();
 
     /**
      * Gets the cause of the creation
      *
      * @return the cause of the creation
      */
-    CreationCause getCause();
+    @NonNull @Param(1) CreationCause getCause();
 
 }

api/src/main/java/me/lucko/luckperms/api/event/group/GroupDataRecalculateEvent.java

@@ -1,5 +1,8 @@
 /*
- * Copyright (c) 2016 Lucko (Luck) <luck@lucko.me>
+ * 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
@@ -20,21 +23,34 @@
  *  SOFTWARE.
  */
 
-package me.lucko.luckperms.common.event.impl;
-
-import lombok.AllArgsConstructor;
-import lombok.Getter;
-import lombok.ToString;
+package me.lucko.luckperms.api.event.group;
 
 import me.lucko.luckperms.api.Group;
-import me.lucko.luckperms.api.event.group.GroupLoadEvent;
-import me.lucko.luckperms.common.event.AbstractEvent;
+import me.lucko.luckperms.api.caching.GroupData;
+import me.lucko.luckperms.api.event.LuckPermsEvent;
+import me.lucko.luckperms.api.event.Param;
 
-@Getter
-@ToString
-@AllArgsConstructor
-public class EventGroupLoad extends AbstractEvent implements GroupLoadEvent {
+import org.checkerframework.checker.nullness.qual.NonNull;
 
-    private final Group group;
+/**
+ * Called when a groups cached data is refreshed
+ *
+ * @since 4.0
+ */
+public interface GroupDataRecalculateEvent extends LuckPermsEvent {
+
+    /**
+     * Gets the group whose data was recalculated
+     *
+     * @return the group
+     */
+    @NonNull @Param(0) Group getGroup();
+
+    /**
+     * Gets the data that was recalculated
+     *
+     * @return the data
+     */
+    @NonNull @Param(1) GroupData getData();
 
 }

api/src/main/java/me/lucko/luckperms/api/event/group/GroupDeleteEvent.java

@@ -1,5 +1,8 @@
 /*
- * Copyright (c) 2016 Lucko (Luck) <luck@lucko.me>
+ * 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
@@ -24,8 +27,11 @@ package me.lucko.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 org.checkerframework.checker.nullness.qual.NonNull;
+
 import java.util.Set;
 
 /**
@@ -38,20 +44,20 @@ public interface GroupDeleteEvent extends LuckPermsEvent {
      *
      * @return the name of the deleted group
      */
-    String getGroupName();
+    @NonNull @Param(0) String getGroupName();
 
     /**
      * Gets an immutable copy of the groups existing data
      *
      * @return a copy of the groups existing data
      */
-    Set<Node> getExistingData();
+    @NonNull @Param(1) Set<Node> getExistingData();
 
     /**
      * Gets the cause of the deletion
      *
      * @return the cause of the deletion
      */
-    DeletionCause getCause();
+    @NonNull @Param(2) DeletionCause getCause();
 
 }

api/src/main/java/me/lucko/luckperms/api/event/group/GroupLoadAllEvent.java

@@ -1,5 +1,8 @@
 /*
- * Copyright (c) 2016 Lucko (Luck) <luck@lucko.me>
+ * 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

api/src/main/java/me/lucko/luckperms/api/event/group/GroupLoadEvent.java

@@ -1,5 +1,8 @@
 /*
- * Copyright (c) 2016 Lucko (Luck) <luck@lucko.me>
+ * 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
@@ -24,6 +27,9 @@ package me.lucko.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 org.checkerframework.checker.nullness.qual.NonNull;
 
 /**
  * Called when a group is loaded into memory from the storage.
@@ -37,6 +43,6 @@ public interface GroupLoadEvent extends LuckPermsEvent {
      *
      * @return the group that was loaded
      */
-    Group getGroup();
+    @NonNull @Param(0) Group getGroup();
 
 }

api/src/main/java/me/lucko/luckperms/api/event/log/LogBroadcastEvent.java

@@ -1,5 +1,8 @@
 /*
- * Copyright (c) 2016 Lucko (Luck) <luck@lucko.me>
+ * 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
@@ -25,6 +28,9 @@ package me.lucko.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 org.checkerframework.checker.nullness.qual.NonNull;
 
 /**
  * Called when a log entry is about to be sent to notifiable players on the platform
@@ -36,6 +42,37 @@ public interface LogBroadcastEvent extends LuckPermsEvent, Cancellable {
      *
      * @return the log entry to be broadcasted
      */
-    LogEntry getEntry();
+    @NonNull @Param(0) LogEntry getEntry();
+
+    /**
+     * Gets where the log entry originated from.
+     *
+     * @return the origin of the log
+     * @since 3.3
+     */
+    @NonNull @Param(1) Origin getOrigin();
+
+    /**
+     * Represents where a log entry is from
+     *
+     * @since 3.3
+     */
+    enum Origin {
+
+        /**
+         * Marks a log entry which originated from the current server instance
+         */
+        LOCAL,
+
+        /**
+         * Marks a log entry which originated from an API call on the current server instance
+         */
+        LOCAL_API,
+
+        /**
+         * Marks a log entry which was sent to this server via the messaging service
+         */
+        REMOTE
+    }
 
 }

api/src/main/java/me/lucko/luckperms/api/event/log/LogNetworkPublishEvent.java

@@ -0,0 +1,58 @@
+/*
+ * 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.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 org.checkerframework.checker.nullness.qual.NonNull;
+
+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 {
+
+    /**
+     * Gets the ID of the log entry being published
+     *
+     * @return the id of the log entry being published
+     */
+    @NonNull @Param(0) UUID getLogId();
+
+    /**
+     * Gets the log entry to be published
+     *
+     * @return the log entry to be published
+     */
+    @NonNull @Param(1) LogEntry getEntry();
+
+}

api/src/main/java/me/lucko/luckperms/api/event/log/LogNotifyEvent.java

@@ -0,0 +1,90 @@
+/*
+ * 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.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 org.checkerframework.checker.nullness.qual.NonNull;
+
+/**
+ * Called when a log entry is about to be sent to specific notifiable object on
+ * the platform.
+ *
+ * <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 {
+
+    /**
+     * Gets the log entry to be sent
+     *
+     * @return the log entry to be sent
+     */
+    @NonNull @Param(0) LogEntry getEntry();
+
+    /**
+     * Gets where the log entry originated from.
+     *
+     * @return the origin of the log
+     */
+    @NonNull @Param(1) Origin getOrigin();
+
+    /**
+     * Gets the object to be notified.
+     *
+     * @return the object to notify
+     */
+    @NonNull @Param(2) Entity getNotifiable();
+
+    /**
+     * Represents where a log entry is from
+     */
+    enum Origin {
+
+        /**
+         * Marks a log entry which originated from the current server instance
+         */
+        LOCAL,
+
+        /**
+         * Marks a log entry which originated from an API call on the current server instance
+         */
+        LOCAL_API,
+
+        /**
+         * Marks a log entry which was sent to this server via the messaging service
+         */
+        REMOTE
+    }
+
+}

api/src/main/java/me/lucko/luckperms/api/event/log/LogPublishEvent.java

@@ -1,5 +1,8 @@
 /*
- * Copyright (c) 2016 Lucko (Luck) <luck@lucko.me>
+ * 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
@@ -25,6 +28,9 @@ package me.lucko.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 org.checkerframework.checker.nullness.qual.NonNull;
 
 /**
  * Called when a log is about to be published to the storage file/table
@@ -36,6 +42,6 @@ public interface LogPublishEvent extends LuckPermsEvent, Cancellable {
      *
      * @return the log entry to be published
      */
-    LogEntry getEntry();
+    @NonNull @Param(0) LogEntry getEntry();
 
 }

api/src/main/java/me/lucko/luckperms/api/event/log/LogReceiveEvent.java

@@ -1,5 +1,8 @@
 /*
- * Copyright (c) 2016 Lucko (Luck) <luck@lucko.me>
+ * 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
@@ -20,24 +23,35 @@
  *  SOFTWARE.
  */
 
-package me.lucko.luckperms.common.event.impl;
-
-import lombok.AllArgsConstructor;
-import lombok.Getter;
-import lombok.ToString;
+package me.lucko.luckperms.api.event.log;
 
 import me.lucko.luckperms.api.LogEntry;
-import me.lucko.luckperms.api.event.log.LogBroadcastEvent;
-import me.lucko.luckperms.common.event.AbstractEvent;
+import me.lucko.luckperms.api.event.LuckPermsEvent;
+import me.lucko.luckperms.api.event.Param;
 
-import java.util.concurrent.atomic.AtomicBoolean;
+import org.checkerframework.checker.nullness.qual.NonNull;
 
-@Getter
-@ToString
-@AllArgsConstructor
-public class EventLogBroadcast extends AbstractEvent implements LogBroadcastEvent {
+import java.util.UUID;
 
-    private final AtomicBoolean cancellationState;
-    private final LogEntry entry;
+/**
+ * Called when a log entry is received via the MessagingService
+ *
+ * @since 3.3
+ */
+public interface LogReceiveEvent extends LuckPermsEvent {
+
+    /**
+     * Gets the ID of the log entry being received
+     *
+     * @return the id of the log entry being received
+     */
+    @NonNull @Param(0) UUID getLogId();
+
+    /**
+     * Gets the log entry being received
+     *
+     * @return the log entry being received
+     */
+    @NonNull @Param(1) LogEntry getEntry();
 
 }

api/src/main/java/me/lucko/luckperms/api/event/node/NodeAddEvent.java

@@ -1,5 +1,8 @@
 /*
- * Copyright (c) 2016 Lucko (Luck) <luck@lucko.me>
+ * 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
@@ -23,6 +26,9 @@
 package me.lucko.luckperms.api.event.node;
 
 import me.lucko.luckperms.api.Node;
+import me.lucko.luckperms.api.event.Param;
+
+import org.checkerframework.checker.nullness.qual.NonNull;
 
 /**
  * Called when a node is added to a holder
@@ -34,6 +40,6 @@ public interface NodeAddEvent extends NodeMutateEvent {
      *
      * @return the node that was added
      */
-    Node getNode();
+    @NonNull @Param(3) Node getNode();
 
 }

api/src/main/java/me/lucko/luckperms/api/event/node/NodeClearEvent.java

@@ -1,5 +1,8 @@
 /*
- * Copyright (c) 2016 Lucko (Luck) <luck@lucko.me>
+ * 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

api/src/main/java/me/lucko/luckperms/api/event/node/NodeMutateEvent.java

@@ -1,5 +1,8 @@
 /*
- * Copyright (c) 2016 Lucko (Luck) <luck@lucko.me>
+ * 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
@@ -22,9 +25,14 @@
 
 package me.lucko.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 org.checkerframework.checker.nullness.qual.NonNull;
 
 import java.util.Set;
 
@@ -38,21 +46,21 @@ public interface NodeMutateEvent extends LuckPermsEvent {
      *
      * @return the event target
      */
-    PermissionHolder getTarget();
+    @NonNull @Param(0) PermissionHolder getTarget();
 
     /**
      * Gets an immutable copy of the holders data before the change
      *
      * @return the data before the change
      */
-    Set<Node> getDataBefore();
+    @NonNull @Param(1) Set<Node> getDataBefore();
 
     /**
      * Gets an immutable copy of the holders data after the change
      *
      * @return the data after the change
      */
-    Set<Node> getDataAfter();
+    @NonNull @Param(2) Set<Node> getDataAfter();
 
     /**
      * Gets whether the target of this event is a {@link me.lucko.luckperms.api.User}
@@ -61,7 +69,9 @@ public interface NodeMutateEvent extends LuckPermsEvent {
      *
      * @return if the event is targeting a user
      */
-    boolean isUser();
+    default boolean isUser() {
+        return getTarget() instanceof User;
+    }
 
     /**
      * Gets whether the target of this event is a {@link me.lucko.luckperms.api.Group}
@@ -70,6 +80,8 @@ public interface NodeMutateEvent extends LuckPermsEvent {
      *
      * @return if the event is targeting a group
      */
-    boolean isGroup();
+    default boolean isGroup() {
+        return getTarget() instanceof Group;
+    }
 
 }

api/src/main/java/me/lucko/luckperms/api/event/node/NodeRemoveEvent.java

@@ -1,5 +1,8 @@
 /*
- * Copyright (c) 2016 Lucko (Luck) <luck@lucko.me>
+ * 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
@@ -23,6 +26,9 @@
 package me.lucko.luckperms.api.event.node;
 
 import me.lucko.luckperms.api.Node;
+import me.lucko.luckperms.api.event.Param;
+
+import org.checkerframework.checker.nullness.qual.NonNull;
 
 /**
  * Called when a node is removed from a holder
@@ -34,6 +40,6 @@ public interface NodeRemoveEvent extends NodeMutateEvent {
      *
      * @return the node that was removed
      */
-    Node getNode();
+    @NonNull @Param(3) Node getNode();
 
 }

api/src/main/java/me/lucko/luckperms/api/event/player/PlayerDataSaveEvent.java

@@ -0,0 +1,67 @@
+/*
+ * 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.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 org.checkerframework.checker.nullness.qual.NonNull;
+
+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 {
+
+    /**
+     * Gets the unique ID that was saved.
+     *
+     * @return the uuid
+     */
+    @NonNull @Param(0) UUID getUuid();
+
+    /**
+     * Gets the username that was saved.
+     *
+     * @return the username
+     */
+    @NonNull @Param(1) String getUsername();
+
+    /**
+     * Gets the result of the operation.
+     *
+     * @return the result
+     */
+    @NonNull @Param(2) PlayerSaveResult getResult();
+
+}

api/src/main/java/me/lucko/luckperms/api/event/source/EntitySource.java

@@ -0,0 +1,46 @@
+/*
+ * 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.event.source;
+
+import me.lucko.luckperms.api.Entity;
+
+import org.checkerframework.checker.nullness.qual.NonNull;
+
+/**
+ * Represents an {@link Entity} which was the {@link Source} of something.
+ *
+ * @since 4.1
+ */
+public interface EntitySource extends Source {
+
+    /**
+     * Gets the entity.
+     *
+     * @return the entity
+     */
+    @NonNull Entity getEntity();
+
+}

api/src/main/java/me/lucko/luckperms/api/event/source/Source.java

@@ -0,0 +1,66 @@
+/*
+ * 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.event.source;
+
+import me.lucko.luckperms.api.Entity;
+
+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 {
+
+    /**
+     * Gets the source type
+     *
+     * @return the type
+     */
+    @NonNull Type getType();
+
+    /**
+     * Represents a type of source
+     */
+    enum Type {
+
+        /**
+         * Represents an {@link Entity} source
+         *
+         * @see EntitySource
+         */
+        ENTITY,
+
+        /**
+         * Represents an unknown source
+         */
+        UNKNOWN
+    }
+
+}

api/src/main/java/me/lucko/luckperms/api/event/sync/ConfigReloadEvent.java

@@ -1,5 +1,8 @@
 /*
- * Copyright (c) 2016 Lucko (Luck) <luck@lucko.me>
+ * 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

api/src/main/java/me/lucko/luckperms/api/event/sync/PostSyncEvent.java

@@ -1,5 +1,8 @@
 /*
- * Copyright (c) 2016 Lucko (Luck) <luck@lucko.me>
+ * 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

api/src/main/java/me/lucko/luckperms/api/event/sync/PreNetworkSyncEvent.java

@@ -1,5 +1,8 @@
 /*
- * Copyright (c) 2016 Lucko (Luck) <luck@lucko.me>
+ * 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
@@ -24,11 +27,14 @@ package me.lucko.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 org.checkerframework.checker.nullness.qual.NonNull;
 
 import java.util.UUID;
 
 /**
- * Called before a network sync task runs
+ * Called before a received network sync task runs
  */
 public interface PreNetworkSyncEvent extends LuckPermsEvent, Cancellable {
 
@@ -37,6 +43,6 @@ public interface PreNetworkSyncEvent extends LuckPermsEvent, Cancellable {
      *
      * @return the id of the sync request
      */
-    UUID getSyncId();
+    @NonNull @Param(0) UUID getSyncId();
 
 }

api/src/main/java/me/lucko/luckperms/api/event/sync/PreSyncEvent.java

@@ -1,5 +1,8 @@
 /*
- * Copyright (c) 2016 Lucko (Luck) <luck@lucko.me>
+ * 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

api/src/main/java/me/lucko/luckperms/api/event/track/TrackCreateEvent.java

@@ -1,5 +1,8 @@
 /*
- * Copyright (c) 2016 Lucko (Luck) <luck@lucko.me>
+ * 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
@@ -24,8 +27,11 @@ package me.lucko.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 org.checkerframework.checker.nullness.qual.NonNull;
+
 /**
  * Called when a track is created
  */
@@ -36,13 +42,13 @@ public interface TrackCreateEvent extends LuckPermsEvent {
      *
      * @return the new track
      */
-    Track getTrack();
+    @NonNull @Param(0) Track getTrack();
 
     /**
      * Gets the cause of the creation
      *
      * @return the cause of the creation
      */
-    CreationCause getCause();
+    @NonNull @Param(1) CreationCause getCause();
 
 }

api/src/main/java/me/lucko/luckperms/api/event/track/TrackDeleteEvent.java

@@ -1,5 +1,8 @@
 /*
- * Copyright (c) 2016 Lucko (Luck) <luck@lucko.me>
+ * 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
@@ -23,8 +26,11 @@
 package me.lucko.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 org.checkerframework.checker.nullness.qual.NonNull;
+
 import java.util.List;
 
 /**
@@ -37,20 +43,20 @@ public interface TrackDeleteEvent extends LuckPermsEvent {
      *
      * @return the name of the deleted track
      */
-    String getTrackName();
+    @NonNull @Param(0) String getTrackName();
 
     /**
      * Gets an immutable copy of the tracks existing data
      *
      * @return a copy of the tracks existing data
      */
-    List<String> getExistingData();
+    @NonNull @Param(1) List<String> getExistingData();
 
     /**
      * Gets the cause of the deletion
      *
      * @return the cause of the deletion
      */
-    DeletionCause getCause();
+    @NonNull @Param(2) DeletionCause getCause();
 
 }

api/src/main/java/me/lucko/luckperms/api/event/track/TrackLoadAllEvent.java

@@ -1,5 +1,8 @@
 /*
- * Copyright (c) 2016 Lucko (Luck) <luck@lucko.me>
+ * 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

api/src/main/java/me/lucko/luckperms/api/event/track/TrackLoadEvent.java

@@ -1,5 +1,8 @@
 /*
- * Copyright (c) 2016 Lucko (Luck) <luck@lucko.me>
+ * 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
@@ -24,6 +27,9 @@ package me.lucko.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 org.checkerframework.checker.nullness.qual.NonNull;
 
 /**
  * Called when a track is loaded into memory from the storage.
@@ -37,6 +43,6 @@ public interface TrackLoadEvent extends LuckPermsEvent {
      *
      * @return the track that was loaded
      */
-    Track getTrack();
+    @NonNull @Param(0) Track getTrack();
 
 }

api/src/main/java/me/lucko/luckperms/api/event/track/mutate/TrackAddGroupEvent.java

@@ -1,5 +1,8 @@
 /*
- * Copyright (c) 2016 Lucko (Luck) <luck@lucko.me>
+ * 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
@@ -22,6 +25,10 @@
 
 package me.lucko.luckperms.api.event.track.mutate;
 
+import me.lucko.luckperms.api.event.Param;
+
+import org.checkerframework.checker.nullness.qual.NonNull;
+
 /**
  * Called when a group is added to a track
  */
@@ -32,6 +39,6 @@ public interface TrackAddGroupEvent extends TrackMutateEvent {
      *
      * @return the group that was added
      */
-    String getGroup();
+    @NonNull @Param(3) String getGroup();
 
 }

api/src/main/java/me/lucko/luckperms/api/event/track/mutate/TrackClearEvent.java

@@ -1,5 +1,8 @@
 /*
- * Copyright (c) 2016 Lucko (Luck) <luck@lucko.me>
+ * 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

api/src/main/java/me/lucko/luckperms/api/event/track/mutate/TrackMutateEvent.java

@@ -1,5 +1,8 @@
 /*
- * Copyright (c) 2016 Lucko (Luck) <luck@lucko.me>
+ * 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
@@ -24,6 +27,9 @@ package me.lucko.luckperms.api.event.track.mutate;
 
 import me.lucko.luckperms.api.Track;
 import me.lucko.luckperms.api.event.LuckPermsEvent;
+import me.lucko.luckperms.api.event.Param;
+
+import org.checkerframework.checker.nullness.qual.NonNull;
 
 import java.util.List;
 
@@ -37,20 +43,20 @@ public interface TrackMutateEvent extends LuckPermsEvent {
      *
      * @return the track that was mutated
      */
-    Track getTrack();
+    @NonNull @Param(0) Track getTrack();
 
     /**
      * Gets an immutable copy of the tracks data before the change
      *
      * @return the data before the change
      */
-    List<String> getDataBefore();
+    @NonNull @Param(1) List<String> getDataBefore();
 
     /**
      * Gets an immutable copy of the tracks data after the change
      *
      * @return the data after the change
      */
-    List<String> getDataAfter();
+    @NonNull @Param(2) List<String> getDataAfter();
 
 }

api/src/main/java/me/lucko/luckperms/api/event/track/mutate/TrackRemoveGroupEvent.java

@@ -1,5 +1,8 @@
 /*
- * Copyright (c) 2016 Lucko (Luck) <luck@lucko.me>
+ * 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
@@ -22,6 +25,10 @@
 
 package me.lucko.luckperms.api.event.track.mutate;
 
+import me.lucko.luckperms.api.event.Param;
+
+import org.checkerframework.checker.nullness.qual.NonNull;
+
 /**
  * Called when a group is removed from a track
  */
@@ -32,6 +39,6 @@ public interface TrackRemoveGroupEvent extends TrackMutateEvent {
      *
      * @return the group that was removed
      */
-    String getGroup();
+    @NonNull @Param(3) String getGroup();
 
 }

api/src/main/java/me/lucko/luckperms/api/event/user/UserCacheLoadEvent.java

@@ -1,5 +1,8 @@
 /*
- * Copyright (c) 2016 Lucko (Luck) <luck@lucko.me>
+ * 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
@@ -25,9 +28,12 @@ package me.lucko.luckperms.api.event.user;
 import me.lucko.luckperms.api.User;
 import me.lucko.luckperms.api.caching.UserData;
 import me.lucko.luckperms.api.event.LuckPermsEvent;
+import me.lucko.luckperms.api.event.Param;
+
+import org.checkerframework.checker.nullness.qual.NonNull;
 
 /**
- * Called when a users {@link me.lucko.luckperms.api.caching.UserData} is loaded.
+ * Called when a users {@link UserData} is loaded.
  */
 public interface UserCacheLoadEvent extends LuckPermsEvent {
 
@@ -36,13 +42,13 @@ public interface UserCacheLoadEvent extends LuckPermsEvent {
      *
      * @return the user
      */
-    User getUser();
+    @NonNull @Param(0) User getUser();
 
     /**
      * Gets the data that was loaded
      *
      * @return the loaded data
      */
-    UserData getLoadedData();
+    @NonNull @Param(1) UserData getLoadedData();
 
 }

api/src/main/java/me/lucko/luckperms/api/event/user/UserDataRecalculateEvent.java

@@ -1,5 +1,8 @@
 /*
- * Copyright (c) 2016 Lucko (Luck) <luck@lucko.me>
+ * 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
@@ -25,6 +28,9 @@ package me.lucko.luckperms.api.event.user;
 import me.lucko.luckperms.api.User;
 import me.lucko.luckperms.api.caching.UserData;
 import me.lucko.luckperms.api.event.LuckPermsEvent;
+import me.lucko.luckperms.api.event.Param;
+
+import org.checkerframework.checker.nullness.qual.NonNull;
 
 /**
  * Called when a users cached data is refreshed
@@ -36,13 +42,13 @@ public interface UserDataRecalculateEvent extends LuckPermsEvent {
      *
      * @return the user
      */
-    User getUser();
+    @NonNull @Param(0) User getUser();
 
     /**
      * Gets the data that was recalculated
      *
      * @return the data
      */
-    UserData getData();
+    @NonNull @Param(1) UserData getData();
 
 }

api/src/main/java/me/lucko/luckperms/api/event/user/UserFirstLoginEvent.java

@@ -1,5 +1,8 @@
 /*
- * Copyright (c) 2016 Lucko (Luck) <luck@lucko.me>
+ * 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
@@ -23,6 +26,9 @@
 package me.lucko.luckperms.api.event.user;
 
 import me.lucko.luckperms.api.event.LuckPermsEvent;
+import me.lucko.luckperms.api.event.Param;
+
+import org.checkerframework.checker.nullness.qual.NonNull;
 
 import java.util.UUID;
 
@@ -44,13 +50,13 @@ public interface UserFirstLoginEvent extends LuckPermsEvent {
      *
      * @return the uuid of the user
      */
-    UUID getUuid();
+    @NonNull @Param(0) UUID getUuid();
 
     /**
      * Gets the username of the user
      *
      * @return the username of the user
      */
-    String getUsername();
+    @NonNull @Param(1) String getUsername();
 
 }

api/src/main/java/me/lucko/luckperms/api/event/user/UserLoadEvent.java

@@ -1,5 +1,8 @@
 /*
- * Copyright (c) 2016 Lucko (Luck) <luck@lucko.me>
+ * 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
@@ -24,6 +27,9 @@ package me.lucko.luckperms.api.event.user;
 
 import me.lucko.luckperms.api.User;
 import me.lucko.luckperms.api.event.LuckPermsEvent;
+import me.lucko.luckperms.api.event.Param;
+
+import org.checkerframework.checker.nullness.qual.NonNull;
 
 /**
  * Called when a user is loaded into memory from the storage.
@@ -35,6 +41,6 @@ public interface UserLoadEvent extends LuckPermsEvent {
      *
      * @return the user that was loaded
      */
-    User getUser();
+    @NonNull @Param(0) User getUser();
 
 }

api/src/main/java/me/lucko/luckperms/api/event/user/UserLoginProcessEvent.java

@@ -0,0 +1,71 @@
+/*
+ * 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.event.user;
+
+import me.lucko.luckperms.api.User;
+import me.lucko.luckperms.api.event.LuckPermsEvent;
+import me.lucko.luckperms.api.event.Param;
+
+import org.checkerframework.checker.nullness.qual.NonNull;
+
+import java.util.UUID;
+
+/**
+ * Called when LuckPerms has finished processing a certain Player's connection.
+ *
+ * <p>This event will always execute during the platforms async login/auth event.
+ * All handlers will be called instantly.</p>
+ *
+ * <p>This, among other things, allows you to wait until permission data is loaded
+ * for a User during the BungeeCord 'LoginEvent', as event priorities are ignored
+ * by the current implementation.</p>
+ *
+ * @since 3.4
+ */
+public interface UserLoginProcessEvent extends LuckPermsEvent {
+
+    /**
+     * Gets the UUID of the connection which was processed
+     *
+     * @return the uuid of the connection which was processed
+     */
+    @NonNull @Param(0) UUID getUuid();
+
+    /**
+     * Gets the username of the connection which was processed
+     *
+     * @return the username of the connection which was processed
+     */
+    @NonNull @Param(1) String getUsername();
+
+    /**
+     * Gets the resultant User instance which was loaded.
+     *
+     * @return the user instance
+     */
+    @NonNull @Param(2) User getUser();
+
+}

api/src/main/java/me/lucko/luckperms/api/event/user/track/TrackAction.java

@@ -1,5 +1,8 @@
 /*
- * Copyright (c) 2016 Lucko (Luck) <luck@lucko.me>
+ * 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