/* ===========================================================
 * JFreeChart : a free chart library for the Java(tm) platform
 * ===========================================================
 *
 * (C) Copyright 2000-2004, by Object Refinery Limited and Contributors.
 *
 * Project Info:  http://www.jfree.org/jfreechart/index.html
 *
 * This library is free software; you can redistribute it and/or modify it under the terms
 * of the GNU Lesser General Public License as published by the Free Software Foundation;
 * either version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
 * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 * See the GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License along with this
 * library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
 * Boston, MA 02111-1307, USA.
 *
 * [Java is a trademark or registered trademark of Sun Microsystems, Inc. 
 * in the United States and other countries.]
 *
 * --------------------
 * LegendItemTests.java
 * --------------------
 * (C) Copyright 2004, by Object Refinery Limited and Contributors.
 *
 * Original Author:  David Gilbert (for Object Refinery Limited);
 * Contributor(s):   -;
 *
 * $Id: LegendItemTests.java,v 1.2 2004/11/27 17:13:46 mungady Exp $
 *
 * Changes
 * -------
 * 04-Jun-2004 : Version 1 (DG);
 *
 */

package org.jfree.chart.junit;

import java.awt.BasicStroke;
import java.awt.Color;
import java.awt.geom.Line2D;
import java.awt.geom.Rectangle2D;
import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;
import java.io.ObjectInput;
import java.io.ObjectInputStream;
import java.io.ObjectOutput;
import java.io.ObjectOutputStream;

import junit.framework.Test;
import junit.framework.TestCase;
import junit.framework.TestSuite;

import org.jfree.chart.LegendItem;

/**
 * Tests for the {@link LegendItem} class.
 */
public class LegendItemTests extends TestCase {

    /**
     * Returns the tests as a test suite.
     *
     * @return The test suite.
     */
    public static Test suite() {
        return new TestSuite(LegendItemTests.class);
    }

    /**
     * Constructs a new set of tests.
     *
     * @param name  the name of the tests.
     */
    public LegendItemTests(String name) {
        super(name);
    }

    /**
     * Confirm that the equals method can distinguish all the required fields.
     */
    public void testEquals() {
        
        LegendItem item1 = new LegendItem(
            "Label", "Description", true, new Rectangle2D.Double(1.0, 2.0, 3.0, 4.0), 
            true, Color.red, true, Color.blue, new BasicStroke(1.2f), true, 
            new Line2D.Double(1.0, 2.0, 3.0, 4.0), new BasicStroke(2.1f), Color.green
        ); 
        LegendItem item2 = new LegendItem(
            "Label", "Description", true, new Rectangle2D.Double(1.0, 2.0, 3.0, 4.0), 
            true, Color.red, true, Color.blue, new BasicStroke(1.2f), true, 
            new Line2D.Double(1.0, 2.0, 3.0, 4.0), new BasicStroke(2.1f), Color.green
        );  
        assertTrue(item1.equals(item2));  
        assertTrue(item2.equals(item1));  
        
        item1 = new LegendItem(
            "Label2", "Description", true, new Rectangle2D.Double(1.0, 2.0, 3.0, 4.0), 
            true, Color.red, true, Color.blue, new BasicStroke(1.2f), true, 
            new Line2D.Double(1.0, 2.0, 3.0, 4.0), new BasicStroke(2.1f), Color.green
        ); 
        assertFalse(item1.equals(item2));
        item2 = new LegendItem(
            "Label2", "Description", true, new Rectangle2D.Double(1.0, 2.0, 3.0, 4.0), 
            true, Color.red, true, Color.blue, new BasicStroke(1.2f), true, 
            new Line2D.Double(1.0, 2.0, 3.0, 4.0), new BasicStroke(2.1f), Color.green
        ); 
        assertTrue(item1.equals(item2));
        
        item1 = new LegendItem(
            "Label2", "Description2", true, new Rectangle2D.Double(1.0, 2.0, 3.0, 4.0), 
            true, Color.red, true, Color.blue, new BasicStroke(1.2f), true, 
            new Line2D.Double(1.0, 2.0, 3.0, 4.0), new BasicStroke(2.1f), Color.green
        ); 
        assertFalse(item1.equals(item2));
        item2 = new LegendItem(
            "Label2", "Description2", true, new Rectangle2D.Double(1.0, 2.0, 3.0, 4.0), 
            true, Color.red, true, Color.blue, new BasicStroke(1.2f), true, 
            new Line2D.Double(1.0, 2.0, 3.0, 4.0), new BasicStroke(2.1f), Color.green
        ); 
        assertTrue(item1.equals(item2));
        
        item1 = new LegendItem(
            "Label2", "Description2", false, new Rectangle2D.Double(1.0, 2.0, 3.0, 4.0), 
            true, Color.red, true, Color.blue, new BasicStroke(1.2f), true, 
            new Line2D.Double(1.0, 2.0, 3.0, 4.0), new BasicStroke(2.1f), Color.green
        ); 
        assertFalse(item1.equals(item2));
        item2 = new LegendItem(
            "Label2", "Description2", false, new Rectangle2D.Double(1.0, 2.0, 3.0, 4.0), 
            true, Color.red, true, Color.blue, new BasicStroke(1.2f), true, 
            new Line2D.Double(1.0, 2.0, 3.0, 4.0), new BasicStroke(2.1f), Color.green
        ); 
        assertTrue(item1.equals(item2));
        
        item1 = new LegendItem(
            "Label2", "Description2", false, new Rectangle2D.Double(4.0, 3.0, 2.0, 1.0), 
            true, Color.red, true, Color.blue, new BasicStroke(1.2f), true, 
            new Line2D.Double(1.0, 2.0, 3.0, 4.0), new BasicStroke(2.1f), Color.green
        ); 
        assertFalse(item1.equals(item2));
        item2 = new LegendItem(
            "Label2", "Description2", false, new Rectangle2D.Double(4.0, 3.0, 2.0, 1.0), 
            true, Color.red, true, Color.blue, new BasicStroke(1.2f), true, 
            new Line2D.Double(1.0, 2.0, 3.0, 4.0), new BasicStroke(2.1f), Color.green
        ); 
        assertTrue(item1.equals(item2));
        
        item1 = new LegendItem(
            "Label2", "Description2", false, new Rectangle2D.Double(4.0, 3.0, 2.0, 1.0), 
            false, Color.red, true, Color.blue, new BasicStroke(1.2f), true, 
            new Line2D.Double(1.0, 2.0, 3.0, 4.0), new BasicStroke(2.1f), Color.green
        ); 
        assertFalse(item1.equals(item2));
        item2 = new LegendItem(
            "Label2", "Description2", false, new Rectangle2D.Double(4.0, 3.0, 2.0, 1.0), 
            false, Color.red, true, Color.blue, new BasicStroke(1.2f), true, 
            new Line2D.Double(1.0, 2.0, 3.0, 4.0), new BasicStroke(2.1f), Color.green
        ); 
        assertTrue(item1.equals(item2));
        
        item1 = new LegendItem(
            "Label2", "Description2", false, new Rectangle2D.Double(4.0, 3.0, 2.0, 1.0), 
            false, Color.black, true, Color.blue, new BasicStroke(1.2f), true, 
            new Line2D.Double(1.0, 2.0, 3.0, 4.0), new BasicStroke(2.1f), Color.green
        ); 
        assertFalse(item1.equals(item2));
        item2 = new LegendItem(
            "Label2", "Description2", false, new Rectangle2D.Double(4.0, 3.0, 2.0, 1.0), 
            false, Color.black, true, Color.blue, new BasicStroke(1.2f), true, 
            new Line2D.Double(1.0, 2.0, 3.0, 4.0), new BasicStroke(2.1f), Color.green
        ); 
        assertTrue(item1.equals(item2));
        
        item1 = new LegendItem(
            "Label2", "Description2", false, new Rectangle2D.Double(4.0, 3.0, 2.0, 1.0), 
            false, Color.black, false, Color.blue, new BasicStroke(1.2f), true, 
            new Line2D.Double(1.0, 2.0, 3.0, 4.0), new BasicStroke(2.1f), Color.green
        ); 
        assertFalse(item1.equals(item2));
        item2 = new LegendItem(
            "Label2", "Description2", false, new Rectangle2D.Double(4.0, 3.0, 2.0, 1.0), 
            false, Color.black, false, Color.blue, new BasicStroke(1.2f), true, 
            new Line2D.Double(1.0, 2.0, 3.0, 4.0), new BasicStroke(2.1f), Color.green
        ); 
        assertTrue(item1.equals(item2));
        
        item1 = new LegendItem(
            "Label2", "Description2", false, new Rectangle2D.Double(4.0, 3.0, 2.0, 1.0), 
            false, Color.black, false, Color.yellow, new BasicStroke(1.2f), true, 
            new Line2D.Double(1.0, 2.0, 3.0, 4.0), new BasicStroke(2.1f), Color.green
        ); 
        assertFalse(item1.equals(item2));
        item2 = new LegendItem(
            "Label2", "Description2", false, new Rectangle2D.Double(4.0, 3.0, 2.0, 1.0), 
            false, Color.black, false, Color.yellow, new BasicStroke(1.2f), true, 
            new Line2D.Double(1.0, 2.0, 3.0, 4.0), new BasicStroke(2.1f), Color.green
        ); 
        assertTrue(item1.equals(item2));
        
        item1 = new LegendItem(
            "Label2", "Description2", false, new Rectangle2D.Double(4.0, 3.0, 2.0, 1.0), 
            false, Color.black, false, Color.yellow, new BasicStroke(2.1f), true, 
            new Line2D.Double(1.0, 2.0, 3.0, 4.0), new BasicStroke(2.1f), Color.green
        ); 
        assertFalse(item1.equals(item2));
        item2 = new LegendItem(
            "Label2", "Description2", false, new Rectangle2D.Double(4.0, 3.0, 2.0, 1.0), 
            false, Color.black, false, Color.yellow, new BasicStroke(2.1f), true, 
            new Line2D.Double(1.0, 2.0, 3.0, 4.0), new BasicStroke(2.1f), Color.green
        ); 
        assertTrue(item1.equals(item2));
        
        item1 = new LegendItem(
            "Label2", "Description2", false, new Rectangle2D.Double(4.0, 3.0, 2.0, 1.0), 
            false, Color.black, false, Color.yellow, new BasicStroke(2.1f), false, 
            new Line2D.Double(1.0, 2.0, 3.0, 4.0), new BasicStroke(2.1f), Color.green
        ); 
        assertFalse(item1.equals(item2));
        item2 = new LegendItem(
            "Label2", "Description2", false, new Rectangle2D.Double(4.0, 3.0, 2.0, 1.0), 
            false, Color.black, false, Color.yellow, new BasicStroke(2.1f), false, 
            new Line2D.Double(1.0, 2.0, 3.0, 4.0), new BasicStroke(2.1f), Color.green
        ); 
        assertTrue(item1.equals(item2));
        
        item1 = new LegendItem(
            "Label2", "Description2", false, new Rectangle2D.Double(4.0, 3.0, 2.0, 1.0), 
            false, Color.black, false, Color.yellow, new BasicStroke(2.1f), false, 
            new Line2D.Double(4.0, 3.0, 2.0, 1.0), new BasicStroke(2.1f), Color.green
        ); 
        assertFalse(item1.equals(item2));
        item2 = new LegendItem(
            "Label2", "Description2", false, new Rectangle2D.Double(4.0, 3.0, 2.0, 1.0), 
            false, Color.black, false, Color.yellow, new BasicStroke(2.1f), false, 
            new Line2D.Double(4.0, 3.0, 2.0, 1.0), new BasicStroke(2.1f), Color.green
        ); 
        assertTrue(item1.equals(item2));
        
        item1 = new LegendItem(
            "Label2", "Description2", false, new Rectangle2D.Double(4.0, 3.0, 2.0, 1.0), 
            false, Color.black, false, Color.yellow, new BasicStroke(2.1f), false, 
            new Line2D.Double(4.0, 3.0, 2.0, 1.0), new BasicStroke(3.3f), Color.green
        ); 
        assertFalse(item1.equals(item2));
        item2 = new LegendItem(
            "Label2", "Description2", false, new Rectangle2D.Double(4.0, 3.0, 2.0, 1.0), 
            false, Color.black, false, Color.yellow, new BasicStroke(2.1f), false, 
            new Line2D.Double(4.0, 3.0, 2.0, 1.0), new BasicStroke(3.3f), Color.green
        ); 
        assertTrue(item1.equals(item2));
        
        item1 = new LegendItem(
            "Label2", "Description2", false, new Rectangle2D.Double(4.0, 3.0, 2.0, 1.0), 
            false, Color.black, false, Color.yellow, new BasicStroke(2.1f), false, 
            new Line2D.Double(4.0, 3.0, 2.0, 1.0), new BasicStroke(3.3f), Color.white
        ); 
        assertFalse(item1.equals(item2));
        item2 = new LegendItem(
            "Label2", "Description2", false, new Rectangle2D.Double(4.0, 3.0, 2.0, 1.0), 
            false, Color.black, false, Color.yellow, new BasicStroke(2.1f), false, 
            new Line2D.Double(4.0, 3.0, 2.0, 1.0), new BasicStroke(3.3f), Color.white
        ); 
        assertTrue(item1.equals(item2));
        
    }

    /**
     * Serialize an instance, restore it, and check for equality.
     */
    public void testSerialization() {
        LegendItem item1 = new LegendItem(
            "Item", "Description", new Rectangle2D.Double(1.0, 2.0, 3.0, 4.0), Color.red
        ); 
        LegendItem item2 = null;
        try {
            ByteArrayOutputStream buffer = new ByteArrayOutputStream();
            ObjectOutput out = new ObjectOutputStream(buffer);
            out.writeObject(item1);
            out.close();

            ObjectInput in = new ObjectInputStream(new ByteArrayInputStream(buffer.toByteArray()));
            item2 = (LegendItem) in.readObject();
            in.close();
        }
        catch (Exception e) {
            System.out.println(e.toString());
        }
        assertEquals(item1, item2);
    }

}