General fixes/cleanup

Author: timtomtim7

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

@@ -211,9 +211,8 @@ 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
+	 * @return the first element found that overlaps
 	 */
 	@Nullable
 	public Element findOverlap()
@@ -331,10 +330,4 @@ 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/IElementContainer.java

@@ -7,13 +7,39 @@
 
 public interface IElementContainer
 {
+	/**
+	 * Add the specified element to this container
+	 *
+	 * @param element the element to add
+	 * @param <T>     the type of element being added
+	 * @return the element that was added
+	 */
 	<T extends Element> T add(T element);
 
+	/**
+	 * Remove the specified element from this container
+	 *
+	 * @param element the element to remove
+	 * @return true if the element was removed
+	 */
 	boolean remove(Element element);
 
+	/**
+	 *
+	 * @return an unmodifiable list of all the elements in this container
+	 */
 	List<Element> getElements();
 
+	/**
+	 *
+	 * @param element the element to interact with
+	 * @return the command used to interact with the provided element
+	 */
 	String getCommand(Element element);
 
+	/**
+	 * Display this container to the specified player
+	 * @param player the player to open this container for
+	 */
 	void openFor(Player player);
 }

src/main/java/me/tom/sparse/spigot/chat/menu/element/BooleanElement.java

@@ -20,7 +20,6 @@
  */
 public class BooleanElement extends Element
 {
-	//	protected boolean value;
 	@Nonnull
 	public final State<Boolean> value;
 
@@ -89,7 +88,6 @@ public ChatColor getFalseColor()
 	/**
 	 * @param falseColor the color the symbol should be if the value is {@code false}
 	 */
-	//TODO: Annotate @Nonnull and get rid of default colour?
 	public void setFalseColor(@Nullable ChatColor falseColor)
 	{
 		this.falseColor = falseColor == null ? ChatColor.RED : falseColor;
@@ -107,7 +105,6 @@ public ChatColor getTrueColor()
 	/**
 	 * @param trueColor The color the symbol should be if the value is {@code true}
 	 */
-	//TODO: Same as above
 	public void setTrueColor(@Nullable ChatColor trueColor)
 	{
 		this.trueColor = trueColor == null ? ChatColor.GREEN : trueColor;
@@ -129,7 +126,7 @@ public List<Text> render(@Nonnull IElementContainer context)
 		String baseCommand = context.getCommand(this);
 
 		List<BaseComponent> components = new ArrayList<>();
-		boolean current = value.getCurrent();
+		boolean current = value.getOptionalCurrent().orElse(false);
 		TextComponent c = new TextComponent(current ? "\u2714" : "\u2718");
 		c.setColor(current ? trueColor : falseColor);
 		c.setClickEvent(new ClickEvent(ClickEvent.Action.RUN_COMMAND, baseCommand + !current));
@@ -149,10 +146,9 @@ public void edit(@Nonnull IElementContainer container, @Nonnull String[] args)
 	/**
 	 * @return the current value
 	 */
-	@Nonnull
 	public boolean getValue()
 	{
-		return value.getCurrent();
+		return value.getOptionalCurrent().orElse(false);
 	}
 
 	/**

src/main/java/me/tom/sparse/spigot/chat/menu/element/ButtonElement.java

@@ -57,7 +57,8 @@ public ButtonElement(int x, int y, @Nonnull String text)
 	public ButtonElement(int x, int y, @Nonnull String text, @Nullable Consumer<Player> callback)
 	{
 		this(x, y, text, player -> {
-			callback.accept(player);
+			if(callback != null)
+				callback.accept(player);
 			return true;
 		});
 	}

src/main/java/me/tom/sparse/spigot/chat/menu/element/GroupElement.java

@@ -29,12 +29,10 @@ public GroupElement(@Nonnull IElementContainer parent, int x, int y)
 	}
 
 	/**
-	 * Adds the provided element to this group.
 	 *
-	 * @param element the element to add to this menu
-	 * @param <T>     the type of element
-	 * @return the element added
-	 * @throws NullPointerException if the element is null
+	 * @param element the element to add
+	 * @param <T> the type of element to add
+	 * @return the element that was added
 	 */
 	public <T extends Element> T add(@Nonnull T element)
 	{
@@ -63,8 +61,11 @@ public List<Element> getElements()
 	{
 		return Collections.unmodifiableList(elements);
 	}
-
-	//TODO: Documentation?
+	
+	/**
+	 * @param element the element to interact with
+	 * @return the command used to interact with this element
+	 */
 	@Nonnull
 	public String getCommand(@Nonnull Element element)
 	{
@@ -135,29 +136,4 @@ public void openFor(@Nonnull Player player)
 	{
 		parent.openFor(player);
 	}
-	
-	//	public static class GroupElementContainer implements IElementContainer
-//	{
-//		private final IElementContainer parent;
-//		private final GroupElement      group;
-//
-//		private GroupElementContainer(IElementContainer parent, GroupElement group)
-//		{
-//			this.parent = parent;
-//			this.group = group;
-//		}
-//
-//		public String getCommand(Element element)
-//		{
-//			int i = group.elements.indexOf(element);
-//			if(i == -1)
-//				throw new IllegalArgumentException("Unable to interact with the provided element");
-//			return parent.getCommand(group) + i + " ";
-//		}
-//
-//		public ChatMenu getMenu()
-//		{
-//			return parent.getMenu();
-//		}
-//	}
 }

src/main/java/me/tom/sparse/spigot/chat/menu/element/HorizontalRuleElement.java

@@ -11,22 +11,36 @@
 
 public class HorizontalRuleElement extends Element
 {
-	private static final String TEXT = "\u00a7m" + TextUtil.generateWidth(' ', 320, false);
-	public static final  int    WIDTH = ChatMenuAPI.getWidth(TEXT);
+	private final String text;
+	private final int    width;
 
 	/**
-	 * Constructs an element at the given x and y coordinates.
+	 * Constructs a {@code HorizontalRuleElement} at the provided Y coordinate and a width of {@code 320} (default chat width).
 	 *
 	 * @param y the y coordinate to put this element at
 	 */
 	public HorizontalRuleElement(int y)
 	{
-		super(0, y);
+		this(0, y, 320);
+	}
+	
+	/**
+	 * Constructs a {@code HorizontalRuleElement}.
+	 *
+	 * @param x     the x coordinate to put this element at
+	 * @param y     the y coordinate to put this element at
+	 * @param width the width of this element
+	 */
+	public HorizontalRuleElement(int x, int y, int width)
+	{
+		super(x, y);
+		this.text = "\u00a7m" + TextUtil.generateWidth(' ', width, false);
+		this.width = ChatMenuAPI.getWidth(text);
 	}
 
 	public int getWidth()
 	{
-		return WIDTH;
+		return width;
 	}
 
 	public int getHeight()
@@ -36,7 +50,7 @@ public int getHeight()
 
 	public List<Text> render(IElementContainer context)
 	{
-		return Collections.singletonList(new Text(TEXT));
+		return Collections.singletonList(new Text(text));
 	}
 
 	public void edit(@Nonnull IElementContainer container, @Nonnull String[] args)

src/main/java/me/tom/sparse/spigot/chat/menu/element/ImageElement.java

@@ -19,7 +19,7 @@ public class ImageElement extends Element
 {
 	public static final List<ChatColor> COLORS = Collections.unmodifiableList(
 			Arrays.stream(ChatColor.values())
-            .filter(c -> c != ChatColor.BOLD && c != ChatColor.MAGIC && c != ChatColor.UNDERLINE && c != ChatColor.ITALIC && c != ChatColor.STRIKETHROUGH).collect(Collectors.toList())
+					.filter(c -> c != ChatColor.BOLD && c != ChatColor.MAGIC && c != ChatColor.UNDERLINE && c != ChatColor.ITALIC && c != ChatColor.STRIKETHROUGH && c != ChatColor.RESET).collect(Collectors.toList())
 	);
 
 	protected int[] colors = new int[20 * 20];

src/main/java/me/tom/sparse/spigot/chat/menu/element/IncrementalElement.java

@@ -104,7 +104,7 @@ public void setValue(int value)
 	 */
 	public int getValue()
 	{
-		return value.getCurrent();
+		return value.getOptionalCurrent().orElse(0);
 	}
 
 	public int getWidth()
@@ -129,7 +129,7 @@ public List<Text> render(@Nonnull IElementContainer context)
 
 		List<BaseComponent> components = new ArrayList<>();
 		TextComponent decrement = new TextComponent("[-]");
-		int current = value.getCurrent();
+		int current = value.getOptionalCurrent().orElse(0);
 		if(current - 1 >= min)
 		{
 			decrement.setColor(ChatColor.RED);

src/main/java/me/tom/sparse/spigot/chat/menu/element/InputElement.java

@@ -73,9 +73,10 @@ public List<Text> render(@Nonnull IElementContainer context)
 	{
 		ClickEvent click = new ClickEvent(ClickEvent.Action.RUN_COMMAND, context.getCommand(this));
 
-		boolean tooLong = ChatMenuAPI.getWidth(value.getCurrent()) > width;
+		String current = value.getOptionalCurrent().orElse("");
+		boolean tooLong = ChatMenuAPI.getWidth(current) > width;
 
-		Text text = new Text(tooLong ? "Too long" : value.getCurrent());
+		Text text = new Text(tooLong ? "Too long" : current);
 		text.expandToWidth(width);
 		text.getComponents().forEach(it -> {
 			if(tooLong)

src/main/java/me/tom/sparse/spigot/chat/menu/element/NumberSliderElement.java

@@ -241,7 +241,7 @@ public NumberSliderElement width(int width)
 	 */
 	public int getValue()
 	{
-		return value.getCurrent();
+		return value.getOptionalCurrent().orElse(0);
 	}
 
 	/**
@@ -272,7 +272,7 @@ public int getWidth()
 
 	private String getFormattedNumber()
 	{
-		return numberFormat == null ? "" : " " + numberFormat.format(value.getCurrent(), length);
+		return " " + numberFormat.format(getValue(), length);
 	}
 
 	public int getHeight()
@@ -289,7 +289,7 @@ public List<Text> render(IElementContainer context)
 		{
 //			double v = (double) (i + 1) / (double) length;
 			TextComponent c = new TextComponent(String.valueOf((char) ('\u2588' + precision)));
-			c.setColor(i <= value.getCurrent() ? isEnabled() ? fullColor : ChatColor.GRAY : isEnabled() ? emptyColor : ChatColor.DARK_GRAY);
+			c.setColor(i <= getValue() ? isEnabled() ? fullColor : ChatColor.GRAY : isEnabled() ? emptyColor : ChatColor.DARK_GRAY);
 			c.setClickEvent(new ClickEvent(ClickEvent.Action.RUN_COMMAND, baseCommand + i));
 			components.add(c);
 		}