Merge pull request #22 from TBMCPlugins/Ali

Added Debug Messages

src/main/java/buttondevteam/lib/DebugPotato.java

@@ -1,129 +1,133 @@
-package buttondevteam.lib;
-
-import java.util.ArrayList;
-import java.util.Arrays;
-import java.util.List;
-
-import org.bukkit.Material;
-import org.bukkit.enchantments.Enchantment;
-import org.bukkit.entity.Player;
-import org.bukkit.inventory.ItemStack;
-import org.bukkit.inventory.meta.ItemMeta;
-
-public class DebugPotato {
-	private List<String> message;
-	private String type;
-
-	/**
-	 * Send the debug potato to a player
-	 * 
-	 * @param player
-	 *            The player
-	 */
-	public void Send(Player player){
-		player.getInventory().addItem(this.toItemStack());
-		return;
-	}
-
-	/**
-	 * Get the message (lore of the potato).
-	 * 
-	 * @return The message
-	 */
-	public List<String> getMessage() {
-		return message;
-	}
-
-	/**
-	 * Sets the message (lore of the potato).
-	 * 
-	 * @param message
-	 *            The message
-	 * @return This potato
-	 */
-	public DebugPotato setMessage(List<String> message) {
-		this.message = message;
-		return this;
-	}
-
-	/**
-	 * Sets the message (lore of the potato). It will be word wrapped automatically.
-	 * 
-	 * @param message
-	 *            The message
-	 * @return This potato
-	 */
-	public DebugPotato setMessage(String message) {
-		this.message = WordWrap(message);
-		return this;
-	}
-
-	/**
-	 * Sets the message (lore of the potato).
-	 * 
-	 * @param message
-	 *            The message
-	 * @return This potato
-	 */
-	public DebugPotato setMessage(String[] message) {
-		this.message = Arrays.asList(message);
-		return this;
-	}
-
-	/**
-	 * Gets the type (potato name).
-	 * 
-	 * @return The type
-	 */
-	public String getType() {
-		return type;
-	}
-
-	/**
-	 * Sets the type (potato name).
-	 * 
-	 * @param type
-	 *            The type
-	 * @return This potato
-	 */
-	public DebugPotato setType(String type) {
-		this.type = type;
-		return this;
-	}
-
-	private static List<String> WordWrap(String message) {
-		String[] splitString = message.split("\\s+");
-		List<String> newMessage = new ArrayList<String>();
-		String currentLine = "";
-		int currentLineLength = 0;
-		int wordlength;
-		int maxLineLength = 40;
-		for (String word : splitString) {
-			wordlength = word.length();
-			if (currentLineLength == 0 || (currentLineLength + wordlength) < maxLineLength) {
-				currentLine += word + " ";
-				currentLineLength += wordlength + 1;
-			} else {
-				newMessage.add(currentLine);
-				currentLine = word + " ";
-				currentLineLength = word.length();
-			}
-		}
-		return newMessage;
-	}
-	public ItemStack toItemStack() {
-		ItemStack potato = new ItemStack(Material.BAKED_POTATO);
-		ItemMeta meta = potato.getItemMeta();
-		meta.setDisplayName(this.getType() == null ? "Spicy Debug Potato" : this.getType());
-		if (this.getMessage() == null){
-			List<String> message = new ArrayList<String>();
-			message.add("nullMessage");
-			meta.setLore(message);
-		}else{
-			meta.setLore(this.getMessage());
-		}
-		potato.setItemMeta(meta);
-		potato.addUnsafeEnchantment(Enchantment.ARROW_FIRE, 10);
-		return potato;
-	}
-}
+package buttondevteam.lib;
+
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.List;
+
+import org.bukkit.Material;
+import org.bukkit.enchantments.Enchantment;
+import org.bukkit.entity.Player;
+import org.bukkit.inventory.ItemStack;
+import org.bukkit.inventory.meta.ItemMeta;
+
+public class DebugPotato {
+	private List<String> message;
+	private String type;
+
+	/**
+	 * Send the debug potato to a player
+	 * 
+	 * @param player
+	 *            The player
+	 */
+	public void Send(Player player){
+		player.getInventory().addItem(this.toItemStack());
+		return;
+	}
+
+	/**
+	 * Get the message (lore of the potato).
+	 * 
+	 * @return The message
+	 */
+	public List<String> getMessage() {
+		return message;
+	}
+
+	/**
+	 * Sets the message (lore of the potato).
+	 * 
+	 * @param message
+	 *            The message
+	 * @return This potato
+	 */
+	public DebugPotato setMessage(List<String> message) {
+		this.message = message;
+		return this;
+	}
+
+	/**
+	 * Sets the message (lore of the potato). It will be word wrapped automatically.
+	 * 
+	 * @param message
+	 *            The message
+	 * @return This potato
+	 */
+	public DebugPotato setMessage(String message) {
+		this.message = WordWrap(message);
+		return this;
+	}
+
+	/**
+	 * Sets the message (lore of the potato).
+	 * 
+	 * @param message
+	 *            The message
+	 * @return This potato
+	 */
+	public DebugPotato setMessage(String[] message) {
+		this.message = Arrays.asList(message);
+		return this;
+	}
+
+	/**
+	 * Gets the type (potato name).
+	 * 
+	 * @return The type
+	 */
+	public String getType() {
+		return type;
+	}
+
+	/**
+	 * Sets the type (potato name).
+	 * 
+	 * @param type
+	 *            The type
+	 * @return This potato
+	 */
+	public DebugPotato setType(String type) {
+		this.type = type;
+		return this;
+	}
+
+	private static List<String> WordWrap(String message) {
+		String[] splitString = message.split("\\s+");
+		List<String> newMessage = new ArrayList<String>();
+		String currentLine = "";
+		int currentLineLength = 0;
+		int wordlength;
+		int maxLineLength = 40;
+		if (message.length() <= maxLineLength){
+			newMessage.add(message);
+			return newMessage;
+		}
+		for (String word : splitString) {
+			wordlength = word.length();
+			if (currentLineLength == 0 || (currentLineLength + wordlength) < maxLineLength) {
+				currentLine += word + " ";
+				currentLineLength += wordlength + 1;
+			} else {
+				newMessage.add(currentLine);
+				currentLine = word + " ";
+				currentLineLength = word.length();
+			}
+		}
+		return newMessage;
+	}
+	public ItemStack toItemStack() {
+		ItemStack potato = new ItemStack(Material.BAKED_POTATO);
+		ItemMeta meta = potato.getItemMeta();
+		meta.setDisplayName(this.getType() == null ? "Null Flavoured Debug Potato" : this.getType());
+		if (this.getMessage() == null){
+			List<String> message = new ArrayList<String>();
+			message.add("nullMessage");
+			meta.setLore(message);
+		}else{
+			meta.setLore(this.getMessage());
+		}
+		potato.setItemMeta(meta);
+		potato.addUnsafeEnchantment(Enchantment.ARROW_FIRE, 10);
+		return potato;
+	}
+}

src/main/java/buttondevteam/lib/DebugPotatoAPI.java

@@ -1,13 +0,0 @@
-package buttondevteam.lib;
-
-import org.bukkit.entity.Player;
-
-/**@deprecated
- * Fully Replaced by DebugPotato Class - Construct a DebugPotato*/
-public class DebugPotatoAPI {
-	/**@deprecated Replaced by DebugPotato.send*/
-	public static void SendDebugPotato(DebugPotato dp, Player player) {
-		player.getInventory().addItem(dp.toItemStack());
-		return;
-	}
-}

src/main/java/buttondevteam/lib/TBMCCoreAPI.java

@@ -127,6 +127,7 @@ public final class TBMCCoreAPI {
 	}
 
 	private static HashMap<String, Throwable> exceptionsToSend = new HashMap<>();
+	private static List<String> debugMessagesToSend = new ArrayList<>();
 
 	private static final String[] potatoMessages = new String[] { //
 			"Well shit", //
@@ -163,6 +164,13 @@ public final class TBMCCoreAPI {
 			potato.Send(randomPlayer.get());
 		}
 	}
+	public static void sendDebugMessage(String debugMessage){
+		SendUnsentDebugMessages();
+		TBMCDebugMessageEvent event = new TBMCDebugMessageEvent(debugMessage);
+		Bukkit.getPluginManager().callEvent(event);
+		if (!event.isSent())
+			debugMessagesToSend.add(debugMessage);
+	}
 
 	/**
 	 * Registers Bukkit events, handling the exceptions occuring in those events
@@ -191,4 +199,17 @@ public final class TBMCCoreAPI {
 				exceptionsToSend.remove(entry.getKey());
 		}
 	}
+
+	public static void SendUnsentDebugMessages() {
+		if (debugMessagesToSend.size() > 20) {
+			debugMessagesToSend.clear(); // Don't call more and more DebugMessages if all the handler plugins are unloaded
+			Bukkit.getLogger().warning("Unhandled Debug Message list is over 20! Clearing!");
+		}
+		for (String message : debugMessagesToSend) {
+			TBMCDebugMessageEvent event = new TBMCDebugMessageEvent(message);
+			Bukkit.getPluginManager().callEvent(event);
+			if (event.isSent())
+				debugMessagesToSend.remove(message);
+		}	
+	}
 }

src/main/java/buttondevteam/lib/TBMCDebugMessageEvent.java

@@ -0,0 +1,49 @@
+package buttondevteam.lib;
+
+import org.bukkit.event.Event;
+import org.bukkit.event.HandlerList;
+
+public class TBMCDebugMessageEvent extends Event {
+	private static final HandlerList handlers = new HandlerList();
+	private String message;
+	private boolean sent;
+
+	public TBMCDebugMessageEvent(String message) {
+		this.message = message;
+	}
+
+	/**
+	 * Gets the message (where did this exception occur, etc.)
+	 * 
+	 * @return The message
+	 */
+	public String getDebugMessage() {
+		return message;
+	}
+
+	/**
+	 * Gets if this event was handled
+	 * 
+	 * @return True if it was handled
+	 */
+	public boolean isSent() {
+		return sent;
+	}
+
+	/**
+	 * Flags the event as handled
+	 */
+	public void setSent() {
+		this.sent = true;
+	}
+
+	@Override
+	public HandlerList getHandlers() {
+		return handlers;
+	}
+
+	public static HandlerList getHandlerList() {
+		return handlers;
+	}
+
+}