General improvements to GT Module Code (#2736)

Author: TechLord22

src/main/java/gregtech/api/modules/IGregTechModule.java

@@ -21,33 +21,33 @@ public interface IGregTechModule {
     /**
      * What other modules this module depends on.
      * <p>
-     * e.g. <code>new ResourceLocation("gregtech", "foo_module")</code> represents a dependency on the module
+     * e.g. {@code new ResourceLocation("gregtech", "foo_module")} represents a dependency on the module
      * "foo_module" in the container "gregtech"
      */
     @NotNull
     default Set<ResourceLocation> getDependencyUids() {
         return Collections.emptySet();
     }
 
-    default void construction(FMLConstructionEvent event) {}
+    default void construction(@NotNull FMLConstructionEvent event) {}
 
-    default void preInit(FMLPreInitializationEvent event) {}
+    default void preInit(@NotNull FMLPreInitializationEvent event) {}
 
-    default void init(FMLInitializationEvent event) {}
+    default void init(@NotNull FMLInitializationEvent event) {}
 
-    default void postInit(FMLPostInitializationEvent event) {}
+    default void postInit(@NotNull FMLPostInitializationEvent event) {}
 
-    default void loadComplete(FMLLoadCompleteEvent event) {}
+    default void loadComplete(@NotNull FMLLoadCompleteEvent event) {}
 
-    default void serverAboutToStart(FMLServerAboutToStartEvent event) {}
+    default void serverAboutToStart(@NotNull FMLServerAboutToStartEvent event) {}
 
-    default void serverStarting(FMLServerStartingEvent event) {}
+    default void serverStarting(@NotNull FMLServerStartingEvent event) {}
 
-    default void serverStarted(FMLServerStartedEvent event) {}
+    default void serverStarted(@NotNull FMLServerStartedEvent event) {}
 
-    default void serverStopping(FMLServerStoppingEvent event) {}
+    default void serverStopping(@NotNull FMLServerStoppingEvent event) {}
 
-    default void serverStopped(FMLServerStoppedEvent event) {}
+    default void serverStopped(@NotNull FMLServerStoppedEvent event) {}
 
     /**
      * Register packets using GregTech's packet handling API here.
@@ -87,7 +87,11 @@ default void registerPackets() {}
         return Collections.emptyList();
     }
 
-    default boolean processIMC(FMLInterModComms.IMCMessage message) {
+    /**
+     * @param message the message to process
+     * @return if the message was processed, stopping all other modules from processing it
+     */
+    default boolean processIMC(@NotNull FMLInterModComms.IMCMessage message) {
         return false;
     }
 

src/main/java/gregtech/api/modules/IModuleManager.java

@@ -4,23 +4,28 @@
 
 import net.minecraft.util.ResourceLocation;
 
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
+
 public interface IModuleManager {
 
-    default boolean isModuleEnabled(String containerID, String moduleID) {
+    default boolean isModuleEnabled(@NotNull String containerID, @NotNull String moduleID) {
         return isModuleEnabled(new ResourceLocation(containerID, moduleID));
     }
 
-    default boolean isModuleEnabled(String moduleID) {
+    default boolean isModuleEnabled(@NotNull String moduleID) {
         return isModuleEnabled(GTUtility.gregtechId(moduleID));
     }
 
-    boolean isModuleEnabled(ResourceLocation id);
+    boolean isModuleEnabled(@NotNull ResourceLocation id);
 
-    void registerContainer(IModuleContainer container);
+    void registerContainer(@NotNull IModuleContainer container);
 
+    @Nullable
     IModuleContainer getLoadedContainer();
 
+    @NotNull
     ModuleStage getStage();
 
-    boolean hasPassedStage(ModuleStage stage);
+    boolean hasPassedStage(@NotNull ModuleStage stage);
 }