Added Animate Title

Author: broken1arrow

src/main/java/org/brokenarrow/menu/library/MenuHolder.java

@@ -3,6 +3,7 @@
 import org.brokenarrow.menu.library.builders.ButtonData;
 import org.brokenarrow.menu.library.builders.MenuDataUtility;
 import org.brokenarrow.menu.library.utility.Function;
+import org.brokenarrow.menu.library.utility.PairFunction;
 import org.bukkit.Bukkit;
 import org.bukkit.Location;
 import org.bukkit.Sound;
@@ -173,6 +174,20 @@ public void setTitle(final Function<String> function) {
 		this.function = function;
 	}
 
+
+	/**
+	 * Sets the title of the menu using the specified
+	 * function to animate title.
+	 *
+	 * @param time     set how often it shall update, in seconds.
+	 * @param function a function that takes a String and boolean input, for animate title.
+	 */
+	public void setAnimateTitle(final int time, final PairFunction<String> function) {
+		this.animateTitleTime = time;
+		this.animateTitle = function;
+		this.animateTitle();
+	}
+
 	/**
 	 * Set type of inventory, defult will it use chest or hopper. If you set
 	 * the type you can´t change size.

src/main/java/org/brokenarrow/menu/library/MenuUtility.java

@@ -6,6 +6,8 @@
 import org.brokenarrow.menu.library.builders.MenuDataUtility;
 import org.brokenarrow.menu.library.utility.Function;
 import org.brokenarrow.menu.library.utility.Item.CreateItemStack;
+import org.brokenarrow.menu.library.utility.Item.Pair;
+import org.brokenarrow.menu.library.utility.PairFunction;
 import org.brokenarrow.menu.library.utility.Validate;
 import org.bukkit.Bukkit;
 import org.bukkit.Location;
@@ -89,6 +91,9 @@ public MenuUtility(final @Nullable List<Integer> fillSlots, @Nullable final List
 	protected int itemsPerPage = this.inventorySize;
 	protected int pageNumber;
 	protected int updateTime;
+	protected int taskidAnimateTitle;
+	protected int animateTitleTime;
+	protected PairFunction<String> animateTitle;
 
 	protected Player player;
 	protected Sound menuOpenSound;
@@ -735,6 +740,10 @@ protected void onMenuClose(final InventoryCloseEvent event) {
 			Bukkit.getScheduler().cancelTask(this.taskid);
 
 		}
+		if (Bukkit.getScheduler().isCurrentlyRunning(this.taskidAnimateTitle) || Bukkit.getScheduler().isQueued(this.taskidAnimateTitle)) {
+			Bukkit.getScheduler().cancelTask(this.taskidAnimateTitle);
+
+		}
 	}
 
 	protected Inventory loadInventory(final Player player, final boolean loadToCahe) {
@@ -1032,4 +1041,24 @@ private Set<Integer> getItemSlotsMap(final MenuDataUtility menuDataMap, final Me
 		return slotList;
 	}
 
+	protected void animateTitle() {
+		PairFunction<String> task = this.animateTitle;
+		if (task == null) return;
+		this.taskidAnimateTitle = new BukkitRunnable() {
+
+			@Override
+			public void run() {
+				Pair<String, Boolean> apply = task.apply();
+				String text = apply.getFirst();
+				if (text == null || !apply.getSecond()) {
+					this.cancel();
+					UpdateTittleContainers.update(player, getTitle());
+					return;
+				}
+				if (!text.isEmpty()) {
+					UpdateTittleContainers.update(player, text);
+				}
+			}
+		}.runTaskTimerAsynchronously(plugin, 1, 20 + this.animateTitleTime).getTaskId();
+	}
 }

src/main/java/org/brokenarrow/menu/library/utility/Item/CreateItemStack.java

@@ -48,7 +48,7 @@ public class CreateItemStack {
 	private final Iterable<?> itemArray;
 	private final String displayName;
 	private final List<String> lore;
-	private final Map<Enchantment, Tuple<Integer, Boolean>> enchantments = new HashMap<>();
+	private final Map<Enchantment, Pair<Integer, Boolean>> enchantments = new HashMap<>();
 	private final List<ItemFlag> visibleItemFlags = new ArrayList<>();
 	private final List<ItemFlag> flagsToHide = new ArrayList<>();
 	private final List<Pattern> pattern = new ArrayList<>();
@@ -268,7 +268,7 @@ public CreateItemStack addPattern(final List<Pattern> pattern) {
 	 *
 	 * @return map with enchantment level and if it shall ignore level reestriction.
 	 */
-	public Map<Enchantment, Tuple<Integer, Boolean>> getEnchantments() {
+	public Map<Enchantment, Pair<Integer, Boolean>> getEnchantments() {
 		return enchantments;
 	}
 
@@ -393,7 +393,7 @@ public CreateItemStack addEnchantments(final Enchantment... enchantments) {
 	 * @param override       the old value in the map if you set it to true.
 	 * @return this class.
 	 */
-	public CreateItemStack addEnchantments(final Map<Enchantment, Tuple<Integer, Boolean>> enchantmentMap, final boolean override) {
+	public CreateItemStack addEnchantments(final Map<Enchantment, Pair<Integer, Boolean>> enchantmentMap, final boolean override) {
 		Validate.checkNotNull(enchantmentMap, "this map is null");
 		if (enchantmentMap.isEmpty())
 			getLogger(Level.INFO, "This map is empty so no enchantments vill be added");
@@ -425,7 +425,7 @@ else if (enchant instanceof Enchantment)
 			enchantment = (Enchantment) enchant;
 
 		if (enchantment != null)
-			this.enchantments.put(enchantment, new Tuple<>(enchantmentLevel, levelRestriction));
+			this.enchantments.put(enchantment, new Pair<>(enchantmentLevel, levelRestriction));
 		else
 			getLogger(Level.INFO, "your enchantment: " + enchant + " ,are not valid.");
 
@@ -867,12 +867,12 @@ private void hideEnchantments(final ItemMeta itemMeta) {
 	public boolean addEnchantments(final ItemMeta itemMeta) {
 		if (!this.getEnchantments().isEmpty()) {
 			boolean haveEnchant = false;
-			for (final Map.Entry<Enchantment, Tuple<Integer, Boolean>> enchant : this.getEnchantments().entrySet()) {
+			for (final Map.Entry<Enchantment, Pair<Integer, Boolean>> enchant : this.getEnchantments().entrySet()) {
 				if (enchant == null) {
 					getLogger(Level.INFO, "Your enchantment are null.");
 					continue;
 				}
-				final Tuple<Integer, Boolean> level = enchant.getValue();
+				final Pair<Integer, Boolean> level = enchant.getValue();
 				haveEnchant = itemMeta.addEnchant(enchant.getKey(), level.getFirst() <= 0 ? 1 : level.getFirst(), level.getSecond());
 			}
 			if (isShowEnchantments() || !this.getFlagsToHide().isEmpty())

…row/menu/library/utility/Item/Tuple.java …rrow/menu/library/utility/Item/Pair.javasrc/main/java/org/brokenarrow/menu/library/utility/Item/Tuple.java renamed to src/main/java/org/brokenarrow/menu/library/utility/Item/Pair.java src/main/java/org/brokenarrow/menu/library/utility/Item/Tuple.java renamed to src/main/java/org/brokenarrow/menu/library/utility/Item/Pair.java

@@ -1,12 +1,12 @@
 package org.brokenarrow.menu.library.utility.Item;
 
-public class Tuple<K, V> {
+public class Pair<K, V> {
 
 	private final K firstValue;
 	private final V secondValue;
 
 
-	public Tuple(K firstValue, V secondValue) {
+	public Pair(K firstValue, V secondValue) {
 
 		this.firstValue = firstValue;
 		this.secondValue = secondValue;

src/main/java/org/brokenarrow/menu/library/utility/PairFunction.java

@@ -0,0 +1,11 @@
+package org.brokenarrow.menu.library.utility;
+
+import org.brokenarrow.menu.library.utility.Item.Pair;
+
+import javax.annotation.Nonnull;
+
+public interface PairFunction<T> {
+	@Nonnull
+	Pair<T, Boolean> apply();
+
+}