Add ItemMeta factory and interfaces. This adds BUKKIT-15

Included with ItemMeta is a new serializable class Color.

PotionEffects are now serializable.

4 files changed, 366 insertions, 109 deletions

diff --git a/src/test/java/org/bukkit/ColorTest.java b/src/test/java/org/bukkit/ColorTest.java
new file mode 100644
index 00000000..8d9557af
--- /dev/null
+++ b/src/test/java/org/bukkit/ColorTest.java
@@ -0,0 +1,365 @@
+package org.bukkit;
+
+import static org.hamcrest.Matchers.*;
+import static org.junit.Assert.*;
+
+import org.bukkit.configuration.file.YamlConfiguration;
+import org.junit.Test;
+
+@SuppressWarnings("javadoc")
+public class ColorTest {
+    static class TestColor {
+        static int id = 0;
+        final String name;
+        final int rgb;
+        final int bgr;
+        final int r;
+        final int g;
+        final int b;
+
+        TestColor(int rgb, int bgr, int r, int g, int b) {
+            this.rgb = rgb;
+            this.bgr = bgr;
+            this.r = r;
+            this.g = g;
+            this.b = b;
+            this.name = id + ":" + Integer.toHexString(rgb).toUpperCase() + "_" + Integer.toHexString(bgr).toUpperCase() + "-r" + Integer.toHexString(r).toUpperCase() + "-g" + Integer.toHexString(g).toUpperCase() + "-b" + Integer.toHexString(b).toUpperCase();
+        }
+    }
+
+    static TestColor[] examples = new TestColor[] {
+        /*            0xRRGGBB, 0xBBGGRR, 0xRR, 0xGG, 0xBB */
+        new TestColor(0xFFFFFF, 0xFFFFFF, 0xFF, 0xFF, 0xFF),
+        new TestColor(0xFFFFAA, 0xAAFFFF, 0xFF, 0xFF, 0xAA),
+        new TestColor(0xFF00FF, 0xFF00FF, 0xFF, 0x00, 0xFF),
+        new TestColor(0x67FF22, 0x22FF67, 0x67, 0xFF, 0x22),
+        new TestColor(0x000000, 0x000000, 0x00, 0x00, 0x00)
+    };
+
+    @Test
+    public void testSerialization() throws Throwable {
+        for (TestColor testColor : examples) {
+            Color base = Color.fromRGB(testColor.rgb);
+
+            YamlConfiguration toSerialize = new YamlConfiguration();
+            toSerialize.set("color", base);
+            String serialized = toSerialize.saveToString();
+
+            YamlConfiguration deserialized = new YamlConfiguration();
+            deserialized.loadFromString(serialized);
+
+            assertThat(testColor.name + " on " + serialized, base, is(deserialized.getColor("color")));
+        }
+    }
+
+    // Equality tests
+    @Test
+    public void testEqualities() {
+        for (TestColor testColor : examples) {
+            Color fromRGB = Color.fromRGB(testColor.rgb);
+            Color fromBGR = Color.fromBGR(testColor.bgr);
+            Color fromRGBs = Color.fromRGB(testColor.r, testColor.g, testColor.b);
+            Color fromBGRs = Color.fromBGR(testColor.b, testColor.g, testColor.r);
+
+            assertThat(testColor.name, fromRGB, is(fromRGBs));
+            assertThat(testColor.name, fromRGB, is(fromBGR));
+            assertThat(testColor.name, fromRGB, is(fromBGRs));
+            assertThat(testColor.name, fromRGBs, is(fromBGR));
+            assertThat(testColor.name, fromRGBs, is(fromBGRs));
+            assertThat(testColor.name, fromBGR, is(fromBGRs));
+        }
+    }
+
+    @Test
+    public void testInequalities() {
+        for (int i = 1; i < examples.length; i++) {
+            TestColor testFrom = examples[i];
+            Color from = Color.fromRGB(testFrom.rgb);
+            for (int j = i - 1; j >= 0; j--) {
+                TestColor testTo = examples[j];
+                Color to = Color.fromRGB(testTo.rgb);
+                String name = testFrom.name + " to " + testTo.name;
+                assertThat(name, from, is(not(to)));
+
+                Color transform = from.setRed(testTo.r).setBlue(testTo.b).setGreen(testTo.g);
+                assertThat(name, transform, is(not(sameInstance(from))));
+                assertThat(name, transform, is(to));
+            }
+        }
+    }
+
+    // RGB tests
+    @Test
+    public void testRGB() {
+        for (TestColor testColor : examples) {
+            assertThat(testColor.name, Color.fromRGB(testColor.rgb).asRGB(), is(testColor.rgb));
+            assertThat(testColor.name, Color.fromBGR(testColor.bgr).asRGB(), is(testColor.rgb));
+            assertThat(testColor.name, Color.fromRGB(testColor.r, testColor.g, testColor.b).asRGB(), is(testColor.rgb));
+            assertThat(testColor.name, Color.fromBGR(testColor.b, testColor.g, testColor.r).asRGB(), is(testColor.rgb));
+        }
+    }
+
+    @Test(expected=IllegalArgumentException.class)
+    public void testInvalidRGB1() {
+        Color.fromRGB(0x01000000);
+    }
+
+    @Test(expected=IllegalArgumentException.class)
+    public void testInvalidRGB2() {
+        Color.fromRGB(Integer.MIN_VALUE);
+    }
+
+    @Test(expected=IllegalArgumentException.class)
+    public void testInvalidRGB3() {
+        Color.fromRGB(Integer.MAX_VALUE);
+    }
+
+    @Test(expected=IllegalArgumentException.class)
+    public void testInvalidRGB4() {
+        Color.fromRGB(-1);
+    }
+
+    // BGR tests
+    @Test
+    public void testBGR() {
+        for (TestColor testColor : examples) {
+            assertThat(testColor.name, Color.fromRGB(testColor.rgb).asBGR(), is(testColor.bgr));
+            assertThat(testColor.name, Color.fromBGR(testColor.bgr).asBGR(), is(testColor.bgr));
+            assertThat(testColor.name, Color.fromRGB(testColor.r, testColor.g, testColor.b).asBGR(), is(testColor.bgr));
+            assertThat(testColor.name, Color.fromBGR(testColor.b, testColor.g, testColor.r).asBGR(), is(testColor.bgr));
+        }
+    }
+
+    @Test(expected=IllegalArgumentException.class)
+    public void testInvalidBGR1() {
+        Color.fromBGR(0x01000000);
+    }
+
+    @Test(expected=IllegalArgumentException.class)
+    public void testInvalidBGR2() {
+        Color.fromBGR(Integer.MIN_VALUE);
+    }
+
+    @Test(expected=IllegalArgumentException.class)
+    public void testInvalidBGR3() {
+        Color.fromBGR(Integer.MAX_VALUE);
+    }
+
+    @Test(expected=IllegalArgumentException.class)
+    public void testInvalidBGR4() {
+        Color.fromBGR(-1);
+    }
+
+    // Red tests
+    @Test
+    public void testRed() {
+        for (TestColor testColor : examples) {
+            assertThat(testColor.name, Color.fromRGB(testColor.rgb).getRed(), is(testColor.r));
+            assertThat(testColor.name, Color.fromBGR(testColor.bgr).getRed(), is(testColor.r));
+            assertThat(testColor.name, Color.fromRGB(testColor.r, testColor.g, testColor.b).getRed(), is(testColor.r));
+            assertThat(testColor.name, Color.fromBGR(testColor.b, testColor.g, testColor.r).getRed(), is(testColor.r));
+        }
+    }
+
+    @Test(expected=IllegalArgumentException.class)
+    public void testInvalidR01() {
+        Color.fromRGB(-1, 0x00, 0x00);
+    }
+
+    @Test(expected=IllegalArgumentException.class)
+    public void testInvalidR02() {
+        Color.fromRGB(Integer.MAX_VALUE, 0x00, 0x00);
+    }
+
+    @Test(expected=IllegalArgumentException.class)
+    public void testInvalidR03() {
+        Color.fromRGB(Integer.MIN_VALUE, 0x00, 0x00);
+    }
+
+    @Test(expected=IllegalArgumentException.class)
+    public void testInvalidR04() {
+        Color.fromRGB(0x100, 0x00, 0x00);
+    }
+
+    @Test(expected=IllegalArgumentException.class)
+    public void testInvalidR05() {
+        Color.fromBGR(0x00, 0x00, -1);
+    }
+
+    @Test(expected=IllegalArgumentException.class)
+    public void testInvalidR06() {
+        Color.fromBGR(0x00, 0x00, Integer.MAX_VALUE);
+    }
+
+    @Test(expected=IllegalArgumentException.class)
+    public void testInvalidR07() {
+        Color.fromBGR(0x00, 0x00, Integer.MIN_VALUE);
+    }
+
+    @Test(expected=IllegalArgumentException.class)
+    public void testInvalidR08() {
+        Color.fromBGR(0x00, 0x00, 0x100);
+    }
+
+    @Test(expected=IllegalArgumentException.class)
+    public void testInvalidR09() {
+        Color.WHITE.setRed(-1);
+    }
+
+    @Test(expected=IllegalArgumentException.class)
+    public void testInvalidR10() {
+        Color.WHITE.setRed(Integer.MAX_VALUE);
+    }
+
+    @Test(expected=IllegalArgumentException.class)
+    public void testInvalidR11() {
+        Color.WHITE.setRed(Integer.MIN_VALUE);
+    }
+
+    @Test(expected=IllegalArgumentException.class)
+    public void testInvalidR12() {
+        Color.WHITE.setRed(0x100);
+    }
+
+    // Blue tests
+    @Test
+    public void testBlue() {
+        for (TestColor testColor : examples) {
+            assertThat(testColor.name, Color.fromRGB(testColor.rgb).getBlue(), is(testColor.b));
+            assertThat(testColor.name, Color.fromBGR(testColor.bgr).getBlue(), is(testColor.b));
+            assertThat(testColor.name, Color.fromRGB(testColor.r, testColor.g, testColor.b).getBlue(), is(testColor.b));
+            assertThat(testColor.name, Color.fromBGR(testColor.b, testColor.g, testColor.r).getBlue(), is(testColor.b));
+        }
+    }
+
+    @Test(expected=IllegalArgumentException.class)
+    public void testInvalidB01() {
+        Color.fromRGB(0x00, 0x00, -1);
+    }
+
+    @Test(expected=IllegalArgumentException.class)
+    public void testInvalidB02() {
+        Color.fromRGB(0x00, 0x00, Integer.MAX_VALUE);
+    }
+
+    @Test(expected=IllegalArgumentException.class)
+    public void testInvalidB03() {
+        Color.fromRGB(0x00, 0x00, Integer.MIN_VALUE);
+    }
+
+    @Test(expected=IllegalArgumentException.class)
+    public void testInvalidB04() {
+        Color.fromRGB(0x00, 0x00, 0x100);
+    }
+
+    @Test(expected=IllegalArgumentException.class)
+    public void testInvalidB05() {
+        Color.fromBGR(-1, 0x00, 0x00);
+    }
+
+    @Test(expected=IllegalArgumentException.class)
+    public void testInvalidB06() {
+        Color.fromBGR(Integer.MAX_VALUE, 0x00, 0x00);
+    }
+
+    @Test(expected=IllegalArgumentException.class)
+    public void testInvalidB07() {
+        Color.fromBGR(Integer.MIN_VALUE, 0x00, 0x00);
+    }
+
+    @Test(expected=IllegalArgumentException.class)
+    public void testInvalidB08() {
+        Color.fromBGR(0x100, 0x00, 0x00);
+    }
+
+    @Test(expected=IllegalArgumentException.class)
+    public void testInvalidB09() {
+        Color.WHITE.setBlue(-1);
+    }
+
+    @Test(expected=IllegalArgumentException.class)
+    public void testInvalidB10() {
+        Color.WHITE.setBlue(Integer.MAX_VALUE);
+    }
+
+    @Test(expected=IllegalArgumentException.class)
+    public void testInvalidB11() {
+        Color.WHITE.setBlue(Integer.MIN_VALUE);
+    }
+
+    @Test(expected=IllegalArgumentException.class)
+    public void testInvalidB12() {
+        Color.WHITE.setBlue(0x100);
+    }
+
+    // Green tests
+    @Test
+    public void testGreen() {
+        for (TestColor testColor : examples) {
+            assertThat(testColor.name, Color.fromRGB(testColor.rgb).getGreen(), is(testColor.g));
+            assertThat(testColor.name, Color.fromBGR(testColor.bgr).getGreen(), is(testColor.g));
+            assertThat(testColor.name, Color.fromRGB(testColor.r, testColor.g, testColor.b).getGreen(), is(testColor.g));
+            assertThat(testColor.name, Color.fromBGR(testColor.b, testColor.g, testColor.r).getGreen(), is(testColor.g));
+        }
+    }
+
+    @Test(expected=IllegalArgumentException.class)
+    public void testInvalidG01() {
+        Color.fromRGB(0x00, -1, 0x00);
+    }
+
+    @Test(expected=IllegalArgumentException.class)
+    public void testInvalidG02() {
+        Color.fromRGB(0x00, Integer.MAX_VALUE, 0x00);
+    }
+
+    @Test(expected=IllegalArgumentException.class)
+    public void testInvalidG03() {
+        Color.fromRGB(0x00, Integer.MIN_VALUE, 0x00);
+    }
+
+    @Test(expected=IllegalArgumentException.class)
+    public void testInvalidG04() {
+        Color.fromRGB(0x00, 0x100, 0x00);
+    }
+
+    @Test(expected=IllegalArgumentException.class)
+    public void testInvalidG05() {
+        Color.fromBGR(0x00, -1, 0x00);
+    }
+
+    @Test(expected=IllegalArgumentException.class)
+    public void testInvalidG06() {
+        Color.fromBGR(0x00, Integer.MAX_VALUE, 0x00);
+    }
+
+    @Test(expected=IllegalArgumentException.class)
+    public void testInvalidG07() {
+        Color.fromBGR(0x00, Integer.MIN_VALUE, 0x00);
+    }
+
+    @Test(expected=IllegalArgumentException.class)
+    public void testInvalidG08() {
+        Color.fromBGR(0x00, 0x100, 0x00);
+    }
+
+    @Test(expected=IllegalArgumentException.class)
+    public void testInvalidG09() {
+        Color.WHITE.setGreen(-1);
+    }
+
+    @Test(expected=IllegalArgumentException.class)
+    public void testInvalidG10() {
+        Color.WHITE.setGreen(Integer.MAX_VALUE);
+    }
+
+    @Test(expected=IllegalArgumentException.class)
+    public void testInvalidG11() {
+        Color.WHITE.setGreen(Integer.MIN_VALUE);
+    }
+
+    @Test(expected=IllegalArgumentException.class)
+    public void testInvalidG12() {
+        Color.WHITE.setGreen(0x100);
+    }
+}
diff --git a/src/test/java/org/bukkit/configuration/ConfigurationSectionTest.java b/src/test/java/org/bukkit/configuration/ConfigurationSectionTest.java
index 4e3478fd..6dab4779 100644
--- a/src/test/java/org/bukkit/configuration/ConfigurationSectionTest.java
+++ b/src/test/java/org/bukkit/configuration/ConfigurationSectionTest.java
@@ -403,7 +403,7 @@ public abstract class ConfigurationSectionTest {
         map.put("two", "two");
         map.put("three", 3.14);
 
-        List<Object> value = Arrays.asList((Object) "One", "Two", "Three", 4, "5", 6.0, true, "false", map);
+        List<Object> value = Arrays.asList("One", "Two", "Three", 4, "5", 6.0, true, "false", map);
 
         section.set(key, value);
 
diff --git a/src/test/java/org/bukkit/configuration/file/TestEnchantment.java b/src/test/java/org/bukkit/configuration/file/TestEnchantment.java
deleted file mode 100644
index 93569721..00000000
--- a/src/test/java/org/bukkit/configuration/file/TestEnchantment.java
+++ /dev/null
@@ -1,55 +0,0 @@
-package org.bukkit.configuration.file;

-

-import org.bukkit.enchantments.Enchantment;

-import org.bukkit.enchantments.EnchantmentTarget;

-import org.bukkit.inventory.ItemStack;

-

-public class TestEnchantment extends Enchantment {

-

-    public static void registerEnchantments() {

-        Enchantment.registerEnchantment(new TestEnchantment(0, "DUMMY_0"));

-        Enchantment.registerEnchantment(new TestEnchantment(1, "DUMMY_1"));

-        Enchantment.registerEnchantment(new TestEnchantment(2, "DUMMY_2"));

-        Enchantment.registerEnchantment(new TestEnchantment(3, "DUMMY_3"));

-        Enchantment.registerEnchantment(new TestEnchantment(4, "DUMMY_4"));

-        Enchantment.registerEnchantment(new TestEnchantment(5, "DUMMY_5"));

-    }

-

-    private final String name;

-

-    private TestEnchantment(final int id, final String name) {

-        super(id);

-        this.name = name;

-    }

-

-    @Override

-    public String getName() {

-        return name;

-    }

-

-    @Override

-    public int getMaxLevel() {

-        return 5;

-    }

-

-    @Override

-    public int getStartLevel() {

-        return 1;

-    }

-

-    @Override

-    public EnchantmentTarget getItemTarget() {

-        throw new UnsupportedOperationException("Not supported yet.");

-    }

-

-    @Override

-    public boolean canEnchantItem(ItemStack item) {

-        return true;

-    }

-

-    @Override

-    public boolean conflictsWith(Enchantment other) {

-        return false;

-    }

-

-}

diff --git a/src/test/java/org/bukkit/configuration/file/YamlConfigurationTest.java b/src/test/java/org/bukkit/configuration/file/YamlConfigurationTest.java
index 7c4d7653..aa83af32 100644
--- a/src/test/java/org/bukkit/configuration/file/YamlConfigurationTest.java
+++ b/src/test/java/org/bukkit/configuration/file/YamlConfigurationTest.java
@@ -1,19 +1,9 @@
 package org.bukkit.configuration.file;
 
-import java.util.ArrayList;
-import java.util.List;
-
-import org.bukkit.configuration.InvalidConfigurationException;
-import org.bukkit.enchantments.Enchantment;
-import org.bukkit.inventory.ItemStack;
-
 import org.junit.Test;
 import static org.junit.Assert.*;
 
 public class YamlConfigurationTest extends FileConfigurationTest {
-    static {
-        TestEnchantment.registerEnchantments();
-    }
 
     @Override
     public YamlConfiguration getConfig() {
@@ -63,47 +53,4 @@ public class YamlConfigurationTest extends FileConfigurationTest {
 
         assertEquals(expected, result);
     }
-
-    @Test
-    public void testSaveRestoreCompositeList() throws InvalidConfigurationException {
-        YamlConfiguration out = getConfig();
-
-        List<ItemStack> stacks = new ArrayList<ItemStack>();
-        stacks.add(new ItemStack(1));
-        stacks.add(new ItemStack(2));
-        stacks.add(new ItemStack(3));
-        stacks.add(new ItemStack(4, 17));
-        stacks.add(new ItemStack(5, 63));
-        stacks.add(new ItemStack(6, 1, (short) 1));
-        stacks.add(new ItemStack(18, 32, (short) 2));
-
-        ItemStack item7 = new ItemStack(256);
-        item7.addEnchantment(Enchantment.getById(1), 1);
-        stacks.add(item7);
-
-        ItemStack item8 = new ItemStack(257);
-        item8.addEnchantment(Enchantment.getById(2), 2);
-        item8.addEnchantment(Enchantment.getById(3), 1);
-        item8.addEnchantment(Enchantment.getById(4), 5);
-        item8.addEnchantment(Enchantment.getById(5), 4);
-        stacks.add(item8);
-
-        out.set("composite-list.abc.def", stacks);
-        String yaml = out.saveToString();
-
-        YamlConfiguration in = new YamlConfiguration();
-        in.loadFromString(yaml);
-        List<?> raw = in.getList("composite-list.abc.def");
-
-        assertEquals(stacks.size(), raw.size());
-        assertEquals(stacks.get(0), raw.get(0));
-        assertEquals(stacks.get(1), raw.get(1));
-        assertEquals(stacks.get(2), raw.get(2));
-        assertEquals(stacks.get(3), raw.get(3));
-        assertEquals(stacks.get(4), raw.get(4));
-        assertEquals(stacks.get(5), raw.get(5));
-        assertEquals(stacks.get(6), raw.get(6));
-        assertEquals(stacks.get(7), raw.get(7));
-        assertEquals(stacks.get(8), raw.get(8));
-    }
 }