Rename Component to CardinalComponent

Author: Pyrofab

cardinal-components-base/src/main/java/org/ladysnake/cca/api/v3/component/Component.java

@@ -1,55 +1,10 @@
-/*
- * Cardinal-Components-API
- * Copyright (C) 2019-2025 Ladysnake
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in all
- * copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
- * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
- * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
- * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
- * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
- * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE
- * OR OTHER DEALINGS IN THE SOFTWARE.
- */
 package org.ladysnake.cca.api.v3.component;
 
-import net.minecraft.nbt.CompoundTag;
-import net.minecraft.world.level.storage.ValueInput;
-import net.minecraft.world.level.storage.ValueOutput;
-import org.jetbrains.annotations.Contract;
+import org.ladysnake.cca.api.v8.component.CardinalComponent;
 
 /**
- * The base interface for components.
- *
- * @since 2.7.0
+ * @deprecated replâce with {@link org.ladysnake.cca.api.v8.component.CardinalComponent}
+ * (renamed because of collisions with Minecraft's other components)
  */
-public interface Component {
-
-    /**
-     * Reads this component's properties from a {@link CompoundTag}.
-     *
-     * @param readView a {@code NbtCompound} on which this component's serializable data has been written
-     * @implNote implementations should not assert that the data written on the tag corresponds to any
-     * specific scheme, as saved data is susceptible to external tempering, and may come from an earlier
-     * version.
-     */
-    @Contract(mutates = "this")
-    void readData(ValueInput readView);
-
-    /**
-     * Writes this component's properties to a {@link CompoundTag}.
-     *
-     * @param writeView a {@code NbtCompound} on which to write this component's serializable data
-     */
-    @Contract(mutates = "param1")
-    void writeData(ValueOutput writeView);
-}
+@Deprecated(since = "8.0.0")
+public interface Component extends CardinalComponent { }

cardinal-components-base/src/main/java/org/ladysnake/cca/api/v3/component/ComponentAccess.java

@@ -25,6 +25,7 @@
 import org.ladysnake.cca.api.v3.component.sync.AutoSyncedComponent;
 import org.ladysnake.cca.api.v3.component.sync.ComponentPacketWriter;
 import org.ladysnake.cca.api.v3.component.sync.PlayerSyncPredicate;
+import org.ladysnake.cca.api.v8.component.CardinalComponent;
 
 import java.util.NoSuchElementException;
 
@@ -45,7 +46,7 @@ public interface ComponentAccess {
      * @throws NullPointerException if {@code key} is null
      * @throws NoSuchElementException if this provider does not provide the desired type of component
      */
-    default <C extends Component> C getComponent(ComponentKey<C> key) {
+    default <C extends CardinalComponent> C getComponent(ComponentKey<C> key) {
         return key.get(this.asComponentProvider());
     }
 

cardinal-components-base/src/main/java/org/ladysnake/cca/api/v3/component/ComponentContainer.java

@@ -23,8 +23,8 @@
 package org.ladysnake.cca.api.v3.component;
 
 import net.fabricmc.api.EnvType;
-import net.minecraft.nbt.CompoundTag;
 import net.minecraft.core.HolderLookup;
+import net.minecraft.nbt.CompoundTag;
 import net.minecraft.world.level.storage.ValueInput;
 import net.minecraft.world.level.storage.ValueOutput;
 import org.jetbrains.annotations.ApiStatus;
@@ -39,6 +39,7 @@
 import org.ladysnake.cca.api.v3.component.tick.ServerTickingComponent;
 import org.ladysnake.cca.api.v3.util.CheckEnvironment;
 import org.ladysnake.cca.api.v3.util.NbtSerializable;
+import org.ladysnake.cca.api.v8.component.CardinalComponent;
 import org.ladysnake.cca.internal.base.GenericContainerBuilder;
 import org.ladysnake.cca.internal.base.asm.AsmGeneratedCallback;
 import org.ladysnake.cca.internal.base.asm.StaticComponentPluginBase;
@@ -101,7 +102,7 @@ public interface ComponentContainer extends NbtSerializable {
      */
     @Nullable
     @ApiStatus.Experimental
-    default ComponentKey<?> getKey(Component component) {
+    default ComponentKey<?> getKey(CardinalComponent component) {
         for (ComponentKey<?> key : keys()) {
             if (key.getInternal(this) == component) {
                 return key;
@@ -218,18 +219,18 @@ final class Builder<T> extends GenericContainerBuilder<ComponentFactory<T, ?>, F
             }
 
             @Contract(mutates = "this")
-            public <C extends Component> Builder<T> component(ComponentKey<C> key, ComponentFactory<T, ? extends C> factory) {
+            public <C extends CardinalComponent> Builder<T> component(ComponentKey<C> key, ComponentFactory<T, ? extends C> factory) {
                 return this.component(key, key.getComponentClass(), factory);
             }
 
             @Contract(mutates = "this")
-            public <C extends Component> Builder<T> component(ComponentKey<? super C> key, Class<C> implClass, ComponentFactory<T, ? extends C> factory) {
+            public <C extends CardinalComponent> Builder<T> component(ComponentKey<? super C> key, Class<C> implClass, ComponentFactory<T, ? extends C> factory) {
                 return this.component(key, implClass, factory, Set.of());
             }
 
             @ApiStatus.Experimental
             @Contract(mutates = "this")
-            public <C extends Component> Builder<T> component(ComponentKey<? super C> key, Class<C> implClass, ComponentFactory<T, ? extends C> factory, Set<ComponentKey<?>> dependencies) {
+            public <C extends CardinalComponent> Builder<T> component(ComponentKey<? super C> key, Class<C> implClass, ComponentFactory<T, ? extends C> factory, Set<ComponentKey<?>> dependencies) {
                 super.component(key, implClass, factory, dependencies);
                 return this;
             }

cardinal-components-base/src/main/java/org/ladysnake/cca/api/v3/component/ComponentFactory.java

@@ -23,24 +23,25 @@
 package org.ladysnake.cca.api.v3.component;
 
 import org.jetbrains.annotations.Contract;
+import org.ladysnake.cca.api.v8.component.CardinalComponent;
 
 /**
  * A single-arg component factory.
  *
- * <p>When invoked, the factory must return a {@link Component} of the right type.
+ * <p>When invoked, the factory must return a {@link CardinalComponent} of the right type.
  *
  * @since 3.0.0
  */
 @FunctionalInterface
-public interface ComponentFactory<T, C extends Component> {
+public interface ComponentFactory<T, C extends CardinalComponent> {
     /**
-     * Instantiates a {@link Component} for the given provider.
+     * Instantiates a {@link CardinalComponent} for the given provider.
      *
      * <p>The component returned by this method will be available
      * on the provider as soon as all component factories have been invoked.
      *
      * @param t the factory argument
-     * @return a new {@link Component}
+     * @return a new {@link CardinalComponent}
      */
     @Contract(value = "_ -> new", pure = true)
     C createComponent(T t);

cardinal-components-base/src/main/java/org/ladysnake/cca/api/v3/component/ComponentKey.java

@@ -36,6 +36,7 @@
 import org.ladysnake.cca.api.v3.component.sync.AutoSyncedComponent;
 import org.ladysnake.cca.api.v3.component.sync.ComponentPacketWriter;
 import org.ladysnake.cca.api.v3.component.sync.PlayerSyncPredicate;
+import org.ladysnake.cca.api.v8.component.CardinalComponent;
 import org.ladysnake.cca.internal.base.ComponentsInternals;
 import org.ladysnake.cca.internal.base.asm.CcaBootstrap;
 
@@ -46,15 +47,15 @@
 import static net.minecraft.network.chat.Component.literal;
 
 /**
- * A key for retrieving {@link Component} instances from component providers.
+ * A key for retrieving {@link CardinalComponent} instances from component providers.
  *
  * <p> A {@link ComponentKey} must be registered for every component type through
  * {@link ComponentRegistryV3#getOrCreate(Identifier, Class)}.
  *
  * @see ComponentRegistryV3
  */
 @ApiStatus.NonExtendable
-public abstract class ComponentKey<C extends Component> {
+public abstract class ComponentKey<C extends CardinalComponent> {
 
     public final Identifier getId() {
         return this.id;

cardinal-components-base/src/main/java/org/ladysnake/cca/api/v3/component/ComponentRegistry.java

@@ -25,6 +25,7 @@
 import net.minecraft.resources.Identifier;
 import org.jetbrains.annotations.ApiStatus;
 import org.jetbrains.annotations.Contract;
+import org.ladysnake.cca.api.v8.component.CardinalComponent;
 import org.ladysnake.cca.internal.base.ComponentRegistryImpl;
 
 import javax.annotation.Nullable;
@@ -36,7 +37,7 @@
  * <p> A {@code ComponentRegistry} is used for registering components and obtaining
  * {@link ComponentKey} instances serving as keys for those components.
  *
- * @see Component
+ * @see CardinalComponent
  * @see ComponentKey
  * @since 2.7.0
  */
@@ -66,13 +67,13 @@ public final class ComponentRegistry {
      * @param componentId    a unique identifier for the registered component type
      * @param componentClass the interface or class of which to obtain a {@link ComponentKey}
      * @return a shared instance of {@link ComponentKey}
-     * @throws IllegalArgumentException if {@code componentClass} does not extend {@link Component}
+     * @throws IllegalArgumentException if {@code componentClass} does not extend {@link CardinalComponent}
      * @throws IllegalStateException    if a different component class has been registered with the same {@code componentId},
      *                                  or if {@code componentId} has not been statically declared as a custom data value.
      * @apiNote It is recommended that {@code componentClass} be an interface, so that other
      * mods can interact with a well-defined API rather than directly accessing internals.
      */
-    public static <C extends Component> ComponentKey<C> getOrCreate(Identifier componentId, Class<C> componentClass) {
+    public static <C extends CardinalComponent> ComponentKey<C> getOrCreate(Identifier componentId, Class<C> componentClass) {
         return ComponentRegistryV3.INSTANCE.getOrCreate(componentId, componentClass);
     }
 

cardinal-components-base/src/main/java/org/ladysnake/cca/api/v3/component/ComponentRegistryV3.java

@@ -25,6 +25,7 @@
 import net.minecraft.resources.Identifier;
 import org.jetbrains.annotations.ApiStatus;
 import org.jetbrains.annotations.Contract;
+import org.ladysnake.cca.api.v8.component.CardinalComponent;
 import org.ladysnake.cca.internal.base.ComponentRegistryImpl;
 
 import javax.annotation.Nullable;
@@ -37,7 +38,7 @@
  * {@link ComponentKey} instances serving as keys for those components.
  *
  * @see ComponentKey
- * @see Component
+ * @see CardinalComponent
  * @see ComponentRegistry
  * @since 2.5.0
  */
@@ -72,13 +73,13 @@ public interface ComponentRegistryV3 {
      * @param componentId    a unique identifier for the registered component type
      * @param componentClass the interface or class of which to obtain a {@link ComponentKey}
      * @return a shared instance of {@link ComponentKey}
-     * @throws IllegalArgumentException if {@code componentClass} does not extend {@link Component}
+     * @throws IllegalArgumentException if {@code componentClass} does not extend {@link CardinalComponent}
      * @throws IllegalStateException    if a different component class has been registered with the same {@code componentId},
      *                                  or if {@code componentId} has not been statically declared as a custom data value.
      * @apiNote It is recommended that {@code componentClass} be an interface, so that other
      * mods can interact with a well-defined API rather than directly accessing internals.
      */
-    <C extends Component> ComponentKey<C> getOrCreate(Identifier componentId, Class<C> componentClass);
+    <C extends CardinalComponent> ComponentKey<C> getOrCreate(Identifier componentId, Class<C> componentClass);
 
     /**
      * Directly retrieves a ComponentKey using its id.

cardinal-components-base/src/main/java/org/ladysnake/cca/api/v3/component/ComponentV3.java

@@ -23,6 +23,7 @@
 package org.ladysnake.cca.api.v3.component;
 
 import net.minecraft.world.item.ItemStack;
+import org.ladysnake.cca.api.v8.component.CardinalComponent;
 
 /**
  * The base interface for components.
@@ -33,6 +34,6 @@
  *
  * @since 2.5.0
  */
-public interface ComponentV3 extends Component {
+public interface ComponentV3 extends CardinalComponent {
 
 }

cardinal-components-base/src/main/java/org/ladysnake/cca/api/v3/component/CopyableComponent.java

@@ -22,21 +22,22 @@
  */
 package org.ladysnake.cca.api.v3.component;
 
-import net.minecraft.nbt.CompoundTag;
 import net.minecraft.core.HolderLookup;
+import net.minecraft.nbt.CompoundTag;
+import org.ladysnake.cca.api.v8.component.CardinalComponent;
 
 /**
  * A component that can copy its data from another component of the same type.
  *
  * @param <C> the type of components that this component may copy
  * @since 2.3.0
  */
-public interface CopyableComponent<C extends Component> extends Component {
+public interface CopyableComponent<C extends CardinalComponent> extends CardinalComponent {
     /**
      * Copies the data from {@code other} into {@code this}.
      *
-     * @implSpec The default implementation {@linkplain Component#writeData(net.minecraft.world.level.storage.ValueOutput) serializes}
-     * the component data to a {@link CompoundTag} and calls {@link Component#readData(net.minecraft.world.level.storage.ValueInput)}.
+     * @implSpec The default implementation {@linkplain CardinalComponent#writeData(net.minecraft.world.level.storage.ValueOutput) serializes}
+     * the component data to a {@link CompoundTag} and calls {@link CardinalComponent#readData(net.minecraft.world.level.storage.ValueInput)}.
      * @implNote The default implementation should generally be overridden.
      * The serialization done by the default implementation assumes NBT consistency
      * between implementations, and is generally slower than a direct copy.

cardinal-components-base/src/main/java/org/ladysnake/cca/api/v3/component/TransientComponent.java

@@ -25,11 +25,12 @@
 import net.minecraft.world.level.storage.ValueInput;
 import net.minecraft.world.level.storage.ValueOutput;
 import org.jetbrains.annotations.Nullable;
+import org.ladysnake.cca.api.v8.component.CardinalComponent;
 
 /**
  * Utility interface for components that do not hold any data
  */
-public interface TransientComponent extends Component {
+public interface TransientComponent extends CardinalComponent {
     @Override
     default void readData(ValueInput readView) {
         // Nothing to read