Even more renames, start hiding some API internals

.github/workflows/gradle.yml

@@ -3,20 +3,20 @@
 
 name: Java CI with Gradle
 
-on: [push, pull_request]
+on: [ push, pull_request ]
 
 jobs:
   build-17:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v3
-    - uses: gradle/wrapper-validation-action@v1
-    - name: Set up JDK 17
-      uses: actions/setup-java@v3
-      with:
-        java-version: 17
-        distribution: 'temurin'
-    - name: Grant execute permission for gradlew
-      run: chmod +x gradlew
-    - name: Build with Gradle
-      run: ./gradlew build
+      - uses: actions/checkout@v3
+      - uses: gradle/wrapper-validation-action@v1
+      - name: Set up JDK 17
+        uses: actions/setup-java@v3
+        with:
+          java-version: 17
+          distribution: 'temurin'
+      - name: Grant execute permission for gradlew
+        run: chmod +x gradlew
+      - name: Build with Gradle
+        run: ./gradlew build

README.md

@@ -18,7 +18,7 @@ Velocity is licensed under the GPLv3 license.
 * First-class support for Paper, Sponge, Fabric and Forge. (Other implementations
   may work, but we make every endeavor to support these server implementations
   specifically.)
-  
+
 ## Building
 
 Velocity is built with [Gradle](https://gradle.org). We recommend using the

api/build.gradle.kts

@@ -52,12 +52,12 @@ tasks {
         o.source = "8"
 
         o.links(
-            "https://www.slf4j.org/apidocs/",
-            "https://guava.dev/releases/${libs.guava.get().version}/api/docs/",
-            "https://google.github.io/guice/api-docs/${libs.guice.get().version}/javadoc/",
-            "https://docs.oracle.com/en/java/javase/11/docs/api/",
-            "https://jd.advntr.dev/api/${libs.adventure.bom.get().version}/",
-            "https://javadoc.io/doc/com.github.ben-manes.caffeine/caffeine"
+                "https://www.slf4j.org/apidocs/",
+                "https://guava.dev/releases/${libs.guava.get().version}/api/docs/",
+                "https://google.github.io/guice/api-docs/${libs.guice.get().version}/javadoc/",
+                "https://docs.oracle.com/en/java/javase/11/docs/api/",
+                "https://jd.advntr.dev/api/${libs.adventure.bom.get().version}/",
+                "https://javadoc.io/doc/com.github.ben-manes.caffeine/caffeine"
         )
 
         // Disable the crazy super-strict doclint tool in Java 8

api/src/main/java/com/velocitypowered/api/command/BrigadierCommand.java

@@ -12,22 +12,20 @@
 import com.mojang.brigadier.tree.LiteralCommandNode;
 
 /**
- * A command that uses Brigadier for parsing the command and
- * providing suggestions to the client.
+ * A command that uses Brigadier for parsing the command and providing suggestions to the client.
  */
 public final class BrigadierCommand implements Command {
 
   /**
-   * The return code used by a {@link com.mojang.brigadier.Command} to indicate
-   * the command execution should be forwarded to the backend server.
+   * The return code used by a {@link com.mojang.brigadier.Command} to indicate the command
+   * execution should be forwarded to the backend server.
    */
   public static final int FORWARD = 0xF6287429;
 
   private final LiteralCommandNode<CommandSource> node;
 
   /**
-   * Constructs a {@link BrigadierCommand} from the node returned by
-   * the given builder.
+   * Constructs a {@link BrigadierCommand} from the node returned by the given builder.
    *
    * @param builder the {@link LiteralCommandNode} builder
    */

api/src/main/java/com/velocitypowered/api/command/Command.java

@@ -7,11 +7,11 @@
 
 package com.velocitypowered.api.command;
 
-import com.velocitypowered.api.proxy.Player;
+import com.velocitypowered.api.proxy.player.Player;
 
 /**
- * Represents a command that can be executed by a {@link CommandSource}
- * such as a {@link Player} or the console.
+ * Represents a command that can be executed by a {@link CommandSource} such as a {@link Player} or
+ * the console.
  *
  * <p><strong>You must not subclass <code>Command</code></strong>. Use one of the following
  * <i>registrable</i> subinterfaces:</p>
@@ -30,4 +30,5 @@
  * </ul>
  */
 public interface Command {
+
 }

api/src/main/java/com/velocitypowered/api/command/CommandManager.java

@@ -18,17 +18,15 @@
 public interface CommandManager {
 
   /**
-   * Returns a builder to create a {@link CommandMeta} with
-   * the given alias.
+   * Returns a builder to create a {@link CommandMeta} with the given alias.
    *
    * @param alias the first command alias
    * @return a {@link CommandMeta} builder
    */
   CommandMeta.Builder buildMeta(String alias);
 
   /**
-   * Returns a builder to create a {@link CommandMeta} for
-   * the given Brigadier command.
+   * Returns a builder to create a {@link CommandMeta} for the given Brigadier command.
    *
    * @param command the command
    * @return a {@link CommandMeta} builder
@@ -38,11 +36,12 @@ public interface CommandManager {
   /**
    * Registers the specified command with the specified aliases.
    *
-   * @param alias the first command alias
-   * @param command the command to register
+   * @param alias        the first command alias
+   * @param command      the command to register
    * @param otherAliases additional aliases
-   * @throws IllegalArgumentException if one of the given aliases is already registered, or
-   *         the given command does not implement a registrable {@link Command} subinterface
+   * @throws IllegalArgumentException if one of the given aliases is already registered, or the
+   *                                  given command does not implement a registrable {@link Command}
+   *                                  subinterface
    * @see Command for a list of registrable subinterfaces
    */
   default void register(String alias, Command command, String... otherAliases) {
@@ -60,10 +59,11 @@ default void register(String alias, Command command, String... otherAliases) {
   /**
    * Registers the specified command with the given metadata.
    *
-   * @param meta the command metadata
+   * @param meta    the command metadata
    * @param command the command to register
-   * @throws IllegalArgumentException if one of the given aliases is already registered, or
-   *         the given command does not implement a registrable {@link Command} subinterface
+   * @throws IllegalArgumentException if one of the given aliases is already registered, or the
+   *                                  given command does not implement a registrable {@link Command}
+   *                                  subinterface
    * @see Command for a list of registrable subinterfaces
    */
   void register(CommandMeta meta, Command command);
@@ -93,27 +93,26 @@ default void register(String alias, Command command, String... otherAliases) {
   /**
    * Attempts to asynchronously execute a command from the given {@code cmdLine}.
    *
-   * @param source the source to execute the command for
+   * @param source  the source to execute the command for
    * @param cmdLine the command to run
-   * @return a future that may be completed with the result of the command execution.
-   *         Can be completed exceptionally if an exception is thrown during execution.
+   * @return a future that may be completed with the result of the command execution. Can be
+   *         completed exceptionally if an exception is thrown during execution.
    */
   CompletableFuture<Boolean> executeAsync(CommandSource source, String cmdLine);
 
   /**
-   * Attempts to asynchronously execute a command from the given {@code cmdLine}
-   * without firing a {@link CommandExecuteEvent}.
+   * Attempts to asynchronously execute a command from the given {@code cmdLine} without firing a
+   * {@link CommandExecuteEvent}.
    *
-   * @param source the source to execute the command for
+   * @param source  the source to execute the command for
    * @param cmdLine the command to run
-   * @return a future that may be completed with the result of the command execution.
-   *         Can be completed exceptionally if an exception is thrown during execution.
+   * @return a future that may be completed with the result of the command execution. Can be
+   *         completed exceptionally if an exception is thrown during execution.
    */
   CompletableFuture<Boolean> executeImmediatelyAsync(CommandSource source, String cmdLine);
 
   /**
-   * Returns an immutable collection of the case-insensitive aliases registered
-   * on this manager.
+   * Returns an immutable collection of the case-insensitive aliases registered on this manager.
    *
    * @return the registered aliases
    */

api/src/main/java/com/velocitypowered/api/command/CommandMeta.java

@@ -17,25 +17,25 @@
 public interface CommandMeta {
 
   /**
-   * Returns a non-empty collection containing the case-insensitive aliases
-   * used to execute the command.
+   * Returns a non-empty collection containing the case-insensitive aliases used to execute the
+   * command.
    *
    * @return the command aliases
    */
   Collection<String> aliases();
 
   /**
-   * Returns an immutable collection containing command nodes that provide
-   * additional argument metadata and tab-complete suggestions.
-   * Note some {@link Command} implementations may not support hinting.
+   * Returns an immutable collection containing command nodes that provide additional argument
+   * metadata and tab-complete suggestions. Note some {@link Command} implementations may not
+   * support hinting.
    *
    * @return the hinting command nodes
    */
   Collection<CommandNode<CommandSource>> hints();
 
   /**
-   * Returns the plugin who registered the command.
-   * Note some {@link Command} registrations may not provide this information.
+   * Returns the plugin who registered the command. Note some {@link Command} registrations may not
+   * provide this information.
    *
    * @return the registering plugin
    */
@@ -55,13 +55,13 @@ interface Builder {
     Builder aliases(String... aliases);
 
     /**
-     * Specifies a command node providing additional argument metadata and
-     * tab-complete suggestions.
+     * Specifies a command node providing additional argument metadata and tab-complete
+     * suggestions.
      *
      * @param node the command node
      * @return this builder, for chaining
      * @throws IllegalArgumentException if the node is executable, i.e. has a non-null
-     *         {@link com.mojang.brigadier.Command}, or has a redirect.
+     *                                  {@link com.mojang.brigadier.Command}, or has a redirect.
      */
     Builder hint(CommandNode<CommandSource> node);
 

api/src/main/java/com/velocitypowered/api/command/InvocableCommand.java

@@ -15,9 +15,8 @@
  * A command that can be executed with arbitrary arguments.
  *
  * <p>Modifying the command tree (e.g. registering a command via
- * {@link CommandManager#register(CommandMeta, Command)}) during
- * permission checking and suggestions provision results in
- * undefined behavior, which may include deadlocks.
+ * {@link CommandManager#register(CommandMeta, Command)}) during permission checking and suggestions
+ * provision results in undefined behavior, which may include deadlocks.
  *
  * @param <I> the type of the command invocation object
  */

api/src/main/java/com/velocitypowered/api/command/RawCommand.java

@@ -8,9 +8,9 @@
 package com.velocitypowered.api.command;
 
 /**
- * A specialized sub-interface of {@code Command} which indicates the proxy should pass
- * the command and its arguments directly without further processing.
- * This is useful for bolting on external command frameworks to Velocity.
+ * A specialized sub-interface of {@code Command} which indicates the proxy should pass the command
+ * and its arguments directly without further processing. This is useful for bolting on external
+ * command frameworks to Velocity.
  */
 public interface RawCommand extends InvocableCommand<RawCommand.Invocation> {
 

api/src/main/java/com/velocitypowered/api/command/SimpleCommand.java

@@ -10,8 +10,7 @@
 import org.checkerframework.checker.nullness.qual.NonNull;
 
 /**
- * A simple command, modelled after the convention popularized by
- * Bukkit and BungeeCord.
+ * A simple command, modelled after the convention popularized by Bukkit and BungeeCord.
  *
  * <p>Prefer using {@link BrigadierCommand}, which is also
  * backwards-compatible with older clients.

api/src/main/java/com/velocitypowered/api/command/VelocityBrigadierMessage.java

@@ -15,8 +15,8 @@
 import org.jetbrains.annotations.NotNull;
 
 /**
- * Represents an implementation of brigadier's {@link Message}, providing support for {@link
- * Component} messages.
+ * Represents an implementation of brigadier's {@link Message}, providing support for
+ * {@link Component} messages.
  */
 public final class VelocityBrigadierMessage implements Message, ComponentLike {
 

api/src/main/java/com/velocitypowered/api/event/Continuation.java

@@ -8,8 +8,8 @@
 package com.velocitypowered.api.event;
 
 /**
- * Represents a continuation of a paused event handler. Any of the resume methods
- * may only be called once otherwise an {@link IllegalStateException} is expected.
+ * Represents a continuation of a paused event handler. Any of the resume methods may only be called
+ * once otherwise an {@link IllegalStateException} is expected.
  */
 public interface Continuation {
 

api/src/main/java/com/velocitypowered/api/event/EventManager.java

@@ -15,36 +15,36 @@
 public interface EventManager {
 
   /**
-   * Requests that the specified {@code listener} listen for events and associate it with the {@code
-   * plugin}.
+   * Requests that the specified {@code listener} listen for events and associate it with the
+   * {@code plugin}.
    *
-   * @param plugin the plugin to associate with the listener
+   * @param plugin   the plugin to associate with the listener
    * @param listener the listener to register
    */
   void register(Object plugin, Object listener);
 
   /**
-   * Requests that the specified {@code handler} listen for events and associate it with the {@code
-   * plugin}.
+   * Requests that the specified {@code handler} listen for events and associate it with the
+   * {@code plugin}.
    *
-   * @param plugin the plugin to associate with the handler
+   * @param plugin     the plugin to associate with the handler
    * @param eventClass the class for the event handler to register
-   * @param handler the handler to register
-   * @param <E> the event type to handle
+   * @param handler    the handler to register
+   * @param <E>        the event type to handle
    */
   default <E> void register(Object plugin, Class<E> eventClass, EventHandler<E> handler) {
     register(plugin, eventClass, PostOrder.NORMAL, handler);
   }
 
   /**
-   * Requests that the specified {@code handler} listen for events and associate it with the {@code
-   * plugin}.
+   * Requests that the specified {@code handler} listen for events and associate it with the
+   * {@code plugin}.
    *
-   * @param plugin the plugin to associate with the handler
+   * @param plugin     the plugin to associate with the handler
    * @param eventClass the class for the event handler to register
-   * @param postOrder the order in which events should be posted to the handler
-   * @param handler the handler to register
-   * @param <E> the event type to handle
+   * @param postOrder  the order in which events should be posted to the handler
+   * @param handler    the handler to register
+   * @param <E>        the event type to handle
    */
   <E> void register(Object plugin, Class<E> eventClass, short postOrder,
       EventHandler<E> handler);
@@ -78,17 +78,17 @@ default void fireAndForget(Object event) {
   /**
    * Unregisters a specific listener for a specific plugin.
    *
-   * @param plugin the plugin associated with the listener
+   * @param plugin   the plugin associated with the listener
    * @param listener the listener to deregister
    */
   void unregisterListener(Object plugin, Object listener);
 
   /**
    * Unregisters a specific event handler for a specific plugin.
    *
-   * @param plugin the plugin to associate with the handler
+   * @param plugin  the plugin to associate with the handler
    * @param handler the handler to register
-   * @param <E> the event type to handle
+   * @param <E>     the event type to handle
    */
   <E> void unregister(Object plugin, EventHandler<E> handler);
 }

api/src/main/java/com/velocitypowered/api/event/ResultedEvent.java

@@ -37,8 +37,8 @@ public interface ResultedEvent<R extends ResultedEvent.Result> {
   interface Result {
 
     /**
-     * Returns whether the event is allowed to proceed. Plugins may choose to skip denied
-     * events, and the proxy will respect the result of this method.
+     * Returns whether the event is allowed to proceed. Plugins may choose to skip denied events,
+     * and the proxy will respect the result of this method.
      *
      * @return whether the event is allowed to proceed
      */