Add contract and get around return value not used warnings

FabricMC · Jan 31, 2025 · cd138b3 · cd138b3
1 parent bcbbb27
commit cd138b3
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 3 deletions.
diff --git a/...-v1/src/client/java/net/fabricmc/fabric/api/client/rendering/v1/LayeredDrawerWrapper.java b/...-v1/src/client/java/net/fabricmc/fabric/api/client/rendering/v1/LayeredDrawerWrapper.java
@@ -18,6 +18,8 @@
 
 import java.util.function.Function;
 
+import org.jetbrains.annotations.Contract;
+
 import net.minecraft.client.gui.LayeredDrawer;
 import net.minecraft.util.Identifier;
 
@@ -65,6 +67,7 @@ public interface LayeredDrawerWrapper {
 	 * @param layer the layer to add
 	 * @return this layered drawer
 	 */
+	@Contract("_ -> this")
 	LayeredDrawerWrapper addLayer(IdentifiedLayer layer);
 
 	/**
@@ -76,6 +79,7 @@ public interface LayeredDrawerWrapper {
 	 * @param layer      the layer to add
 	 * @return this layered drawer
 	 */
+	@Contract("_, _ -> this")
 	LayeredDrawerWrapper attachLayerBefore(Identifier beforeThis, IdentifiedLayer layer);
 
 	/**
@@ -88,6 +92,7 @@ public interface LayeredDrawerWrapper {
 	 * @param layer      the layer to add
 	 * @return this layered drawer
 	 */
+	@Contract("_, _, _ -> this")
 	default LayeredDrawerWrapper attachLayerBefore(Identifier beforeThis, Identifier identifier, LayeredDrawer.Layer layer) {
 		return attachLayerBefore(beforeThis, IdentifiedLayer.of(identifier, layer));
 	}
@@ -101,6 +106,7 @@ default LayeredDrawerWrapper attachLayerBefore(Identifier beforeThis, Identifier
 	 * @param layer     the layer to add
 	 * @return this layered drawer
 	 */
+	@Contract("_, _ -> this")
 	LayeredDrawerWrapper attachLayerAfter(Identifier afterThis, IdentifiedLayer layer);
 
 	/**
@@ -113,6 +119,7 @@ default LayeredDrawerWrapper attachLayerBefore(Identifier beforeThis, Identifier
 	 * @param layer      the layer to add
 	 * @return this layered drawer
 	 */
+	@Contract("_, _, _ -> this")
 	default LayeredDrawerWrapper attachLayerAfter(Identifier afterThis, Identifier identifier, LayeredDrawer.Layer layer) {
 		return attachLayerAfter(afterThis, IdentifiedLayer.of(identifier, layer));
 	}
@@ -123,6 +130,7 @@ default LayeredDrawerWrapper attachLayerAfter(Identifier afterThis, Identifier i
 	 * @param identifier the identifier of the layer to remove
 	 * @return this layered drawer
 	 */
+	@Contract("_ -> this")
 	LayeredDrawerWrapper removeLayer(Identifier identifier);
 
 	/**
@@ -134,5 +142,6 @@ default LayeredDrawerWrapper attachLayerAfter(Identifier afterThis, Identifier i
 	 * @param replacer   a function that takes the old layer and returns the new layer
 	 * @return this layered drawer
 	 */
+	@Contract("_, _ -> this")
 	LayeredDrawerWrapper replaceLayer(Identifier identifier, Function<IdentifiedLayer, IdentifiedLayer> replacer);
 }
diff --git a/...-v1/src/test/java/net/fabricmc/fabric/impl/client/rendering/LayeredDrawerWrapperTest.java b/...-v1/src/test/java/net/fabricmc/fabric/impl/client/rendering/LayeredDrawerWrapperTest.java
@@ -83,8 +83,8 @@ void removeLayer() {
 				.addLayer(testLayer("layer3"))
 				.addLayer(testLayer("layer4"));
 
-		layers.removeLayer(testIdentifier("layer2"));
-		layers.removeLayer(testIdentifier("layer4"));
+		layers.removeLayer(testIdentifier("layer2"))
+				.removeLayer(testIdentifier("layer4"));
 
 		assertOrder(base, List.of("layer1", "layer3"));
 	}
@@ -95,7 +95,8 @@ void replaceLayer() {
 				.addLayer(testLayer("layer2"))
 				.addLayer(testLayer("layer3"));
 
-		layers.replaceLayer(testIdentifier("layer2"), layer -> testLayer("replaced"));
+		layers.replaceLayer(testIdentifier("layer2"), layer -> testLayer("temp"))
+				.replaceLayer(testIdentifier("temp"), layer -> testLayer("replaced"));
 
 		assertOrder(base, List.of("layer1", "replaced", "layer3"));
 	}