/* ===========================================================
 
* JFreeChart : a free chart library for the Java(tm) platform
 
* ===========================================================
 
*
 
* (C) Copyright 2000-2016, 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., 51 Franklin Street, Fifth Floor, Boston, MA
  
02110-1301,
 
* USA.
 
*
 
* [Oracle and Java are registered trademarks of Oracle and/or its affiliates.
 
* Other names may be trademarks of their respective owners.]
 
*
 
* --------------
 
* StrokeMap.java
 
* --------------
 
* (C) Copyright 2006-2016, by Object Refinery Limited.
 
*
 
* Original Author:
  
David Gilbert (for Object Refinery Limited);
 
* Contributor(s):
   
-;
 
*
 
* Changes:
 
* --------
 
* 27-Sep-2006 : Version 1 (DG);
 
* 02-Jul-2013 : Use ParamChecks (DG);
 
*
 
*/

package org.jfree.chart;

import java.awt.Stroke;
import java.io.IOException;
import java.io.ObjectInputStream;
import java.io.ObjectOutputStream;
import java.io.Serializable;
import java.util.Iterator;
import java.util.Map;
import java.util.Set;
import java.util.TreeMap;
import org.jfree.chart.util.ObjectUtils;
import org.jfree.chart.util.Args;
import org.jfree.chart.util.SerialUtils;

/**
 
* A storage structure that maps {@code Comparable} instances with
 
* {@code Stroke} instances.
 
* <br><br>
 
* To support cloning and serialization, you should only use keys that are
 
* cloneable and serializable.
  
Special handling for the {@code Stroke}
 
* instances is included in this class.
 
*
 
* @since 1.0.3
 
*/

public class StrokeMap implements Cloneable, Serializable {

    
/** For serialization. */
    
static final long serialVersionUID = -8148916785963525169L;

    
/** Storage for the keys and values. */
    
private transient Map store;

    
/**
     
* Creates a new (empty) map.
     
*/
    
public StrokeMap() {
        
this.store = new TreeMap();
    
}

    
/**
     
* Returns the stroke associated with the specified key, or
     
* {@code null}.
     
*
     
* @param key
  
the key ({@code null} not permitted).
     
*
     
* @return The stroke, or {@code null}.
     
*
     
* @throws IllegalArgumentException if {@code key} is
     
*{@code null}.
     
*/

    
public Stroke getStroke(Comparable key) {
        
Args.nullNotPermitted(key, "key");
        
return (Stroke) this.store.get(key);
    
}

    
/**
     
* Returns {@code true} if the map contains the specified key, and
     
* {@code false} otherwise.
     
*
     
* @param key
  
the key.
     
*
     
* @return {@code true} if the map contains the specified key, and
     
* {@code false} otherwise.
     
*/

    
public boolean containsKey(Comparable key) {
        
return this.store.containsKey(key);
    
}

    
/**
     
* Adds a mapping between the specified {@code key} and
     
* {@code stroke} values.
     
*
     
* @param key
  
the key ({@code null} not permitted).
     
* @param stroke
  
the stroke.
     
*/

    
public void put(Comparable key, Stroke stroke) {
        
Args.nullNotPermitted(key, "key");
        
this.store.put(key, stroke);
    
}

    
/**
     
* Resets the map to empty.
     
*/
    
public void clear() {
        
this.store.clear();
    
}

    
/**
     
* Tests this map for equality with an arbitrary object.
     
*
     
* @param obj
  
the object ({@code null} permitted).
     
*
     
* @return A boolean.
     
*/

    
@Override
    
public boolean equals(Object obj) {
        
if (obj == this) {
            
return true;
        
}
        
if (!(obj instanceof StrokeMap)) {
            
return false;
        
}
        
StrokeMap that = (StrokeMap) obj;
        
if (this.store.size() != that.store.size()) {
            
return false;
        
}
        
Set keys = this.store.keySet();
        
Iterator iterator = keys.iterator();
        
while (iterator.hasNext()) {
            
Comparable key = (Comparable) iterator.next();
            
Stroke s1 = getStroke(key);
            
Stroke s2 = that.getStroke(key);
            
if (!ObjectUtils.equal(s1, s2)) {
                
return false;
            
}
        
}
        
return true;
    
}

    
/**
     
* Returns a clone of this {@code StrokeMap}.
     
*
     
* @return A clone of this instance.
     
*
     
* @throws CloneNotSupportedException if any key is not cloneable.
     
*/

    
@Override
    
public Object clone() throws CloneNotSupportedException {
        
StrokeMap clone = (StrokeMap) super.clone();
        
clone.store = new TreeMap();
        
clone.store.putAll(this.store);
        
// TODO: I think we need to make sure the keys are actually cloned,
        
// whereas the stroke instances are always immutable so they're OK
        
return clone;
    
}

    
/**
     
* Provides serialization support.
     
*
     
* @param stream
  
the output stream.
     
*
     
* @throws IOException
  
if there is an I/O error.
     
*/

    
private void writeObject(ObjectOutputStream stream) throws IOException {
        
stream.defaultWriteObject();
        
stream.writeInt(this.store.size());
        
Set keys = this.store.keySet();
        
Iterator iterator = keys.iterator();
        
while (iterator.hasNext()) {
            
Comparable key = (Comparable) iterator.next();
            
stream.writeObject(key);
            
Stroke stroke = getStroke(key);
            
SerialUtils.writeStroke(stroke, stream);
        
}
    
}

    
/**
     
* Provides serialization support.
     
*
     
* @param stream
  
the input stream.
     
*
     
* @throws IOException
  
if there is an I/O error.
     
* @throws ClassNotFoundException
  
if there is a classpath problem.
     
*/

    
private void readObject(ObjectInputStream stream)
            
throws IOException, ClassNotFoundException {
        
stream.defaultReadObject();
        
this.store = new TreeMap();
        
int keyCount = stream.readInt();
        
for (int i = 0; i < keyCount; i++) {
            
Comparable key = (Comparable) stream.readObject();
            
Stroke stroke = SerialUtils.readStroke(stream);
            
this.store.put(key, stroke);
        
}
    
}

}