From 7c4e75f4f26dfe9ff0be13a7f89ad01219b74be2 Mon Sep 17 00:00:00 2001 From: Bukkit/Spigot Date: Tue, 14 Jun 2016 22:21:06 +0100 Subject: [PATCH] Improvements to BookMeta API * Added hasGeneration() * Corrected javadoc of methods for consistency and accuracy according to CraftBukkit behavior By: Roy Curtis --- .../org/bukkit/inventory/meta/BookMeta.java | 24 ++++++++++++------- 1 file changed, 16 insertions(+), 8 deletions(-) diff --git a/paper-api/src/main/java/org/bukkit/inventory/meta/BookMeta.java b/paper-api/src/main/java/org/bukkit/inventory/meta/BookMeta.java index 845f71c4ad..d66e3f5931 100644 --- a/paper-api/src/main/java/org/bukkit/inventory/meta/BookMeta.java +++ b/paper-api/src/main/java/org/bukkit/inventory/meta/BookMeta.java @@ -62,7 +62,7 @@ public interface BookMeta extends ItemMeta { /** * Checks for the existence of an author in the book. * - * @return the author of the book + * @return true if the book has an author */ boolean hasAuthor(); @@ -79,23 +79,31 @@ public interface BookMeta extends ItemMeta { /** * Sets the author of the book. Removes author when given null. * - * @param author the author of the book + * @param author the author to set */ void setAuthor(String author); /** - * Gets the generation of the book, or null if it's out of bounds. + * Checks for the existence of generation level in the book. * - * @return the generation of the book or null + * @return true if the book has a generation level + */ + boolean hasGeneration(); + + /** + * Gets the generation of the book. + *

+ * Plugins should check that hasGeneration() returns true before calling + * this method. + * + * @return the generation of the book */ Generation getGeneration(); /** - * Sets the generation of the book. - *

- * Assumes Generation.ORIGINAL if given null. + * Sets the generation of the book. Removes generation when given null. * - * @param generation the generation of the book + * @param generation the generation to set */ void setGeneration(Generation generation);