Refactor breedable and ageable entities (#2549)

Author: ImMorpheus

src/main/java/org/spongepowered/api/data/Keys.java

@@ -109,6 +109,7 @@
 import org.spongepowered.api.effect.potion.PotionEffectTypes;
 import org.spongepowered.api.effect.sound.SoundType;
 import org.spongepowered.api.effect.sound.music.MusicDisc;
+import org.spongepowered.api.entity.Ageable;
 import org.spongepowered.api.entity.AreaEffectCloud;
 import org.spongepowered.api.entity.Entity;
 import org.spongepowered.api.entity.EntityArchetype;
@@ -132,7 +133,6 @@
 import org.spongepowered.api.entity.hanging.ItemFrame;
 import org.spongepowered.api.entity.hanging.LeashKnot;
 import org.spongepowered.api.entity.hanging.Painting;
-import org.spongepowered.api.entity.living.Ageable;
 import org.spongepowered.api.entity.living.Agent;
 import org.spongepowered.api.entity.living.ArmorStand;
 import org.spongepowered.api.entity.living.Bat;
@@ -1533,7 +1533,7 @@ public final class Keys {
     public static final Key<Value<Boolean>> IN_WALL = Keys.key(ResourceKey.sponge("in_wall"), Boolean.class);
 
     /**
-     * Whether an {@link Ageable} is considered an adult.
+     * Whether a {@link Living} is considered an adult.
      */
     public static final Key<Value<Boolean>> IS_ADULT = Keys.key(ResourceKey.sponge("is_adult"), Boolean.class);
 

src/main/java/org/spongepowered/api/entity/Ageable.java

@@ -0,0 +1,47 @@
+/*
+ * 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.entity;
+
+import org.spongepowered.api.data.Keys;
+import org.spongepowered.api.data.value.Value;
+import org.spongepowered.api.util.Ticks;
+
+import java.util.Optional;
+
+/**
+ * Represents an {@link Entity} that can age
+ */
+public interface Ageable extends Entity {
+
+    /**
+     * {@link Keys#BABY_TICKS}
+     *
+     * @return The ticks until this entity turns into an adult
+     */
+    default Optional<Value.Mutable<Ticks>> babyTicks() {
+        return this.getValue(Keys.BABY_TICKS).map(Value::asMutable);
+    }
+
+}

…gepowered/api/entity/living/Ageable.java …/spongepowered/api/entity/Breedable.javasrc/main/java/org/spongepowered/api/entity/living/Ageable.java renamed to src/main/java/org/spongepowered/api/entity/Breedable.java src/main/java/org/spongepowered/api/entity/living/Ageable.java renamed to src/main/java/org/spongepowered/api/entity/Breedable.java

@@ -22,7 +22,7 @@
  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  * THE SOFTWARE.
  */
-package org.spongepowered.api.entity.living;
+package org.spongepowered.api.entity;
 
 import org.spongepowered.api.data.Keys;
 import org.spongepowered.api.data.value.Value;
@@ -31,28 +31,9 @@
 import java.util.Optional;
 
 /**
- * Represents an {@link Agent} that produces offspring and grows into an adult
+ * Represents an {@link Entity} which can breed.
  */
-public interface Ageable extends Agent {
-
-    /**
-     * {@link Keys#IS_ADULT}
-     *
-     * @return Whether this entity is an adult or not
-     */
-    default Value.Mutable<Boolean> adult() {
-        return this.requireValue(Keys.IS_ADULT).asMutable();
-    }
-
-    /**
-     * {@link Keys#BABY_TICKS}
-     *
-     * @return The ticks until this entity turns into an adult
-     */
-    default Optional<Value.Mutable<Ticks>> babyTicks() {
-        return this.getValue(Keys.BABY_TICKS).map(Value::asMutable);
-    }
-
+public interface Breedable extends Entity {
     /**
      * {@link Keys#CAN_BREED}
      *
@@ -70,5 +51,4 @@ default Value.Mutable<Boolean> canBreed() {
     default Optional<Value.Mutable<Ticks>> breedingCooldown() {
         return this.getValue(Keys.BREEDING_COOLDOWN).map(Value::asMutable);
     }
-
 }

src/main/java/org/spongepowered/api/entity/living/Living.java

@@ -74,6 +74,15 @@ default Value.Mutable<Double> health() {
         return this.requireValue(Keys.HEALTH).asMutable();
     }
 
+    /**
+     * {@link Keys#IS_ADULT}
+     *
+     * @return Whether this entity is an adult or not
+     */
+    default Value.Mutable<Boolean> adult() {
+        return this.requireValue(Keys.IS_ADULT).asMutable();
+    }
+
     /**
      * {@link Keys#MAX_HEALTH}
      *

src/main/java/org/spongepowered/api/entity/living/animal/Animal.java

@@ -26,8 +26,10 @@
 
 import org.spongepowered.api.data.Keys;
 import org.spongepowered.api.data.value.Value;
+import org.spongepowered.api.entity.Ageable;
+import org.spongepowered.api.entity.Breedable;
 import org.spongepowered.api.entity.EntityType;
-import org.spongepowered.api.entity.living.Ageable;
+import org.spongepowered.api.entity.living.PathfinderAgent;
 import org.spongepowered.api.entity.living.animal.cow.Cow;
 import org.spongepowered.api.item.inventory.ItemStack;
 
@@ -37,7 +39,7 @@
 /**
  * Represents an animal, such as a {@link Cow}.
  */
-public interface Animal extends Ageable {
+public interface Animal extends PathfinderAgent, Ageable, Breedable {
 
     /**
      * {@link Keys#BREEDER}

src/main/java/org/spongepowered/api/entity/living/trader/VillagerLike.java

@@ -24,11 +24,13 @@
  */
 package org.spongepowered.api.entity.living.trader;
 
-import org.spongepowered.api.entity.living.Ageable;
+import org.spongepowered.api.entity.Ageable;
+import org.spongepowered.api.entity.Breedable;
+import org.spongepowered.api.entity.living.PathfinderAgent;
 import org.spongepowered.api.item.merchant.Merchant;
 
 /**
  * An abstract representation of a Villager.
  */
-public interface VillagerLike extends Ageable, Merchant {
+public interface VillagerLike extends PathfinderAgent, Ageable, Breedable, Merchant {
 }

src/main/java/org/spongepowered/api/event/entity/BreedingEvent.java

@@ -24,8 +24,8 @@
  */
 package org.spongepowered.api.event.entity;
 
+import org.spongepowered.api.entity.Ageable;
 import org.spongepowered.api.entity.Entity;
-import org.spongepowered.api.entity.living.Ageable;
 import org.spongepowered.api.entity.living.animal.Animal;
 import org.spongepowered.api.event.Cancellable;
 import org.spongepowered.api.event.Event;