feat(API): Implements a featured API for GT_Fluid (#1345)

* feat(API): Implements a featured API for GT_Fluid

*** Rationale

The current implementation, which is based on the `GT_Fluid` object,
does not allow for the evolution of the functionalities, or the
variation of the fluid-related implementations in GregTech.

*** Objectives

This replacement API should free from these constraints, by providing :

1. The separation of responsibilities of the different tasks and steps:
  - The definition and progressive construction of an `IGT_Fluid`,
  - Registration of the `IGT_Fluid`,
  - Configuration of related equipment, such as containers,
  - Propagation of properties of an `IGT_Fluid` to related services
    such as Materials

2. The separation of interfaces exposed to the API from their internal
   implementations to allow:
  - Evolve the implementations in the most transparent way possible
  - To have internal GregTech implementations or outsourced
    implementations coexist in its extensions.

*** Specificity of this new API

- Provides a new interface to build and interact with fluid related records
- Deprecates the old `api/objects/GT_Fluid` object and the
  `common/GT_Proxy.addFluid` record methods

* fix(conversations): addresses @Glease review comments

https://github.com/GTNewHorizons/GT5-Unofficial/pull/1345#pullrequestreview-1096261703

* ./gradlew :spotlessApply

* fix(review): add review comments from @eigenraven

Added missing final qualifiers on methods parameters.
https://github.com/GTNewHorizons/GT5-Unofficial/pull/1345#pullrequestreview-1096318523

* fix(review) address remaining review comments from @eigenraven

1 files changed, 99 insertions, 79 deletions

diff --git a/src/main/java/gregtech/common/GT_Proxy.java b/src/main/java/gregtech/common/GT_Proxy.java
index 0a529cfa3b..3fb7bdd337 100644
--- a/src/main/java/gregtech/common/GT_Proxy.java
+++ b/src/main/java/gregtech/common/GT_Proxy.java
@@ -1,6 +1,10 @@
 package gregtech.common;
 
 import static gregtech.GT_Mod.GT_FML_LOGGER;
+import static gregtech.api.enums.FluidState.GAS;
+import static gregtech.api.enums.FluidState.LIQUID;
+import static gregtech.api.enums.FluidState.MOLTEN;
+import static gregtech.api.enums.FluidState.PLASMA;
 import static gregtech.api.enums.GT_Values.MOD_ID_RC;
 import static gregtech.api.enums.GT_Values.MOD_ID_TC;
 import static gregtech.api.enums.GT_Values.MOD_ID_TE;
@@ -25,6 +29,7 @@ import forestry.api.genetics.AlleleManager;
 import gregtech.api.GregTech_API;
 import gregtech.api.enums.ConfigCategories;
 import gregtech.api.enums.Dyes;
+import gregtech.api.enums.FluidState;
 import gregtech.api.enums.GT_Values;
 import gregtech.api.enums.ItemList;
 import gregtech.api.enums.Materials;
@@ -34,9 +39,11 @@ import gregtech.api.enums.SoundResource;
 import gregtech.api.enums.SubTag;
 import gregtech.api.enums.TC_Aspects.TC_AspectStack;
 import gregtech.api.enums.ToolDictNames;
+import gregtech.api.fluid.GT_FluidFactory;
 import gregtech.api.interfaces.IBlockOnWalkOver;
 import gregtech.api.interfaces.IGlobalWirelessEnergy;
 import gregtech.api.interfaces.IProjectileItem;
+import gregtech.api.interfaces.fluid.IGT_Fluid;
 import gregtech.api.interfaces.internal.IGT_Mod;
 import gregtech.api.interfaces.internal.IThaumcraftCompat;
 import gregtech.api.interfaces.metatileentity.IMetaTileEntity;
@@ -2456,75 +2463,76 @@ public abstract class GT_Proxy implements IGT_Mod, IGuiHandler, IFuelHandler, IG
         // If the fluid is registered as custom inside the Material's constructor then to add custom fluid
         // textures go to blocks/fluids and place the .png. File should be called fluid.fluid.{unlocalised_name}.png.
         // All lower case.
-        String fluidTexture =
-                aMaterial.mIconSet.is_custom ? ("fluid." + aMaterial.mName.toLowerCase()) : "autogenerated";
-        return addFluid(
-                aMaterial.mName.toLowerCase(Locale.ENGLISH),
-                fluidTexture,
-                aMaterial.mDefaultLocalName,
-                aMaterial,
-                aMaterial.mRGBa,
-                1,
-                aMaterial.getLiquidTemperature(),
-                GT_OreDictUnificator.get(OrePrefixes.cell, aMaterial, 1L),
-                ItemList.Cell_Empty.get(1L),
-                1000);
+        final String fluidTexture =
+                aMaterial.mIconSet.is_custom ? "fluid." + aMaterial.mName.toLowerCase() : "autogenerated";
+        return GT_FluidFactory.builder(aMaterial.mName.toLowerCase(Locale.ENGLISH))
+                .withLocalizedName(aMaterial.mDefaultLocalName)
+                .withTextureName(fluidTexture)
+                .withColorRGBA(aMaterial.mRGBa)
+                .withStateAndTemperature(LIQUID, aMaterial.getLiquidTemperature())
+                .buildAndRegister()
+                .configureMaterials(aMaterial)
+                .registerBContainers(
+                        GT_OreDictUnificator.get(OrePrefixes.cell, aMaterial, 1L), ItemList.Cell_Empty.get(1L))
+                .asFluid();
     }
 
     public Fluid addAutoGeneratedCorrespondingGas(Materials aMaterial) {
         // If the fluid is registered as custom inside the Material's constructor then to add custom fluid
         // textures go to blocks/fluids and place the .png. File should be called fluid.gas.{unlocalised_name}.png. All
         // lower case.
-        String fluidTexture = aMaterial.mIconSet.is_custom ? ("gas." + aMaterial.mName.toLowerCase()) : "autogenerated";
-        return addFluid(
-                aMaterial.mName.toLowerCase(Locale.ENGLISH),
-                fluidTexture,
-                aMaterial.mDefaultLocalName,
-                aMaterial,
-                aMaterial.mRGBa,
-                2,
-                aMaterial.getGasTemperature(),
-                GT_OreDictUnificator.get(OrePrefixes.cell, aMaterial, 1L),
-                ItemList.Cell_Empty.get(1L),
-                1000);
+        final String fluidTexture =
+                aMaterial.mIconSet.is_custom ? ("gas." + aMaterial.mName.toLowerCase()) : "autogenerated";
+        return GT_FluidFactory.builder(aMaterial.mName.toLowerCase(Locale.ENGLISH))
+                .withLocalizedName(aMaterial.mDefaultLocalName)
+                .withTextureName(fluidTexture)
+                .withColorRGBA(aMaterial.mRGBa)
+                .withStateAndTemperature(GAS, aMaterial.getGasTemperature())
+                .buildAndRegister()
+                .configureMaterials(aMaterial)
+                .registerBContainers(
+                        GT_OreDictUnificator.get(OrePrefixes.cell, aMaterial, 1L), ItemList.Cell_Empty.get(1L))
+                .asFluid();
     }
 
     public Fluid addAutogeneratedPlasmaFluid(Materials aMaterial) {
         // If the fluid is registered as custom inside the Material's constructor then to add custom fluid
         // textures go to blocks/fluids and place the .png. File should be called fluid.plasma.{unlocalised_name}.png.
         // All lower case.
-        String fluidTexture =
+        final String fluidTexture =
                 aMaterial.mIconSet.is_custom ? ("plasma." + aMaterial.mName.toLowerCase()) : "plasma.autogenerated";
-        return addFluid(
-                "plasma." + aMaterial.mName.toLowerCase(Locale.ENGLISH),
-                fluidTexture,
-                aMaterial.mDefaultLocalName + " Plasma",
-                aMaterial,
-                aMaterial.mMoltenRGBa,
-                3,
-                10000,
-                GT_OreDictUnificator.get(OrePrefixes.cellPlasma, aMaterial, 1L),
-                ItemList.Cell_Empty.get(1L),
-                aMaterial.getMolten(1) != null ? 144 : 1000);
+        return GT_FluidFactory.builder("plasma." + aMaterial.mName.toLowerCase(Locale.ENGLISH))
+                .withLocalizedName(aMaterial.mDefaultLocalName + " Plasma")
+                .withTextureName(fluidTexture)
+                .withColorRGBA(aMaterial.mRGBa)
+                .withStateAndTemperature(PLASMA, 10000)
+                .buildAndRegister()
+                .configureMaterials(aMaterial)
+                .registerContainers(
+                        GT_OreDictUnificator.get(OrePrefixes.cellPlasma, aMaterial, 1L),
+                        ItemList.Cell_Empty.get(1L),
+                        aMaterial.getMolten(1) != null ? 144 : 1000)
+                .asFluid();
     }
 
     public Fluid addAutogeneratedMoltenFluid(Materials aMaterial) {
         // If the fluid is registered as custom inside the Material's constructor then to add custom fluid
         // textures go to blocks/fluids and place the .png. File should be called fluid.molten.{unlocalised_name}.png.
         // All lower case.
-        String fluidTexture =
+        final String fluidTexture =
                 aMaterial.mIconSet.is_custom ? ("molten." + aMaterial.mName.toLowerCase()) : "molten.autogenerated";
-        return addFluid(
-                "molten." + aMaterial.mName.toLowerCase(Locale.ENGLISH),
-                fluidTexture,
-                "Molten " + aMaterial.mDefaultLocalName,
-                aMaterial,
-                aMaterial.mMoltenRGBa,
-                4,
-                aMaterial.mMeltingPoint < 0 ? 1000 : aMaterial.mMeltingPoint,
-                GT_OreDictUnificator.get(OrePrefixes.cellMolten, aMaterial, 1L),
-                ItemList.Cell_Empty.get(1L),
-                144);
+        return GT_FluidFactory.builder("molten." + aMaterial.mName.toLowerCase(Locale.ENGLISH))
+                .withLocalizedName("Molten " + aMaterial.mDefaultLocalName)
+                .withTextureName(fluidTexture)
+                .withColorRGBA(aMaterial.mRGBa)
+                .withStateAndTemperature(MOLTEN, aMaterial.mMeltingPoint < 0 ? 1000 : aMaterial.mMeltingPoint)
+                .buildAndRegister()
+                .configureMaterials(aMaterial)
+                .registerContainers(
+                        GT_OreDictUnificator.get(OrePrefixes.cellMolten, aMaterial, 1L),
+                        ItemList.Cell_Empty.get(1L),
+                        144)
+                .asFluid();
     }
 
     // ------------------------------------------------------------------------------------------------------------
@@ -2535,24 +2543,22 @@ public abstract class GT_Proxy implements IGT_Mod, IGuiHandler, IFuelHandler, IG
         OrePrefixes[] orePrefixes = {
             OrePrefixes.cellHydroCracked1, OrePrefixes.cellHydroCracked2, OrePrefixes.cellHydroCracked3
         };
-        GT_Fluid uncrackedFluid = null;
+        final Fluid uncrackedFluid;
         if (aMaterial.mFluid != null) {
-            uncrackedFluid = (GT_Fluid) aMaterial.mFluid;
+            uncrackedFluid = aMaterial.mFluid;
         } else if (aMaterial.mGas != null) {
-            uncrackedFluid = (GT_Fluid) aMaterial.mGas;
-        }
+            uncrackedFluid = aMaterial.mGas;
+        } else return;
         for (int i = 0; i < 3; i++) {
-            crackedFluids[i] = addFluid(
-                    namePrefixes[i] + aMaterial.mName.toLowerCase(Locale.ENGLISH),
-                    uncrackedFluid.mTextureName,
-                    orePrefixes[i].mLocalizedMaterialPre + aMaterial.mDefaultLocalName,
-                    null,
-                    aMaterial.mRGBa,
-                    2,
-                    775,
-                    GT_OreDictUnificator.get(orePrefixes[i], aMaterial, 1L),
-                    ItemList.Cell_Empty.get(1L),
-                    1000);
+            crackedFluids[i] = GT_FluidFactory.builder(namePrefixes[i] + aMaterial.mName.toLowerCase(Locale.ENGLISH))
+                    .withTextureFrom((IGT_Fluid) uncrackedFluid)
+                    .withLocalizedName(orePrefixes[i].mLocalizedMaterialPre + aMaterial.mDefaultLocalName)
+                    .withColorRGBA(aMaterial.mRGBa)
+                    .withStateAndTemperature(GAS, 775)
+                    .buildAndRegister()
+                    .registerBContainers(
+                            GT_OreDictUnificator.get(orePrefixes[i], aMaterial, 1L), ItemList.Cell_Empty.get(1L))
+                    .asFluid();
 
             int hydrogenAmount = 2 * i + 2;
             GT_Values.RA.addCrackingRecipe(
@@ -2588,24 +2594,22 @@ public abstract class GT_Proxy implements IGT_Mod, IGuiHandler, IFuelHandler, IG
         OrePrefixes[] orePrefixes = {
             OrePrefixes.cellSteamCracked1, OrePrefixes.cellSteamCracked2, OrePrefixes.cellSteamCracked3
         };
-        GT_Fluid uncrackedFluid = null;
+        final Fluid uncrackedFluid;
         if (aMaterial.mFluid != null) {
-            uncrackedFluid = (GT_Fluid) aMaterial.mFluid;
+            uncrackedFluid = aMaterial.mFluid;
         } else if (aMaterial.mGas != null) {
-            uncrackedFluid = (GT_Fluid) aMaterial.mGas;
-        }
+            uncrackedFluid = aMaterial.mGas;
+        } else return;
         for (int i = 0; i < 3; i++) {
-            crackedFluids[i] = addFluid(
-                    namePrefixes[i] + aMaterial.mName.toLowerCase(Locale.ENGLISH),
-                    uncrackedFluid.mTextureName,
-                    orePrefixes[i].mLocalizedMaterialPre + aMaterial.mDefaultLocalName,
-                    null,
-                    aMaterial.mRGBa,
-                    2,
-                    775,
-                    GT_OreDictUnificator.get(orePrefixes[i], aMaterial, 1L),
-                    ItemList.Cell_Empty.get(1L),
-                    1000);
+            crackedFluids[i] = GT_FluidFactory.builder(namePrefixes[i] + aMaterial.mName.toLowerCase(Locale.ENGLISH))
+                    .withTextureFrom((IGT_Fluid) uncrackedFluid)
+                    .withLocalizedName(orePrefixes[i].mLocalizedMaterialPre + aMaterial.mDefaultLocalName)
+                    .withColorRGBA(aMaterial.mRGBa)
+                    .withStateAndTemperature(GAS, 775)
+                    .buildAndRegister()
+                    .registerBContainers(
+                            GT_OreDictUnificator.get(orePrefixes[i], aMaterial, 1L), ItemList.Cell_Empty.get(1L))
+                    .asFluid();
 
             GT_Values.RA.addCrackingRecipe(
                     i + 1,
@@ -2634,10 +2638,21 @@ public abstract class GT_Proxy implements IGT_Mod, IGuiHandler, IFuelHandler, IG
         aMaterial.setSteamCrackedFluids(crackedFluids);
     }
 
+    /**
+     * @deprecated use {@link IGT_Fluid#addFluid}
+     * @see GT_FluidFactory#of(String, String, Materials, FluidState, int)
+     * @see GT_FluidFactory#of(String, String, FluidState, int)
+     */
+    @Deprecated
     public Fluid addFluid(String aName, String aLocalized, Materials aMaterial, int aState, int aTemperatureK) {
         return addFluid(aName, aLocalized, aMaterial, aState, aTemperatureK, null, null, 0);
     }
 
+    /**
+     * @deprecated use {@link IGT_Fluid#addFluid}
+     * @see GT_FluidFactory#builder
+     */
+    @Deprecated
     public Fluid addFluid(
             String aName,
             String aLocalized,
@@ -2660,6 +2675,11 @@ public abstract class GT_Proxy implements IGT_Mod, IGuiHandler, IFuelHandler, IG
                 aFluidAmount);
     }
 
+    /**
+     * @deprecated use {@link IGT_Fluid#addFluid}
+     * @see GT_FluidFactory#builder
+     */
+    @Deprecated
     public Fluid addFluid(
             String aName,
             String aTexture,