refactor: make resource list interface immutable

Introduce MutableResourceList for additional operations.
refinedmods · Sep 4, 2024 · 2c5c54b · 2c5c54b
1 parent f05e10a
commit 2c5c54b
Show file tree

Hide file tree

Showing 38 changed files with 244 additions and 227 deletions.
diff --git a/.../main/java/com/refinedmods/refinedstorage/common/autocrafting/ProcessingPatternState.java b/.../main/java/com/refinedmods/refinedstorage/common/autocrafting/ProcessingPatternState.java
@@ -1,8 +1,8 @@
 package com.refinedmods.refinedstorage.common.autocrafting;
 
 import com.refinedmods.refinedstorage.api.resource.ResourceAmount;
-import com.refinedmods.refinedstorage.api.resource.list.ResourceList;
-import com.refinedmods.refinedstorage.api.resource.list.ResourceListImpl;
+import com.refinedmods.refinedstorage.api.resource.list.MutableResourceList;
+import com.refinedmods.refinedstorage.api.resource.list.MutableResourceListImpl;
 import com.refinedmods.refinedstorage.common.support.resource.ResourceCodecs;
 
 import java.util.ArrayList;
@@ -35,13 +35,13 @@ public record ProcessingPatternState(
         );
 
     List<ResourceAmount> getFlatInputs() {
-        final ResourceList list = ResourceListImpl.orderPreserving();
+        final MutableResourceList list = MutableResourceListImpl.orderPreserving();
         inputs.forEach(input -> input.map(Input::input).ifPresent(list::add));
         return new ArrayList<>(list.copyState());
     }
 
     List<ResourceAmount> getFlatOutputs() {
-        final ResourceList list = ResourceListImpl.orderPreserving();
+        final MutableResourceList list = MutableResourceListImpl.orderPreserving();
         outputs.forEach(output -> output.ifPresent(list::add));
         return new ArrayList<>(list.copyState());
     }

diff --git a/...n/src/main/java/com/refinedmods/refinedstorage/common/grid/CraftingGridContainerMenu.java b/...n/src/main/java/com/refinedmods/refinedstorage/common/grid/CraftingGridContainerMenu.java
@@ -3,6 +3,7 @@
 import com.refinedmods.refinedstorage.api.grid.view.GridResource;
 import com.refinedmods.refinedstorage.api.grid.view.GridView;
 import com.refinedmods.refinedstorage.api.resource.ResourceKey;
+import com.refinedmods.refinedstorage.api.resource.list.MutableResourceList;
 import com.refinedmods.refinedstorage.api.resource.list.ResourceList;
 import com.refinedmods.refinedstorage.common.content.Menus;
 import com.refinedmods.refinedstorage.common.grid.view.ItemGridResource;
@@ -128,13 +129,13 @@ public void clear(final boolean toPlayerInventory) {
 
     @API(status = API.Status.INTERNAL)
     public ResourceList getAvailableListForRecipeTransfer() {
-        final ResourceList available = getView().copyBackingList();
+        final MutableResourceList available = getView().copyBackingList();
         addContainerToList(craftingGrid.getCraftingMatrix(), available);
         addContainerToList(gridPlayer.getInventory(), available);
         return available;
     }
 
-    private void addContainerToList(final Container container, final ResourceList available) {
+    private void addContainerToList(final Container container, final MutableResourceList available) {
         for (int i = 0; i < container.getContainerSize(); ++i) {
             final ItemStack stack = container.getItem(i);
             if (stack.isEmpty()) {

diff --git a/...in/java/com/refinedmods/refinedstorage/common/grid/SnapshotCraftingGridRefillContext.java b/...in/java/com/refinedmods/refinedstorage/common/grid/SnapshotCraftingGridRefillContext.java
@@ -2,8 +2,8 @@
 
 import com.refinedmods.refinedstorage.api.core.Action;
 import com.refinedmods.refinedstorage.api.resource.ResourceKey;
-import com.refinedmods.refinedstorage.api.resource.list.ResourceList;
-import com.refinedmods.refinedstorage.api.resource.list.ResourceListImpl;
+import com.refinedmods.refinedstorage.api.resource.list.MutableResourceList;
+import com.refinedmods.refinedstorage.api.resource.list.MutableResourceListImpl;
 import com.refinedmods.refinedstorage.api.storage.root.RootStorage;
 import com.refinedmods.refinedstorage.common.api.storage.PlayerActor;
 import com.refinedmods.refinedstorage.common.support.RecipeMatrixContainer;
@@ -15,8 +15,8 @@
 class SnapshotCraftingGridRefillContext implements CraftingGridRefillContext {
     private final PlayerActor playerActor;
     private final CraftingGridBlockEntity blockEntity;
-    private final ResourceList available = ResourceListImpl.create();
-    private final ResourceList used = ResourceListImpl.create();
+    private final MutableResourceList available = MutableResourceListImpl.create();
+    private final MutableResourceList used = MutableResourceListImpl.create();
 
     SnapshotCraftingGridRefillContext(
         final Player player,

diff --git a/.../src/main/java/com/refinedmods/refinedstorage/common/support/network/ResourceSorters.java b/.../src/main/java/com/refinedmods/refinedstorage/common/support/network/ResourceSorters.java
@@ -3,8 +3,9 @@
 import com.refinedmods.refinedstorage.api.network.Network;
 import com.refinedmods.refinedstorage.api.network.storage.StorageNetworkComponent;
 import com.refinedmods.refinedstorage.api.resource.ResourceKey;
+import com.refinedmods.refinedstorage.api.resource.list.MutableResourceList;
+import com.refinedmods.refinedstorage.api.resource.list.MutableResourceListImpl;
 import com.refinedmods.refinedstorage.api.resource.list.ResourceList;
-import com.refinedmods.refinedstorage.api.resource.list.ResourceListImpl;
 import com.refinedmods.refinedstorage.common.support.resource.ItemResource;
 
 import java.util.Comparator;
@@ -25,19 +26,20 @@ public static Comparator<ResourceKey> create(@Nullable final Network network, fi
     public static <T> Comparator<T> create(@Nullable final Network network,
                                            final Inventory playerInventory,
                                            final Function<T, ResourceKey> resourceExtractor) {
-        final ResourceList available = ResourceListImpl.create();
+        final MutableResourceList available = MutableResourceListImpl.create();
         addNetworkItemsIntoList(network, available);
         addPlayerInventoryItemsIntoList(playerInventory, available);
         return sortByHighestAvailableFirst(available, resourceExtractor);
     }
 
-    private static void addNetworkItemsIntoList(@Nullable final Network network, final ResourceList list) {
+    private static void addNetworkItemsIntoList(@Nullable final Network network, final MutableResourceList list) {
         if (network != null) {
             network.getComponent(StorageNetworkComponent.class).getAll().forEach(list::add);
         }
     }
 
-    private static void addPlayerInventoryItemsIntoList(final Inventory playerInventory, final ResourceList list) {
+    private static void addPlayerInventoryItemsIntoList(final Inventory playerInventory,
+                                                        final MutableResourceList list) {
         for (int i = 0; i < playerInventory.getContainerSize(); ++i) {
             final ItemStack playerInventoryStack = playerInventory.getItem(i);
             if (playerInventoryStack.isEmpty()) {

diff --git a/...mods/refinedstorage/common/support/network/component/PlatformStorageNetworkComponent.java b/...mods/refinedstorage/common/support/network/component/PlatformStorageNetworkComponent.java
@@ -2,7 +2,7 @@
 
 import com.refinedmods.refinedstorage.api.network.impl.storage.StorageNetworkComponentImpl;
 import com.refinedmods.refinedstorage.api.resource.ResourceKey;
-import com.refinedmods.refinedstorage.api.resource.list.ResourceListImpl;
+import com.refinedmods.refinedstorage.api.resource.list.MutableResourceListImpl;
 import com.refinedmods.refinedstorage.common.api.storage.root.FuzzyRootStorage;
 import com.refinedmods.refinedstorage.common.api.support.resource.list.FuzzyResourceList;
 import com.refinedmods.refinedstorage.common.support.resource.list.FuzzyResourceListImpl;
@@ -13,10 +13,10 @@ public class PlatformStorageNetworkComponent extends StorageNetworkComponentImpl
     private final FuzzyResourceList fuzzyResourceList;
 
     public PlatformStorageNetworkComponent() {
-        this(new FuzzyResourceListImpl(ResourceListImpl.create()));
+        this(new FuzzyResourceListImpl(MutableResourceListImpl.create()));
     }
 
-    private PlatformStorageNetworkComponent(final FuzzyResourceList fuzzyResourceList) {
+    private PlatformStorageNetworkComponent(final FuzzyResourceListImpl fuzzyResourceList) {
         super(fuzzyResourceList);
         this.fuzzyResourceList = fuzzyResourceList;
     }

diff --git a/...va/com/refinedmods/refinedstorage/common/support/resource/list/FuzzyResourceListImpl.java b/...va/com/refinedmods/refinedstorage/common/support/resource/list/FuzzyResourceListImpl.java
@@ -1,8 +1,8 @@
 package com.refinedmods.refinedstorage.common.support.resource.list;
 
 import com.refinedmods.refinedstorage.api.resource.ResourceKey;
-import com.refinedmods.refinedstorage.api.resource.list.AbstractProxyResourceList;
-import com.refinedmods.refinedstorage.api.resource.list.ResourceList;
+import com.refinedmods.refinedstorage.api.resource.list.AbstractProxyMutableResourceList;
+import com.refinedmods.refinedstorage.api.resource.list.MutableResourceList;
 import com.refinedmods.refinedstorage.common.api.support.resource.FuzzyModeNormalizer;
 import com.refinedmods.refinedstorage.common.api.support.resource.list.FuzzyResourceList;
 
@@ -14,10 +14,10 @@
 import java.util.Optional;
 import java.util.Set;
 
-public class FuzzyResourceListImpl extends AbstractProxyResourceList implements FuzzyResourceList {
+public class FuzzyResourceListImpl extends AbstractProxyMutableResourceList implements FuzzyResourceList {
     private final Map<ResourceKey, Set<ResourceKey>> normalizedFuzzyMap = new HashMap<>();
 
-    public FuzzyResourceListImpl(final ResourceList delegate) {
+    public FuzzyResourceListImpl(final MutableResourceList delegate) {
         super(delegate);
     }
 

diff --git a/...om/refinedmods/refinedstorage/common/support/resource/list/FuzzyResourceListImplTest.java b/...om/refinedmods/refinedstorage/common/support/resource/list/FuzzyResourceListImplTest.java
@@ -1,9 +1,8 @@
 package com.refinedmods.refinedstorage.common.support.resource.list;
 
 import com.refinedmods.refinedstorage.api.resource.ResourceKey;
-import com.refinedmods.refinedstorage.api.resource.list.ResourceListImpl;
+import com.refinedmods.refinedstorage.api.resource.list.MutableResourceListImpl;
 import com.refinedmods.refinedstorage.common.SetupMinecraft;
-import com.refinedmods.refinedstorage.common.api.support.resource.list.FuzzyResourceList;
 import com.refinedmods.refinedstorage.common.support.resource.ItemResource;
 
 import java.util.Collection;
@@ -28,11 +27,11 @@ class FuzzyResourceListImplTest {
     private static final ItemResource DUMMY_D = new ItemResource(Items.GLASS, DataComponentPatch.EMPTY);
     private static final ItemResource DUMMY_E = new ItemResource(Items.DARK_OAK_DOOR, DataComponentPatch.EMPTY);
 
-    FuzzyResourceList sut;
+    FuzzyResourceListImpl sut;
 
     @BeforeEach
     void setUp() {
-        sut = new FuzzyResourceListImpl(ResourceListImpl.create());
+        sut = new FuzzyResourceListImpl(MutableResourceListImpl.create());
     }
 
     @Test

diff --git a/...storage-grid-api/src/main/java/com/refinedmods/refinedstorage/api/grid/view/GridView.java b/...storage-grid-api/src/main/java/com/refinedmods/refinedstorage/api/grid/view/GridView.java
@@ -1,7 +1,7 @@
 package com.refinedmods.refinedstorage.api.grid.view;
 
 import com.refinedmods.refinedstorage.api.resource.ResourceKey;
-import com.refinedmods.refinedstorage.api.resource.list.ResourceList;
+import com.refinedmods.refinedstorage.api.resource.list.MutableResourceList;
 import com.refinedmods.refinedstorage.api.storage.tracked.TrackedResource;
 
 import java.util.List;
@@ -100,7 +100,7 @@ public interface GridView {
     /**
      * @return a copy of the backing list
      */
-    ResourceList copyBackingList();
+    MutableResourceList copyBackingList();
 
     /**
      * Clears the backing list, view list and tracked resources index.

diff --git a/...d-api/src/main/java/com/refinedmods/refinedstorage/api/grid/view/GridViewBuilderImpl.java b/...d-api/src/main/java/com/refinedmods/refinedstorage/api/grid/view/GridViewBuilderImpl.java
@@ -1,8 +1,8 @@
 package com.refinedmods.refinedstorage.api.grid.view;
 
 import com.refinedmods.refinedstorage.api.resource.ResourceKey;
-import com.refinedmods.refinedstorage.api.resource.list.ResourceList;
-import com.refinedmods.refinedstorage.api.resource.list.ResourceListImpl;
+import com.refinedmods.refinedstorage.api.resource.list.MutableResourceList;
+import com.refinedmods.refinedstorage.api.resource.list.MutableResourceListImpl;
 import com.refinedmods.refinedstorage.api.storage.tracked.TrackedResource;
 
 import java.util.HashMap;
@@ -16,7 +16,7 @@
 @API(status = API.Status.STABLE, since = "2.0.0-milestone.2.4")
 public class GridViewBuilderImpl implements GridViewBuilder {
     private final GridResourceFactory resourceFactory;
-    private final ResourceList backingList = ResourceListImpl.create();
+    private final MutableResourceList backingList = MutableResourceListImpl.create();
     private final Set<ResourceKey> craftableResources = new HashSet<>();
     private final Map<ResourceKey, TrackedResource> trackedResources = new HashMap<>();
     private final GridSortingType identitySortingType;

diff --git a/...age-grid-api/src/main/java/com/refinedmods/refinedstorage/api/grid/view/GridViewImpl.java b/...age-grid-api/src/main/java/com/refinedmods/refinedstorage/api/grid/view/GridViewImpl.java
@@ -2,7 +2,7 @@
 
 import com.refinedmods.refinedstorage.api.core.CoreValidations;
 import com.refinedmods.refinedstorage.api.resource.ResourceKey;
-import com.refinedmods.refinedstorage.api.resource.list.ResourceList;
+import com.refinedmods.refinedstorage.api.resource.list.MutableResourceList;
 import com.refinedmods.refinedstorage.api.storage.tracked.TrackedResource;
 
 import java.util.ArrayList;
@@ -24,7 +24,7 @@
 public class GridViewImpl implements GridView {
     private static final Logger LOGGER = LoggerFactory.getLogger(GridViewImpl.class);
 
-    private final ResourceList backingList;
+    private final MutableResourceList backingList;
     private final Comparator<GridResource> identitySort;
     private final GridResourceFactory resourceFactory;
     private final Map<ResourceKey, TrackedResource> trackedResources = new HashMap<>();
@@ -47,7 +47,7 @@ public class GridViewImpl implements GridView {
      * @param craftableResources      resources which are craftable and must stay in the view list
      */
     public GridViewImpl(final GridResourceFactory resourceFactory,
-                        final ResourceList backingList,
+                        final MutableResourceList backingList,
                         final Map<ResourceKey, TrackedResource> initialTrackedResources,
                         final Set<ResourceKey> craftableResources,
                         final GridSortingType identitySortingType,
@@ -156,7 +156,7 @@ public void onChange(final ResourceKey resource,
                          final long amount,
                          @Nullable final TrackedResource trackedResource) {
         final boolean wasAvailable = backingList.contains(resource);
-        final ResourceList.OperationResult operationResult = updateBackingList(resource, amount);
+        final MutableResourceList.OperationResult operationResult = updateBackingList(resource, amount);
         updateOrRemoveTrackedResource(resource, trackedResource);
         final GridResource gridResource = viewList.index.get(resource);
         if (gridResource != null) {
@@ -172,7 +172,7 @@ public void onChange(final ResourceKey resource,
         }
     }
 
-    private ResourceList.OperationResult updateBackingList(final ResourceKey resource, final long amount) {
+    private MutableResourceList.OperationResult updateBackingList(final ResourceKey resource, final long amount) {
         if (amount < 0) {
             return backingList.remove(resource, Math.abs(amount)).orElseThrow(RuntimeException::new);
         } else {
@@ -204,7 +204,7 @@ private void reinsertIntoViewList(final ResourceKey resource, final GridResource
     }
 
     private void handleChangeForExistingResource(final ResourceKey resource,
-                                                 final ResourceList.OperationResult operationResult,
+                                                 final MutableResourceList.OperationResult operationResult,
                                                  final GridResource gridResource) {
         final boolean noLongerAvailable = !operationResult.available();
         final boolean canBeSorted = !preventSorting;
@@ -283,7 +283,7 @@ public List<GridResource> getViewList() {
     }
 
     @Override
-    public ResourceList copyBackingList() {
+    public MutableResourceList copyBackingList() {
         return backingList.copy();
     }
 

diff --git a/.../src/test/java/com/refinedmods/refinedstorage/api/grid/query/GridQueryParserImplTest.java b/.../src/test/java/com/refinedmods/refinedstorage/api/grid/query/GridQueryParserImplTest.java
@@ -6,7 +6,7 @@
 import com.refinedmods.refinedstorage.api.grid.view.GridResourceImpl;
 import com.refinedmods.refinedstorage.api.grid.view.GridView;
 import com.refinedmods.refinedstorage.api.grid.view.GridViewImpl;
-import com.refinedmods.refinedstorage.api.resource.list.ResourceListImpl;
+import com.refinedmods.refinedstorage.api.resource.list.MutableResourceListImpl;
 import com.refinedmods.refinedstorage.api.storage.tracked.TrackedResource;
 import com.refinedmods.refinedstorage.query.lexer.LexerTokenMappings;
 import com.refinedmods.refinedstorage.query.parser.ParserOperatorMappings;
@@ -35,7 +35,7 @@ class GridQueryParserImplTest {
 
     private final GridView view = new GridViewImpl(
         (resource, craftable) -> Optional.of(new GridResourceImpl(resource)),
-        ResourceListImpl.create(),
+        MutableResourceListImpl.create(),
         new HashMap<>(),
         new HashSet<>(),
         v -> Comparator.comparing(GridResource::getName),

diff --git a/...nedstorage-neoforge/src/test/java/com/refinedmods/refinedstorage/common/GameTestUtil.java b/...nedstorage-neoforge/src/test/java/com/refinedmods/refinedstorage/common/GameTestUtil.java
@@ -6,8 +6,9 @@
 import com.refinedmods.refinedstorage.api.network.storage.StorageNetworkComponent;
 import com.refinedmods.refinedstorage.api.resource.ResourceAmount;
 import com.refinedmods.refinedstorage.api.resource.ResourceKey;
+import com.refinedmods.refinedstorage.api.resource.list.MutableResourceList;
+import com.refinedmods.refinedstorage.api.resource.list.MutableResourceListImpl;
 import com.refinedmods.refinedstorage.api.resource.list.ResourceList;
-import com.refinedmods.refinedstorage.api.resource.list.ResourceListImpl;
 import com.refinedmods.refinedstorage.api.storage.EmptyActor;
 import com.refinedmods.refinedstorage.common.api.support.network.AbstractNetworkNodeContainerBlockEntity;
 import com.refinedmods.refinedstorage.common.api.support.resource.ResourceContainer;
@@ -238,7 +239,7 @@ private static Runnable resourceContainerContainsExactly(final ResourceContainer
                                                              final ResourceAmount... expected) {
         final ResourceList expectedList = toResourceList(expected);
         return () -> {
-            final ResourceList given = ResourceListImpl.create();
+            final MutableResourceList given = MutableResourceListImpl.create();
             for (int i = 0; i < container.size(); i++) {
                 final ResourceAmount item = container.get(i);
                 if (item != null) {
@@ -255,7 +256,7 @@ public static Runnable containerContainsExactly(final GameTestHelper helper,
         final var containerBlockEntity = requireBlockEntity(helper, pos, BaseContainerBlockEntity.class);
         final ResourceList expectedList = toResourceList(expected);
         return () -> {
-            final ResourceList given = ResourceListImpl.create();
+            final MutableResourceList given = MutableResourceListImpl.create();
             for (int i = 0; i < containerBlockEntity.getContainerSize(); i++) {
                 final ItemStack itemStack = containerBlockEntity.getItem(i);
                 if (!itemStack.isEmpty()) {
@@ -281,7 +282,7 @@ private static ResourceList toResourceList(final ResourceAmount... resources) {
     }
 
     private static ResourceList toResourceList(final Collection<ResourceAmount> resources) {
-        final ResourceList list = ResourceListImpl.create();
+        final MutableResourceList list = MutableResourceListImpl.create();
         for (final ResourceAmount resource : resources) {
             list.add(resource);
         }

diff --git a/...k-test/src/main/java/com/refinedmods/refinedstorage/network/test/NetworkTestFixtures.java b/...k-test/src/main/java/com/refinedmods/refinedstorage/network/test/NetworkTestFixtures.java
@@ -15,7 +15,7 @@
 import com.refinedmods.refinedstorage.api.network.security.SecurityNetworkComponent;
 import com.refinedmods.refinedstorage.api.network.security.SecurityPolicy;
 import com.refinedmods.refinedstorage.api.network.storage.StorageNetworkComponent;
-import com.refinedmods.refinedstorage.api.resource.list.ResourceListImpl;
+import com.refinedmods.refinedstorage.api.resource.list.MutableResourceListImpl;
 import com.refinedmods.refinedstorage.network.test.fake.FakePermissions;
 
 public final class NetworkTestFixtures {
@@ -33,7 +33,7 @@ public final class NetworkTestFixtures {
         );
         NETWORK_COMPONENT_MAP_FACTORY.addFactory(
             StorageNetworkComponent.class,
-            network -> new StorageNetworkComponentImpl(ResourceListImpl.orderPreserving())
+            network -> new StorageNetworkComponentImpl(MutableResourceListImpl.orderPreserving())
         );
         NETWORK_COMPONENT_MAP_FACTORY.addFactory(
             SecurityNetworkComponent.class,

diff --git a/...n/java/com/refinedmods/refinedstorage/api/network/impl/node/relay/RelayOutputStorage.java b/...n/java/com/refinedmods/refinedstorage/api/network/impl/node/relay/RelayOutputStorage.java
@@ -6,7 +6,7 @@
 import com.refinedmods.refinedstorage.api.resource.ResourceKey;
 import com.refinedmods.refinedstorage.api.resource.filter.Filter;
 import com.refinedmods.refinedstorage.api.resource.filter.FilterMode;
-import com.refinedmods.refinedstorage.api.resource.list.ResourceList;
+import com.refinedmods.refinedstorage.api.resource.list.MutableResourceList;
 import com.refinedmods.refinedstorage.api.resource.list.listenable.ResourceListListener;
 import com.refinedmods.refinedstorage.api.storage.AccessMode;
 import com.refinedmods.refinedstorage.api.storage.Actor;
@@ -159,7 +159,7 @@ public long getStored() {
     }
 
     @Override
-    public void onChanged(final ResourceList.OperationResult change) {
+    public void onChanged(final MutableResourceList.OperationResult change) {
         if (delegate != null && delegate.contains(delegate)) {
             return;
         }