API10 - MC 1.19.2 Overview

.checkstyle/checkstyle.xml

@@ -1,7 +1,7 @@
 <?xml version="1.0"?>
 <!DOCTYPE module PUBLIC
-        "-//Checkstyle//DTD Checkstyle Configuration 1.3//EN"
-        "https://checkstyle.org/dtds/configuration_1_3.dtd">
+    "-//Checkstyle//DTD Checkstyle Configuration 1.3//EN"
+    "https://checkstyle.org/dtds/configuration_1_3.dtd">
 
 <!--
     Checkstyle configuration that checks the Google coding conventions from Google Java Style
@@ -16,7 +16,9 @@
     Authors: Max Vetrenko, Ruslan Diachenko, Roman Ivanov.
  -->
 
-<module name = "Checker">
+<module name="Checker">
+    <module name="SuppressWarningsFilter"/>
+
     <property name="charset" value="UTF-8"/>
 
     <property name="severity" value="${severity}" default="warning"/>
@@ -104,8 +106,10 @@
         </module>
         <module name="WhitespaceAfter">
             <property name="tokens"
-                      value="COMMA, SEMI, TYPECAST, LITERAL_IF, LITERAL_ELSE,
-                    LITERAL_WHILE, LITERAL_DO, LITERAL_FOR, DO_WHILE"/>
+                      value="COMMA, SEMI, TYPECAST, LITERAL_IF, LITERAL_ELSE, LITERAL_RETURN,
+                    LITERAL_WHILE, LITERAL_DO, LITERAL_FOR, LITERAL_FINALLY, DO_WHILE, ELLIPSIS,
+                    LITERAL_SWITCH, LITERAL_SYNCHRONIZED, LITERAL_TRY, LITERAL_CATCH, LAMBDA,
+                    LITERAL_YIELD, LITERAL_CASE"/>
         </module>
         <module name="WhitespaceAround">
             <property name="allowEmptyConstructors" value="true"/>
@@ -123,7 +127,8 @@
                     NOT_EQUAL, PLUS, PLUS_ASSIGN, QUESTION, RCURLY, SL, SLIST, SL_ASSIGN, SR,
                     SR_ASSIGN, STAR, STAR_ASSIGN, LITERAL_ASSERT, TYPE_EXTENSION_AND"/>
             <message key="ws.notFollowed"
-                     value="WhitespaceAround: ''{0}'' is not followed by whitespace. Empty blocks may only be represented as '{}' when not part of a multi-block statement (4.1.3)"/>
+                     value="WhitespaceAround: ''{0}'' is not followed by whitespace. Empty blocks
+               may only be represented as '{}' when not part of a multi-block statement (4.1.3)"/>
             <message key="ws.notPreceded"
                      value="WhitespaceAround: ''{0}'' is not preceded with whitespace."/>
         </module>
@@ -266,6 +271,7 @@
                     PARAMETER_DEF, VARIABLE_DEF, METHOD_DEF, PATTERN_VARIABLE_DEF, RECORD_DEF,
                     RECORD_COMPONENT_DEF"/>
         </module>
+        <module name="NoWhitespaceBeforeCaseDefaultColon"/>
         <module name="OverloadMethodsDeclarationOrder"/>
         <module name="VariableDeclarationUsageDistance"/>
         <module name="CustomImportOrder">
@@ -369,6 +375,19 @@
                       default="checkstyle-xpath-suppressions.xml" />
             <property name="optional" value="true"/>
         </module>
+        <module name="SuppressWarningsHolder" />
+        <module name="SuppressionCommentFilter">
+            <property name="offCommentFormat" value="CHECKSTYLE.OFF\: ([\w\|]+)" />
+            <property name="onCommentFormat" value="CHECKSTYLE.ON\: ([\w\|]+)" />
+            <property name="checkFormat" value="$1" />
+        </module>
+        <module name="SuppressWithNearbyCommentFilter">
+            <property name="commentFormat" value="CHECKSTYLE.SUPPRESS\: ([\w\|]+)"/>
+            <!-- $1 refers to the first match group in the regex defined in commentFormat -->
+            <property name="checkFormat" value="$1"/>
+            <!-- The check is suppressed in the next line of code after the comment -->
+            <property name="influenceFormat" value="1"/>
+        </module>
         <!--Sponge - start-->
         <module name="RequireThis">
             <property name="checkMethods" value="true"/>

.github/workflows/check-spotless.yaml

@@ -9,4 +9,6 @@ on:
 jobs:
   call-check:
     uses: SpongePowered/.github/.github/workflows/shared-check-spotless.yaml@master
-    secrets: inherit
+    with:
+      runtime_version: 17
+    secrets: inherit

.github/workflows/check-style.yaml

@@ -9,4 +9,6 @@ on:
 jobs:
   call-check:
     uses: SpongePowered/.github/.github/workflows/shared-check-style.yaml@master
+    with:
+      runtime_version: 17
     secrets: inherit

.github/workflows/ci.yaml

@@ -14,6 +14,7 @@ jobs:
   call-build:
     uses: SpongePowered/.github/.github/workflows/shared-ci.yaml@master
     with:
+      runtime_version: 17
       publish_snapshot_javadoc: true
       publishing_branch_regex: 'api-\d+'
     secrets: inherit

README.md

@@ -1,4 +1,4 @@
-SpongeAPI [![Build Status](https://travis-ci.org/SpongePowered/SpongeAPI.svg?branch=master)](https://travis-ci.org/SpongePowered/SpongeAPI)
+SpongeAPI ![Build Status](https://github.com/SpongePowered/SpongeAPI/actions/workflows/ci.yaml/badge.svg?branch=api-10)
 =============
 A mature Minecraft plugin API (not including an implementation), licensed under the [MIT License]. 
 
@@ -11,7 +11,7 @@ A mature Minecraft plugin API (not including an implementation), licensed under
 * [Discord] `#plugins`
 
 ## Prerequisites
-* [Java] 8 (JDK 16 recommended for development)
+* [Java] 17
 
 ## Clone
 The following steps will ensure your project is cloned properly.  
@@ -24,7 +24,7 @@ __Note:__ If you do not have [Gradle] installed then use ./gradlew for Unix syst
 
 In order to build SpongeAPI you simply need to run the `gradle` command. You can find the compiled JAR file in `./build/libs` labeled similarly to 'spongeapi-x.x.x-SNAPSHOT.jar'.
 
-Sponge will use a javac version of *at least* 11. If an older JDK is used to launch Gradle, JDK 11 will be downloaded automatically.
+Sponge will use a javac version of *at least* 17. If an older JDK is used to launch Gradle, JDK 17 will be downloaded automatically.
 
 ## Contributing
 Are you a talented programmer looking to contribute some code? We'd love the help!
@@ -37,9 +37,9 @@ Are you a talented programmer looking to contribute some code? We'd love the hel
 [IntelliJ]: https://www.jetbrains.com/idea/
 [Issues]: https://github.com/SpongePowered/SpongeAPI/issues
 [Documentation]: https://docs.spongepowered.org/
-[Java]: http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html
+[Java]: https://adoptium.net/temurin/releases/
 [Source]: https://github.com/SpongePowered/SpongeAPI/
 [MIT License]: https://www.tldrlegal.com/license/mit-license
-[Discord]: https://discord.gg/PtaGRAs
+[Discord]: https://discord.gg/sponge
 [Preparing for Development]: https://docs.spongepowered.org/stable/en/preparing/
 [Javadocs]: https://jd.spongepowered.org

build.gradle.kts

@@ -2,7 +2,7 @@ import net.ltgt.gradle.errorprone.errorprone
 
 buildscript {
     dependencies {
-        classpath("fr.inria.gforge.spoon:spoon-core:10.0.0") // bump for EIG
+        classpath("fr.inria.gforge.spoon:spoon-core:10.2.0") // bump for EIG
     }
 }
 
@@ -32,7 +32,6 @@ val ap by sourceSets.registering {
 val adventureVersion: String by project
 val configurateVersion: String by project
 val gsonVersion: String by project
-val guavaVersion: String by project
 val log4jVersion: String by project
 val mathVersion: String by project
 dependencies {
@@ -44,12 +43,6 @@ dependencies {
 
     // Directly tied to what's available from Minecraft
     api("org.apache.logging.log4j:log4j-api:$log4jVersion")
-    api("com.google.guava:guava:$guavaVersion") {
-        exclude(group ="com.google.code.findbugs", module = "jsr305") // We don't want to use jsr305, use checkerframework
-        exclude(group = "org.checkerframework", module = "checker-qual") // We use our own version
-        exclude(group = "com.google.j2objc", module = "j2objc-annotations")
-        exclude(group = "org.codehaus.mojo", module = "animal-sniffer-annotations")
-    }
     api("com.google.code.gson:gson:$gsonVersion")
 
     // Adventure
@@ -81,11 +74,6 @@ dependencies {
         exclude(group= "org.checkerframework", module = "checker-qual")
         exclude(group = "com.google.errorprone", module = "error_prone_annotations")
     }
-    implementation("com.github.ben-manes.caffeine:guava:$caffeineVersion") {
-        exclude(group = "com.google.guava", module = "guava")
-        exclude(group= "org.checkerframework", module = "checker-qual")
-        exclude(group = "com.google.errorprone", module = "error_prone_annotations")
-    }
 
     // Plugin spi, includes plugin-meta
     api("org.spongepowered:plugin-spi:$pluginSpiVersion")
@@ -178,13 +166,12 @@ tasks {
                 links(
                     "https://logging.apache.org/log4j/log4j-$log4jVersion/log4j-api/apidocs/",
                     "https://google.github.io/guice/api-docs/5.0.1/javadoc/",
-                    "https://guava.dev/releases/$guavaVersion/api/docs/",
                     "https://configurate.aoeu.xyz/$configurateVersion/apidocs/",
                     "https://www.javadoc.io/doc/com.google.code.gson/gson/$gsonVersion/",
                     "https://jd.spongepowered.org/math/$mathVersion"
                 )
                 sequenceOf("api", "key", "text-serializer-gson", "text-serializer-legacy", "text-serializer-plain").forEach {
-                    links("https://jd.adventure.kyori.net/$it/$adventureVersion/")
+                    links("https://jd.advntr.dev/$it/$adventureVersion/")
                 }
                 addBooleanOption("quiet", true)
             }
@@ -205,12 +192,6 @@ tasks {
 //        from(ap.get().output)
 //
 //    }
-
-//    sortClassFields {
-//        sortClasses.forEach {
-//            add(sourceSets.main.name, it)
-//        }
-//    }
 }
 
 idea {
@@ -277,11 +258,12 @@ indraCrossdoc {
 
 spotless {
     java {
+        toggleOffOn("@formatter:off", "@formatter:on")
         endWithNewline()
         indentWithSpaces(4)
         trimTrailingWhitespace()
-        toggleOffOn("@formatter:off", "@formatter:on")
         formatAnnotations()
+        removeUnusedImports()
         importOrderFile(rootProject.file("extra/eclipse/sponge_eclipse.importorder"))
     }
     kotlinGradle {
@@ -290,131 +272,3 @@ spotless {
         trimTrailingWhitespace()
     }
 }
-
-val sortClasses = listOf(
-        "org.spongepowered.api.advancement.AdvancementTypes",
-        "org.spongepowered.api.advancement.criteria.trigger.Triggers",
-        "org.spongepowered.api.adventure.ResolveOperations",
-        "org.spongepowered.api.block.BlockTypes",
-        "org.spongepowered.api.block.entity.BlockEntityTypes",
-        "org.spongepowered.api.block.transaction.Operations",
-        "org.spongepowered.api.command.command.registrar.tree.ClientCompletionKeys",
-        "org.spongepowered.api.command.command.selector.SelectorSortAlgorithms",
-        "org.spongepowered.api.command.command.selector.SelectorTypes",
-        "org.spongepowered.api.command.parameter.managed.clientcompletion.ClientCompletionTypes",
-        "org.spongepowered.api.command.parameter.managed.standard.ResourceKeyedValueParameters",
-        "org.spongepowered.api.data.Keys",
-        "org.spongepowered.api.data.persistence.DataFormats",
-        "org.spongepowered.api.data.type.ArmorMaterials",
-        "org.spongepowered.api.data.type.ArtTypes",
-        "org.spongepowered.api.data.type.AttachmentSurfaces",
-        "org.spongepowered.api.data.type.BannerPatternShapes",
-        "org.spongepowered.api.data.type.BoatTypes",
-        "org.spongepowered.api.data.type.BodyParts",
-        "org.spongepowered.api.data.type.CatTypes",
-        "org.spongepowered.api.data.type.ChestAttachmentTypes",
-        "org.spongepowered.api.data.type.ComparatorModes",
-        "org.spongepowered.api.data.type.DoorHinges",
-        "org.spongepowered.api.data.type.DyeColors",
-        "org.spongepowered.api.data.type.FoxTypes",
-        "org.spongepowered.api.data.type.HandPreferences",
-        "org.spongepowered.api.data.type.HandTypes",
-        "org.spongepowered.api.data.type.HorseColors",
-        "org.spongepowered.api.data.type.HorseStyles",
-        "org.spongepowered.api.data.type.InstrumentTypes",
-        "org.spongepowered.api.data.type.ItemTiers",
-        "org.spongepowered.api.data.type.LlamaTypes",
-        "org.spongepowered.api.data.type.MatterTypes",
-        "org.spongepowered.api.data.type.MooshroomTypes",
-        "org.spongepowered.api.data.type.NotePitches",
-        "org.spongepowered.api.data.type.PandaGenes",
-        "org.spongepowered.api.data.type.ParrotTypes",
-        "org.spongepowered.api.data.type.PhantomPhases",
-        "org.spongepowered.api.data.type.PickupRules",
-        "org.spongepowered.api.data.type.PistonTypes",
-        "org.spongepowered.api.data.type.PortionTypes",
-        "org.spongepowered.api.data.type.ProfessionTypes",
-        "org.spongepowered.api.data.type.RabbitTypes",
-        "org.spongepowered.api.data.type.RaidStatuses",
-        "org.spongepowered.api.data.type.RailDirections",
-        "org.spongepowered.api.data.type.SkinParts",
-        "org.spongepowered.api.data.type.SlabPortions",
-        "org.spongepowered.api.data.type.SpellTypes",
-        "org.spongepowered.api.data.type.StairShapes",
-        "org.spongepowered.api.data.type.StructureModes",
-        "org.spongepowered.api.data.type.TropicalFishShapes",
-        "org.spongepowered.api.data.type.VillagerTypes",
-        "org.spongepowered.api.data.type.WireAttachmentTypes",
-        "org.spongepowered.api.datapack.DataPackTypes",
-        "org.spongepowered.api.effect.particle.ParticleOptions",
-        "org.spongepowered.api.effect.particle.ParticleTypes",
-        "org.spongepowered.api.effect.potion.PotionEffectTypes",
-        "org.spongepowered.api.effect.sound.SoundTypes",
-        "org.spongepowered.api.effect.sound.music.MusicDiscs",
-        "org.spongepowered.api.entity.EntityTypes",
-        "org.spongepowered.api.entity.ai.goal.GoalExecutorTypes",
-        "org.spongepowered.api.entity.ai.goal.GoalTypes",
-        "org.spongepowered.api.entity.attribute.AttributeOperations",
-        "org.spongepowered.api.entity.attribute.type.AttributeTypes",
-        "org.spongepowered.api.entity.living.monster.boss.dragon.phase.DragonPhaseTypes",
-        "org.spongepowered.api.entity.living.player.chat.ChatVisibilities",
-        "org.spongepowered.api.entity.living.player.gamemode.GameModes",
-        "org.spongepowered.api.event.EventContextKeys",
-        "org.spongepowered.api.event.cause.entity.DismountTypes",
-        "org.spongepowered.api.event.cause.entity.MovementTypes",
-        "org.spongepowered.api.event.cause.entity.SpawnTypes",
-        "org.spongepowered.api.event.cause.entity.damage.DamageModifierTypes",
-        "org.spongepowered.api.event.cause.entity.damage.DamageTypes",
-        "org.spongepowered.api.event.cause.entity.damage.source.DamageSources",
-        "org.spongepowered.api.fluid.FluidTypes",
-        "org.spongepowered.api.item.FireworkShapes",
-        "org.spongepowered.api.item.ItemTypes",
-        "org.spongepowered.api.item.enchantment.EnchantmentTypes",
-        "org.spongepowered.api.item.inventory.ContainerTypes",
-        "org.spongepowered.api.item.inventory.equipment.EquipmentGroups",
-        "org.spongepowered.api.item.inventory.equipment.EquipmentTypes",
-        "org.spongepowered.api.item.inventory.menu.ClickTypes",
-        "org.spongepowered.api.item.inventory.query.QueryTypes",
-        "org.spongepowered.api.item.potion.PotionTypes",
-        "org.spongepowered.api.map.color.MapColorTypes",
-        "org.spongepowered.api.map.color.MapShades",
-        "org.spongepowered.api.map.decoration.MapDecorationTypes",
-        "org.spongepowered.api.map.decoration.orientation.MapDecorationOrientations",
-        "org.spongepowered.api.network.EngineConnectionTypes",
-        "org.spongepowered.api.placeholder.PlaceholderParsers",
-        "org.spongepowered.api.registry.RegistryTypes",
-        "org.spongepowered.api.scheduler.TaskPriorities",
-        "org.spongepowered.api.scoreboard.CollisionRules",
-        "org.spongepowered.api.scoreboard.Visibilities",
-        "org.spongepowered.api.scoreboard.criteria.Criteria",
-        "org.spongepowered.api.scoreboard.displayslot.DisplaySlots",
-        "org.spongepowered.api.scoreboard.objective.displaymode.ObjectiveDisplayModes",
-        "org.spongepowered.api.service.ban.BanTypes",
-        "org.spongepowered.api.service.economy.account.AccountDeletionResultTypes",
-        "org.spongepowered.api.service.economy.transaction.TransactionTypes",
-        "org.spongepowered.api.state.BooleanStateProperties",
-        "org.spongepowered.api.state.EnumStateProperties",
-        "org.spongepowered.api.state.IntegerStateProperties",
-        "org.spongepowered.api.statistic.StatisticCategories",
-        "org.spongepowered.api.statistic.Statistics",
-        "org.spongepowered.api.util.TypeTokens",
-        "org.spongepowered.api.util.mirror.Mirrors",
-        "org.spongepowered.api.util.orientation.Orientations",
-        "org.spongepowered.api.util.rotation.Rotations",
-        "org.spongepowered.api.world.BlockChangeFlags",
-        "org.spongepowered.api.world.ChunkRegenerateFlags",
-        "org.spongepowered.api.world.HeightTypes",
-        "org.spongepowered.api.world.LightTypes",
-        "org.spongepowered.api.world.WorldTypeEffects",
-        "org.spongepowered.api.world.WorldTypes",
-        "org.spongepowered.api.world.biome.Biomes",
-        "org.spongepowered.api.world.biome.BiomeSamplers",
-        "org.spongepowered.api.world.chunk.ChunkStates",
-        "org.spongepowered.api.world.difficulty.Difficulties",
-        "org.spongepowered.api.world.gamerule.GameRules",
-        "org.spongepowered.api.world.generation.structure.Structures",
-        "org.spongepowered.api.world.portal.PortalTypes",
-        "org.spongepowered.api.world.schematic.PaletteTypes",
-        "org.spongepowered.api.world.teleport.TeleportHelperFilters",
-        "org.spongepowered.api.world.weather.WeatherTypes"
-)

gradle.properties

@@ -1,5 +1,5 @@
 group=org.spongepowered
-version=9.1.0-SNAPSHOT
+version=10.1.0-SNAPSHOT
 organization=SpongePowered
 projectUrl=https://www.spongepowered.org
 projectDescription=A plugin API for Minecraft: Java Edition
@@ -13,10 +13,9 @@ caffeineVersion=3.1.2
 checkstyleVersion=10.5.0
 configurateVersion=4.1.2
 errorproneVersion=2.16
-gsonVersion=2.8.9
-guavaVersion=31.0.1-jre
+gsonVersion=2.10
 junitVersion=5.9.1
-log4jVersion=2.17.0
+log4jVersion=2.19.0
 
 mathVersion=2.0.1
 mockitoVersion=4.8.0

settings.gradle.kts

@@ -21,7 +21,3 @@ pluginManagement {
 plugins {
     id("org.gradle.toolchains.foojay-resolver-convention") version ("0.3.0")
 }
-
-if (JavaVersion.current() < JavaVersion.VERSION_11) {
-    throw GradleException("SpongeAPI requires at least Java 11 to build, but you have ${JavaVersion.current()}.")
-}