notnull and javadocs

src/main/java/me/youhavetrouble/entiddy/Entiddy.java

@@ -40,6 +40,9 @@ public enum Entiddy {
         entity.setCustomName("Grumm");
     }
 
+    /**
+     * @return True if entity is one of special/easter egg entities
+     */
     public static boolean isSpecialEntity(@NotNull LivingEntity entity) {
         if (entity instanceof Player) return false;
         for (Entiddy enTiddy: Entiddy.values()) {

src/main/java/me/youhavetrouble/entiddy/EntiddyInterface.java

@@ -15,6 +15,9 @@ public interface EntiddyInterface {
      */
     Entity spawn(@NotNull Location location, @NotNull CreatureSpawnEvent.SpawnReason spawnReason);
 
-    boolean isInstance(LivingEntity entity);
+    /**
+     * @return True if the entity is an instance of the specific special/easter egg type
+     */
+    boolean isInstance(@NotNull LivingEntity entity);
 
 }

src/main/java/me/youhavetrouble/entiddy/SpecialEntities/JebSheep.java

@@ -20,7 +20,7 @@ public class JebSheep implements EntiddyInterface {
     }
 
     @Override
-    public boolean isInstance(LivingEntity entity) {
+    public boolean isInstance(@NotNull LivingEntity entity) {
         if (!(entity instanceof Rabbit)) return false;
         return entity.getCustomName() != null && entity.getCustomName().equals("jeb_");
     }

src/main/java/me/youhavetrouble/entiddy/SpecialEntities/Johnny.java

@@ -22,7 +22,7 @@ public class Johnny implements EntiddyInterface {
     }
 
     @Override
-    public boolean isInstance(LivingEntity entity) {
+    public boolean isInstance(@NotNull LivingEntity entity) {
         if (!(entity instanceof Vindicator)) return false;
         return ((Vindicator) entity).isJohnny();
     }

src/main/java/me/youhavetrouble/entiddy/SpecialEntities/KillerBunny.java

@@ -23,7 +23,7 @@ public class KillerBunny implements EntiddyInterface {
     }
 
     @Override
-    public boolean isInstance(LivingEntity entity) {
+    public boolean isInstance(@NotNull LivingEntity entity) {
         if (!(entity instanceof Rabbit)) return false;
         return ((Rabbit) entity).getRabbitType().equals(Rabbit.Type.THE_KILLER_BUNNY);
     }

src/main/java/me/youhavetrouble/entiddy/SpecialEntities/Toast.java

@@ -20,7 +20,7 @@ public class Toast implements EntiddyInterface {
     }
 
     @Override
-    public boolean isInstance(LivingEntity entity) {
+    public boolean isInstance(@NotNull LivingEntity entity) {
         if (!(entity instanceof Rabbit)) return false;
         return entity.getCustomName() != null && entity.getCustomName().equals("Toast");
     }