diff --git a/api/src/main/java/net/luckperms/api/LuckPerms.java b/api/src/main/java/net/luckperms/api/LuckPerms.java index f0fe5bc13..fa7cc2aac 100644 --- a/api/src/main/java/net/luckperms/api/LuckPerms.java +++ b/api/src/main/java/net/luckperms/api/LuckPerms.java @@ -89,7 +89,7 @@ public interface LuckPerms { * Gets the {@link UserManager}, responsible for managing * {@link User} instances. * - *
This manager can be used to retrieve instances of {@link User} by uuid + *
This manager can be used to retrieve instances of {@link User} by UUID * or name, or query all loaded users.
* * @return the user manager diff --git a/api/src/main/java/net/luckperms/api/LuckPermsProvider.java b/api/src/main/java/net/luckperms/api/LuckPermsProvider.java index 0c80b0fd4..99eeadf5b 100644 --- a/api/src/main/java/net/luckperms/api/LuckPermsProvider.java +++ b/api/src/main/java/net/luckperms/api/LuckPermsProvider.java @@ -25,6 +25,7 @@ package net.luckperms.api; +import org.jspecify.annotations.Nullable; import static org.jetbrains.annotations.ApiStatus.Internal; @@ -35,7 +36,7 @@ import static org.jetbrains.annotations.ApiStatus.Internal; * instance, however, this provider can be used if this is not viable. */ public final class LuckPermsProvider { - private static LuckPerms instance = null; + private static @Nullable LuckPerms instance = null; /** * Gets an instance of the {@link LuckPerms} API, diff --git a/api/src/main/java/net/luckperms/api/actionlog/ActionLog.java b/api/src/main/java/net/luckperms/api/actionlog/ActionLog.java index d96c259d1..6e27a5f1e 100644 --- a/api/src/main/java/net/luckperms/api/actionlog/ActionLog.java +++ b/api/src/main/java/net/luckperms/api/actionlog/ActionLog.java @@ -57,7 +57,7 @@ public interface ActionLog { /** * Gets the entries in the log performed by the given actor. * - * @param actor the uuid of the actor to filter by + * @param actor the UUID of the actor to filter by * @return the content for the given actor */ @Unmodifiable SortedSetFor {@link User}s, the most appropriate query options will be their * {@link ContextManager#getQueryOptions(User) current active query options} if the - * corresponding player is online, and otherwise, will fallback to + * corresponding player is online, and otherwise, will fall back to * {@link ContextManager#getStaticQueryOptions() the current static query options}.
* *For {@link Group}s, the most appropriate query options will always be @@ -95,7 +95,7 @@ public interface CachedDataManager { * *
For {@link User}s, the most appropriate query options will be their * {@link ContextManager#getQueryOptions(User) current active query options} if the - * corresponding player is online, and otherwise, will fallback to + * corresponding player is online, and otherwise, will fall back to * {@link ContextManager#getStaticQueryOptions() the current static query options}.
* *For {@link Group}s, the most appropriate query options will always be diff --git a/api/src/main/java/net/luckperms/api/cacheddata/CachedMetaData.java b/api/src/main/java/net/luckperms/api/cacheddata/CachedMetaData.java index 3a5d5a2db..64922beda 100644 --- a/api/src/main/java/net/luckperms/api/cacheddata/CachedMetaData.java +++ b/api/src/main/java/net/luckperms/api/cacheddata/CachedMetaData.java @@ -117,7 +117,7 @@ public interface CachedMetaData extends CachedData { * *
This method will always return a {@link Result}, but the * {@link Result#result() inner result} {@link String} will be null if - * a the resultant prefix stack contained no elements.
+ * the resultant prefix stack contained no elements. * * @return a result containing the prefix * @since 5.4 @@ -152,7 +152,7 @@ public interface CachedMetaData extends CachedData { * *This method will always return a {@link Result}, but the * {@link Result#result() inner result} {@link String} will be null if - * a the resultant suffix stack contained no elements.
+ * the resultant suffix stack contained no elements. * * @return a result containing the suffix * @since 5.4 diff --git a/api/src/main/java/net/luckperms/api/context/ContextCalculator.java b/api/src/main/java/net/luckperms/api/context/ContextCalculator.java index c389d8966..b982d76b6 100644 --- a/api/src/main/java/net/luckperms/api/context/ContextCalculator.java +++ b/api/src/main/java/net/luckperms/api/context/ContextCalculator.java @@ -25,6 +25,7 @@ package net.luckperms.api.context; +import org.jspecify.annotations.Nullable; import java.util.Objects; import java.util.function.Function; @@ -37,8 +38,8 @@ import java.util.function.Function; *Contexts can be combined with each other to form so called + *
Contexts can be combined with each other to form so-called * "context sets" - simply a collection of context pairs.
* *Two default ContextSet implementations are provided. diff --git a/api/src/main/java/net/luckperms/api/context/ContextSetFactory.java b/api/src/main/java/net/luckperms/api/context/ContextSetFactory.java index 79f2b980f..7d64a8345 100644 --- a/api/src/main/java/net/luckperms/api/context/ContextSetFactory.java +++ b/api/src/main/java/net/luckperms/api/context/ContextSetFactory.java @@ -39,7 +39,7 @@ public interface ContextSetFactory { /** * Prefer using {@link ImmutableContextSet#builder()}. * - * @return a immutable context set builder + * @return an immutable context set builder * @see ImmutableContextSet#builder() */ ImmutableContextSet.Builder immutableBuilder(); diff --git a/api/src/main/java/net/luckperms/api/context/DefaultContextKeys.java b/api/src/main/java/net/luckperms/api/context/DefaultContextKeys.java index 174b46c16..8976504e0 100644 --- a/api/src/main/java/net/luckperms/api/context/DefaultContextKeys.java +++ b/api/src/main/java/net/luckperms/api/context/DefaultContextKeys.java @@ -34,17 +34,17 @@ public final class DefaultContextKeys { } /** - * The context key used to denote the name of the subjects server. + * The context key used to denote the name of the subject's server. */ public static final String SERVER_KEY = "server"; /** - * The context key used to denote the name of the subjects world. + * The context key used to denote the name of the subject's world. */ public static final String WORLD_KEY = "world"; /** - * The context key used to denote the dimension type of the subjects world. + * The context key used to denote the dimension type of the subject's world. * *
Possible values: overworld, the_nether, the_end
* @@ -53,7 +53,7 @@ public final class DefaultContextKeys { public static final String DIMENSION_TYPE_KEY = "dimension-type"; /** - * The context key used to denote the subjects gamemode. + * The context key used to denote the subject's gamemode. * *Possible values: survival, creative, adventure, spectator
* diff --git a/api/src/main/java/net/luckperms/api/context/StaticContextCalculator.java b/api/src/main/java/net/luckperms/api/context/StaticContextCalculator.java index 9b3be9eec..67fc3641b 100644 --- a/api/src/main/java/net/luckperms/api/context/StaticContextCalculator.java +++ b/api/src/main/java/net/luckperms/api/context/StaticContextCalculator.java @@ -25,6 +25,7 @@ package net.luckperms.api.context; +import org.jspecify.annotations.Nullable; import java.util.Objects; import java.util.function.Supplier; @@ -45,7 +46,7 @@ public interface StaticContextCalculator extends ContextCalculator