Added JSR305 annotations. Fixed some minor logic issues and problems in Javadocs

Author: Redrield

pom.xml

@@ -43,24 +43,17 @@
             <version>1.12-R0.1-SNAPSHOT</version>
             <scope>provided</scope>
         </dependency>
-        <dependency>
-            <groupId>org.bukkit</groupId>
-            <artifactId>bukkit</artifactId>
-            <version>1.12-R0.1-SNAPSHOT</version>
-            <scope>provided</scope>
-        </dependency>
-        <dependency>
-            <groupId>org.bukkit</groupId>
-            <artifactId>craftbukkit</artifactId>
-            <version>1.12-R0.1-SNAPSHOT</version>
-            <scope>provided</scope>
-        </dependency>
         <dependency>
             <groupId>org.spigotmc</groupId>
             <artifactId>spigot</artifactId>
             <version>1.12-R0.1-SNAPSHOT</version>
             <scope>provided</scope>
         </dependency>
+        <dependency>
+            <groupId>com.google.code.findbugs</groupId>
+            <artifactId>jsr305</artifactId>
+            <version>3.0.2</version>
+        </dependency>
     </dependencies>
 
     <repositories>

src/main/java/me/tom/sparse/spigot/chat/menu/ChatMenu.java

@@ -8,15 +8,20 @@
 import net.md_5.bungee.api.chat.BaseComponent;
 import org.bukkit.entity.Player;
 
+import javax.annotation.Nonnull;
+import javax.annotation.Nullable;
 import java.util.*;
 
 public class ChatMenu implements IElementContainer
 {
+	@Nonnull
 	protected final String  id;
 	protected       boolean registered;
-	
+
+	@Nonnull
 	protected List<Element> elements;
-	
+
+	@Nonnull
 	protected Set<Player> viewers   = new ConcurrentSet<>();
 	protected boolean     pauseChat = false;
 
@@ -27,7 +32,7 @@ public class ChatMenu implements IElementContainer
 	 *
 	 * @param elements the elements to start the menu with.
 	 */
-	public ChatMenu(Element... elements)
+	public ChatMenu(@Nonnull Element... elements)
 	{
 		this(Arrays.asList(elements));
 	}
@@ -37,7 +42,7 @@ public ChatMenu(Element... elements)
 	 *
 	 * @param elements the elements to start the menu with.
 	 */
-	public ChatMenu(Collection<Element> elements)
+	public ChatMenu(@Nonnull Collection<Element> elements)
 	{
 		this.elements = new ArrayList<>();
 		this.elements.addAll(elements);
@@ -80,7 +85,7 @@ public void unregister()
 	 * @throws IllegalArgumentException if the element is null
 	 */
 	@Deprecated
-	public void addElement(Element element)
+	public void addElement(@Nonnull Element element)
 	{
 		add(element);
 	}
@@ -92,7 +97,7 @@ public void addElement(Element element)
 	 * @param <T> the type of element
 	 * @return the element added
 	 */
-	public <T extends Element> T add(T t)
+	public <T extends Element> T add(@Nonnull T t)
 	{
 		Objects.requireNonNull(t);
 		elements.add(t);
@@ -106,14 +111,15 @@ public <T extends Element> T add(T t)
 	 * @param element the element to remove
 	 * @return true if the element was removed
 	 */
-	public boolean remove(Element element)
+	public boolean remove(@Nonnull Element element)
 	{
 		return elements.remove(element);
 	}
 
 	/**
 	 * @return an unmodifiable list of all the elements in this menu.
 	 */
+	@Nonnull
 	public List<Element> getElements()
 	{
 		return Collections.unmodifiableList(elements);
@@ -126,7 +132,7 @@ public List<Element> getElements()
 	 * @param elementIndex the index of the element that was edited
 	 * @param args         the data to be parsed by the element
 	 */
-	public void edit(Player player, int elementIndex, String[] args)
+	public void edit(@Nonnull Player player, int elementIndex, @Nonnull String[] args)
 	{
 		if(elementIndex < 0 || elementIndex >= elements.size())
 			return;
@@ -142,7 +148,7 @@ public void edit(Player player, int elementIndex, String[] args)
 	 *
 	 * @param player the player to send the menu to.
 	 */
-	public void openFor(Player player)
+	public void openFor(@Nonnull Player player)
 	{
 		PlayerChatIntercept chat = ChatMenuAPI.getChatIntercept(player);
 		if(viewers.add(player) && pauseChat)
@@ -151,7 +157,8 @@ public void openFor(Player player)
 			chat.sendMessage(line);
 		ChatMenuAPI.setCurrentMenu(player, this);
 	}
-	
+
+	@Nonnull
 	public List<BaseComponent[]> build()
 	{
 		Element overlapping = findOverlap();
@@ -203,10 +210,12 @@ else if(text.getWidth() > 320)
 		}
 		return result;
 	}
-	
+
+	//FIXME: Javadocs unclear. says would return true, but return type isn't a boolean
 	/**
 	 * @return true if any elements overlap
 	 */
+	@Nullable
 	public Element findOverlap()
 	{
 		return elements.stream().filter(Element::isVisible).filter(a -> elements.stream().filter(Element::isVisible).anyMatch(b -> a != b && a.overlaps(b))).findFirst().orElse(null);
@@ -217,7 +226,7 @@ public Element findOverlap()
 	 *
 	 * @param player the player that closed the menu
 	 */
-	public void close(Player player)
+	public void close(@Nonnull Player player)
 	{
 		if(viewers.remove(player))
 		{
@@ -228,7 +237,7 @@ public void close(Player player)
 			unregister();
 	}
 
-	void onClosed(Player player)
+	void onClosed(@Nonnull Player player)
 	{
 		if(viewers.remove(player))
 			ChatMenuAPI.getChatIntercept(player).resume();
@@ -237,6 +246,7 @@ void onClosed(Player player)
 	/**
 	 * @return the command used to interact with this menu
 	 */
+	@Nonnull
 	public String getCommand()
 	{
 		if(!isRegistered())
@@ -248,7 +258,8 @@ public String getCommand()
 	 * @param element the element to interact with
 	 * @return the command used to interact with the provided element
 	 */
-	public String getCommand(Element element)
+	@Nonnull
+	public String getCommand(@Nonnull Element element)
 	{
 		return getCommand() + elements.indexOf(element)+" ";
 	}
@@ -274,6 +285,7 @@ public boolean doesPauseChat()
 	 * Makes this menu pause chat when it is opened
 	 * @return this
 	 */
+	@Nonnull
 	public ChatMenu pauseChat()
 	{
 		setPauseChat(true);
@@ -288,7 +300,8 @@ public ChatMenu pauseChat()
 	 * @param text the text of the close button
 	 * @return this
 	 */
-	public ChatMenu pauseChat(int x, int y, String text)
+	@Nonnull
+	public ChatMenu pauseChat(int x, int y, @Nonnull String text)
 	{
 		setPauseChat(true);
 		add(ButtonElement.createCloseButton(x, y, text, this));
@@ -318,7 +331,8 @@ public boolean equals(Object o)
 
 		return id.equals(chatMenu.id);
 	}
-	
+
+	//FIXME: Redundant
 	public ChatMenu getMenu()
 	{
 		return this;

src/main/java/me/tom/sparse/spigot/chat/menu/ChatMenuAPI.java

@@ -8,6 +8,8 @@
 import org.bukkit.map.MinecraftFont;
 import org.bukkit.plugin.Plugin;
 
+import javax.annotation.Nonnull;
+import javax.annotation.Nullable;
 import java.util.Map;
 import java.util.concurrent.ConcurrentHashMap;
 import java.util.concurrent.ThreadLocalRandom;
@@ -23,37 +25,41 @@ public final class ChatMenuAPI
 	private ChatMenuAPI() {}
 
 	/**
-	 * @param player the player whose current menu should be returned
+	 * @param player the player whose getCurrent menu should be returned
 	 * @return the menu the player currently has open, or {@code null} if no menu is open.
 	 */
-	public static ChatMenu getCurrentMenu(Player player)
+	@Nullable
+	public static ChatMenu getCurrentMenu(@Nonnull Player player)
 	{
 		return OPENED_MENUS.get(player);
 	}
 
 	/**
-	 * @param player the player whose current menu should be set
-	 * @param menu   the menu to set as current, or {@code null} if you want to close the current menu.
+	 * @param player the player whose getCurrent menu should be setCurrent
+	 * @param menu   the menu to setCurrent as getCurrent, or {@code null} if you want to close the getCurrent menu.
 	 */
-	public static void setCurrentMenu(Player player, ChatMenu menu)
+	@Nullable
+	public static void setCurrentMenu(@Nonnull Player player, @Nonnull ChatMenu menu)
 	{
 		ChatMenu old = OPENED_MENUS.remove(player);
 		if(old != null && old != menu) old.onClosed(player);
 		if(menu != null) OPENED_MENUS.put(player, menu);
 	}
-	
+
+	@Nonnull
 	static String registerMenu(ChatMenu menu)
 	{
 		String id = generateIdentifier();
 		MENUS.put(id, menu);
 		return id;
 	}
-	
-	static void unregisterMenu(ChatMenu menu)
+
+	static void unregisterMenu(@Nonnull ChatMenu menu)
 	{
 		MENUS.values().remove(menu);
 	}
-	
+
+	@Nonnull
 	private static String generateIdentifier()
 	{
 		String result = null;
@@ -67,13 +73,14 @@ private static String generateIdentifier()
 	}
 
 	/**
-	 * Gets the current {@link PlayerChatIntercept} associated with the provided player.
+	 * Gets the getCurrent {@link PlayerChatIntercept} associated with the provided player.
 	 * If the player does not have one, it will be created.
 	 *
 	 * @param player the player to get/create the {@link PlayerChatIntercept} for
 	 * @return the {@link PlayerChatIntercept} associated with the provided player
 	 */
-	public static PlayerChatIntercept getChatIntercept(Player player)
+	@Nonnull
+	public static PlayerChatIntercept getChatIntercept(@Nonnull Player player)
 	{
 		return interceptor.getChat(player);
 	}
@@ -86,7 +93,7 @@ public static PlayerChatIntercept getChatIntercept(Player player)
 	 * @param text the text to calculate the width for
 	 * @return the number of pixels in chat the text takes up
 	 */
-	public static int getWidth(String text)
+	public static int getWidth(@Nonnull String text)
 	{
 		if(text.contains("\n"))
 			throw new IllegalArgumentException("Cannot get width of text containing newline");
@@ -169,7 +176,7 @@ static ChatMenu getMenu(String id)
 	 *
 	 * @param plugin the plugin to initialize everything with, including listeners and scheduled tasks
 	 */
-	public static void init(Plugin plugin)
+	public static void init(@Nonnull Plugin plugin)
 	{
 		if(ChatMenuAPI.plugin != null)
 			return;