fix nullability issues (#2455)

* fix nullability issues

* add missing package-info files

* more nullability fixes

* more nullability fixes

* fix missorted modifier

* run spotless apply

Author: ImMorpheus

src/ap/java/org/spongepowered/plugin/processor/ListenerProcessor.java

@@ -26,6 +26,7 @@
 
 import static javax.tools.Diagnostic.Kind.ERROR;
 
+import org.checkerframework.checker.nullness.qual.Nullable;
 import org.spongepowered.api.event.Event;
 import org.spongepowered.api.event.Listener;
 import org.spongepowered.api.event.filter.IsCancelled;
@@ -99,7 +100,7 @@ public boolean process(final Set<? extends TypeElement> annotations, final Round
                     this.error("Event listener method must return void", method);
                 }
                 final List<? extends VariableElement> parameters = method.getParameters();
-                final DeclaredType eventType;
+                final @Nullable DeclaredType eventType;
                 if (parameters.isEmpty() || !this.isTypeSubclass(parameters.get(0), ListenerProcessor.EVENT_CLASS)) {
                     this.error("Event listener method must have an Event as its first parameter", method);
                     eventType = null;

src/main/java/org/spongepowered/api/Sponge.java

@@ -43,7 +43,7 @@
  */
 public final class Sponge {
 
-    @Inject private @Nullable static Game game;
+    @Inject private static @Nullable Game game;
 
     /**
      * Gets the {@link Game} instance. There is ever only going

src/main/java/org/spongepowered/api/block/transaction/BlockTransaction.java

@@ -55,7 +55,7 @@ public BlockTransaction(final BlockSnapshot original, final BlockSnapshot defaul
     }
 
     public BlockTransaction(final BlockSnapshot original, final BlockSnapshot defaultReplacement,
-        @Nullable final List<? extends BlockSnapshot> intermediary,
+        final @Nullable List<? extends BlockSnapshot> intermediary,
         final Operation operation
     ) {
         super(original, defaultReplacement, intermediary);

src/main/java/org/spongepowered/api/block/transaction/package-info.java

@@ -0,0 +1,31 @@
+/*
+ * This file is part of SpongeAPI, licensed under the MIT License (MIT).
+ *
+ * Copyright (c) SpongePowered <https://www.spongepowered.org>
+ * 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.
+ */
+/**
+ * An API section where "blocks" are represented. A block is a tile in the 3D
+ * game universe. Each "block" has a
+ * {@link org.spongepowered.api.block.BlockState} that can be changed.
+ */
+@org.checkerframework.framework.qual.DefaultQualifier(org.checkerframework.checker.nullness.qual.NonNull.class)
+package org.spongepowered.api.block.transaction;

src/main/java/org/spongepowered/api/command/Command.java

@@ -509,7 +509,7 @@ default Builder addParameters(final Iterable<Parameter> parameters) {
          *                            for no description.
          * @return This builder, for chaining
          */
-        default Builder extendedDescription(@Nullable final Component extendedDescription) {
+        default Builder extendedDescription(final @Nullable Component extendedDescription) {
             // Done outside the lambda so that we don't have to recreate the object each time.
             final Optional<Component> text = Optional.ofNullable(extendedDescription);
             return this.extendedDescription((cause) -> text);
@@ -543,7 +543,7 @@ default Builder extendedDescription(@Nullable final Component extendedDescriptio
          *                    description
          * @return This builder, for chaining
          */
-        default Builder shortDescription(@Nullable final Component description) {
+        default Builder shortDescription(final @Nullable Component description) {
             // Done outside the lambda so that we don't have to recreate the object each time.
             final Optional<Component> text = Optional.ofNullable(description);
             return this.shortDescription((cause) -> text);

src/main/java/org/spongepowered/api/command/exception/CommandException.java

@@ -25,6 +25,7 @@
 package org.spongepowered.api.command.exception;
 
 import net.kyori.adventure.text.Component;
+import org.checkerframework.checker.nullness.qual.Nullable;
 import org.spongepowered.api.util.ComponentMessageException;
 
 /**
@@ -42,7 +43,7 @@ public class CommandException extends ComponentMessageException {
      *
      * @param message The detail message
      */
-    public CommandException(final Component message) {
+    public CommandException(final @Nullable Component message) {
         this(message, false);
     }
 
@@ -53,7 +54,7 @@ public CommandException(final Component message) {
      * @param message The detail message
      * @param cause The cause
      */
-    public CommandException(final Component message, final Throwable cause) {
+    public CommandException(final @Nullable Component message, final Throwable cause) {
         this(message, cause, false);
     }
 
@@ -63,7 +64,7 @@ public CommandException(final Component message, final Throwable cause) {
      * @param message The detail message
      * @param includeUsage Whether to include usage in the exception
      */
-    public CommandException(final Component message, final boolean includeUsage) {
+    public CommandException(final @Nullable Component message, final boolean includeUsage) {
         super(message);
         this.includeUsage = includeUsage;
     }
@@ -76,7 +77,7 @@ public CommandException(final Component message, final boolean includeUsage) {
      * @param cause The cause
      * @param includeUsage Whether to include the usage in the exception
      */
-    public CommandException(final Component message, final Throwable cause, final boolean includeUsage) {
+    public CommandException(final @Nullable Component message, final Throwable cause, final boolean includeUsage) {
         super(message, cause);
         this.includeUsage = includeUsage;
     }

src/main/java/org/spongepowered/api/command/parameter/managed/clientcompletion/package-info.java

@@ -0,0 +1,26 @@
+/*
+ * This file is part of SpongeAPI, licensed under the MIT License (MIT).
+ *
+ * Copyright (c) SpongePowered <https://www.spongepowered.org>
+ * 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.
+ */
+@org.checkerframework.framework.qual.DefaultQualifier(org.checkerframework.checker.nullness.qual.NonNull.class)
+package org.spongepowered.api.command.parameter.managed.clientcompletion;

src/main/java/org/spongepowered/api/command/parameter/managed/operator/package-info.java

@@ -0,0 +1,26 @@
+/*
+ * This file is part of SpongeAPI, licensed under the MIT License (MIT).
+ *
+ * Copyright (c) SpongePowered <https://www.spongepowered.org>
+ * 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.
+ */
+@org.checkerframework.framework.qual.DefaultQualifier(org.checkerframework.checker.nullness.qual.NonNull.class)
+package org.spongepowered.api.command.parameter.managed.operator;

src/main/java/org/spongepowered/api/command/registrar/package-info.java

@@ -0,0 +1,26 @@
+/*
+ * This file is part of SpongeAPI, licensed under the MIT License (MIT).
+ *
+ * Copyright (c) SpongePowered <https://www.spongepowered.org>
+ * 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.
+ */
+@org.checkerframework.framework.qual.DefaultQualifier(org.checkerframework.checker.nullness.qual.NonNull.class)
+package org.spongepowered.api.command.registrar;

src/main/java/org/spongepowered/api/command/registrar/tree/CommandTreeNode.java

@@ -180,7 +180,7 @@ default <C extends CommandTreeNode.Argument<C>> T child(final String key, final
      * @param completionProvider The provider this node should use
      * @return This, for chaining
      */
-    default T completions(@Nullable final DefaultedRegistryReference<CommandCompletionProvider> completionProvider) {
+    default T completions(final @Nullable DefaultedRegistryReference<CommandCompletionProvider> completionProvider) {
         if (completionProvider == null) {
             return this.completions((CommandCompletionProvider) null);
         }