Introduce RegistryValue & DefaultedTaggable, move some things around

Author: MrHell228

src/main/java/org/spongepowered/api/registry/DefaultedRegistryValue.java

@@ -26,25 +26,52 @@
 
 import org.spongepowered.api.ResourceKey;
 
-import java.util.Objects;
 import java.util.Optional;
 
 /**
- * A Utility marker that assists in getting a {@link ResourceKey} for values that generally can be
- * within a {@link DefaultedRegistryType defaulted registry}.
+ * A {@link RegistryValue} that usually resides in a single {@link RegistryType}
+ * and such this registry can be considered as "default".
  */
-@SuppressWarnings("unchecked")
-public interface DefaultedRegistryValue {
+public interface DefaultedRegistryValue<T extends DefaultedRegistryValue<T>> extends RegistryValue<T> {
 
-    default <T> ResourceKey key(final DefaultedRegistryType<T> type) {
-        return Objects.requireNonNull(type, "type").get().valueKey((T) this);
+    /**
+     * Gets the default {@link RegistryType} for
+     * the type that implements this interface.
+     *
+     * @return The {@link RegistryType}
+     */
+    DefaultedRegistryType<T> registryType();
+
+    /**
+     * Returns the {@link ResourceKey} associated with
+     * this object in the default {@link #registryType()}.
+     *
+     * @return The {@link ResourceKey} associated with
+     * this object in the default {@link #registryType()}
+     */
+    default ResourceKey registryKey() {
+        return this.key(this.registryType());
     }
 
-    default <T> Optional<ResourceKey> findKey(final DefaultedRegistryType<T> type) {
-        return Objects.requireNonNull(type, "type").find().flatMap(r -> r.findValueKey((T) this));
+    /**
+     * Returns the {@link ResourceKey} associated with
+     * this object in the default {@link #registryType()}, if found.
+     *
+     * @return The {@link ResourceKey} associated with
+     * this object in the default {@link #registryType()}, if found
+     */
+    default Optional<ResourceKey> findRegistryKey() {
+        return this.findKey(this.registryType());
     }
 
-    default <T> DefaultedRegistryReference<T> asDefaultedReference(final DefaultedRegistryType<T> type) {
-        return RegistryKey.of(Objects.requireNonNull(type, "type"), this.key(type)).asDefaultedReference(type.defaultHolder());
+    /**
+     * Returns the {@link DefaultedRegistryReference} for
+     * this object in the default {@link #registryType()}.
+     *
+     * @return The {@link DefaultedRegistryReference} for
+     * this object in the default {@link #registryType()}
+     */
+    default DefaultedRegistryReference<T> asDefaultedReference() {
+        return this.asDefaultedReference(this.registryType());
     }
 }

src/main/java/org/spongepowered/api/registry/RegistryValue.java

@@ -0,0 +1,50 @@
+/*
+ * This file is part of SpongeAPI, licensed under the MIT License (MIT).
+ *
+ * Copyright (c) SpongePowered <https://www.spongepowered.org>
+ * Copyright (c) contributors
+ *
+ * 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.spongepowered.api.registry;
+
+import org.spongepowered.api.ResourceKey;
+
+import java.util.Objects;
+import java.util.Optional;
+
+/**
+ * A Utility marker that assists in getting a {@link ResourceKey} for values that generally can be
+ * within a {@link DefaultedRegistryType defaulted registry}.
+ */
+@SuppressWarnings("unchecked")
+public interface RegistryValue<T extends RegistryValue<T>> {
+
+    default ResourceKey key(final DefaultedRegistryType<T> type) {
+        return Objects.requireNonNull(type, "type").get().valueKey((T) this);
+    }
+
+    default Optional<ResourceKey> findKey(final DefaultedRegistryType<T> type) {
+        return Objects.requireNonNull(type, "type").find().flatMap(r -> r.findValueKey((T) this));
+    }
+
+    default DefaultedRegistryReference<T> asDefaultedReference(final DefaultedRegistryType<T> type) {
+        return RegistryKey.of(Objects.requireNonNull(type, "type"), this.key(type)).asDefaultedReference(type.defaultHolder());
+    }
+}

src/main/java/org/spongepowered/api/tag/DefaultedTaggable.java

@@ -0,0 +1,57 @@
+/*
+ * This file is part of SpongeAPI, licensed under the MIT License (MIT).
+ *
+ * Copyright (c) SpongePowered <https://www.spongepowered.org>
+ * Copyright (c) contributors
+ *
+ * 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.spongepowered.api.tag;
+
+import org.spongepowered.api.registry.DefaultedRegistryValue;
+
+import java.util.Collection;
+
+/**
+ * A {@link DefaultedRegistryValue} that may be included in one or more {@link Tag} collections.
+ */
+public interface DefaultedTaggable<T extends DefaultedTaggable<T>> extends DefaultedRegistryValue<T>, Taggable<T> {
+
+    /**
+     * Gets all {@link Tag}s that have been associated
+     * with this object in the default {@link #registryType()}.
+     *
+     * @return THe {@link Collection} of {@link Tag}s
+     */
+    default Collection<Tag<T>> tags() {
+        return this.tags(this.registryType());
+    }
+
+    /**
+     * Returns whether the given {@link Tag} is associated with
+     * this object in the default {@link #registryType()}.
+     *
+     * @param tag The tag
+     * @return true if the given {@link Tag} is associated with
+     * this object in the default {@link #registryType()}
+     */
+    default boolean is(final Tag<T> tag) {
+        return this.is(this.registryType(), tag);
+    }
+}

src/main/java/org/spongepowered/api/tag/Taggable.java

@@ -25,36 +25,37 @@
 package org.spongepowered.api.tag;
 
 import org.spongepowered.api.registry.DefaultedRegistryType;
-import org.spongepowered.api.registry.DefaultedRegistryValue;
-import org.spongepowered.api.registry.RegistryType;
+import org.spongepowered.api.registry.RegistryValue;
 
 import java.util.Collection;
 
 /**
- * A type that may be included in one or more {@link Tag} collections.
+ * A {@link RegistryValue} that may be included in one or more {@link Tag} collections.
  */
-public interface Taggable<T extends Taggable<T>> extends DefaultedRegistryValue {
+@SuppressWarnings("unchecked")
+public interface Taggable<T extends Taggable<T>> extends RegistryValue<T> {
 
     /**
-     * Gets the {@link RegistryType} that holds the types of {@link Tag tags}
-     * that can be associated with this object.
+     * Gets all {@link Tag}s that have been associated
+     * with this object in the given registry.
      *
-     * @return The {@link RegistryType}
+     * @param type The registry type
+     * @return THe {@link Collection} of {@link Tag}s
      */
-    DefaultedRegistryType<T> registryType();
+    default Collection<Tag<T>> tags(final DefaultedRegistryType<T> type) {
+        return type.get().tags().filter(tag -> this.is(type, tag)).toList();
+    }
 
     /**
-     * Gets all {@link Tag tags} that have been associated with this object.
+     * Returns whether the given {@link Tag} is associated
+     * with this object in the given registry.
      *
-     * @return The {@link Collection} of {@link Tag}s.
-     */
-    Collection<Tag<T>> tags();
-
-    /**
-     * Returns true when given tag is associated with this object
+     * @param type The registry type
      * @param tag The tag
-     * @return true when given tag is associated with this object
+     * @return true if the given {@link Tag} is associated
+     * with this object in the given registry
      */
-    boolean is(Tag<T> tag);
-
+    default boolean is(final DefaultedRegistryType<T> type, final Tag<T> tag) {
+        return type.get().taggedValues(tag).contains((T) this);
+    }
 }