PaintMap.html 21 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297
  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
  2. <html lang="en">
  3. <head>
  4. <title>Source code</title>
  5. <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
  6. </head>
  7. <body>
  8. <div class="sourceContainer">
  9. <pre><span class="sourceLineNo">001</span>/* ===========================================================<a name="line.1"></a>
  10. <span class="sourceLineNo">002</span> * JFreeChart : a free chart library for the Java(tm) platform<a name="line.2"></a>
  11. <span class="sourceLineNo">003</span> * ===========================================================<a name="line.3"></a>
  12. <span class="sourceLineNo">004</span> *<a name="line.4"></a>
  13. <span class="sourceLineNo">005</span> * (C) Copyright 2000-2014, by Object Refinery Limited and Contributors.<a name="line.5"></a>
  14. <span class="sourceLineNo">006</span> *<a name="line.6"></a>
  15. <span class="sourceLineNo">007</span> * Project Info: http://www.jfree.org/jfreechart/index.html<a name="line.7"></a>
  16. <span class="sourceLineNo">008</span> *<a name="line.8"></a>
  17. <span class="sourceLineNo">009</span> * This library is free software; you can redistribute it and/or modify it<a name="line.9"></a>
  18. <span class="sourceLineNo">010</span> * under the terms of the GNU Lesser General Public License as published by<a name="line.10"></a>
  19. <span class="sourceLineNo">011</span> * the Free Software Foundation; either version 2.1 of the License, or<a name="line.11"></a>
  20. <span class="sourceLineNo">012</span> * (at your option) any later version.<a name="line.12"></a>
  21. <span class="sourceLineNo">013</span> *<a name="line.13"></a>
  22. <span class="sourceLineNo">014</span> * This library is distributed in the hope that it will be useful, but<a name="line.14"></a>
  23. <span class="sourceLineNo">015</span> * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY<a name="line.15"></a>
  24. <span class="sourceLineNo">016</span> * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public<a name="line.16"></a>
  25. <span class="sourceLineNo">017</span> * License for more details.<a name="line.17"></a>
  26. <span class="sourceLineNo">018</span> *<a name="line.18"></a>
  27. <span class="sourceLineNo">019</span> * You should have received a copy of the GNU Lesser General Public<a name="line.19"></a>
  28. <span class="sourceLineNo">020</span> * License along with this library; if not, write to the Free Software<a name="line.20"></a>
  29. <span class="sourceLineNo">021</span> * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,<a name="line.21"></a>
  30. <span class="sourceLineNo">022</span> * USA.<a name="line.22"></a>
  31. <span class="sourceLineNo">023</span> *<a name="line.23"></a>
  32. <span class="sourceLineNo">024</span> * [Oracle and Java are registered trademarks of Oracle and/or its affiliates. <a name="line.24"></a>
  33. <span class="sourceLineNo">025</span> * Other names may be trademarks of their respective owners.]<a name="line.25"></a>
  34. <span class="sourceLineNo">026</span> *<a name="line.26"></a>
  35. <span class="sourceLineNo">027</span> * -------------<a name="line.27"></a>
  36. <span class="sourceLineNo">028</span> * PaintMap.java<a name="line.28"></a>
  37. <span class="sourceLineNo">029</span> * -------------<a name="line.29"></a>
  38. <span class="sourceLineNo">030</span> * (C) Copyright 2006-2014, by Object Refinery Limited.<a name="line.30"></a>
  39. <span class="sourceLineNo">031</span> *<a name="line.31"></a>
  40. <span class="sourceLineNo">032</span> * Original Author: David Gilbert (for Object Refinery Limited);<a name="line.32"></a>
  41. <span class="sourceLineNo">033</span> * Contributor(s): -;<a name="line.33"></a>
  42. <span class="sourceLineNo">034</span> *<a name="line.34"></a>
  43. <span class="sourceLineNo">035</span> * Changes:<a name="line.35"></a>
  44. <span class="sourceLineNo">036</span> * --------<a name="line.36"></a>
  45. <span class="sourceLineNo">037</span> * 27-Sep-2006 : Version 1 (DG);<a name="line.37"></a>
  46. <span class="sourceLineNo">038</span> * 17-Jan-2007 : Changed TreeMap to HashMap, so that different classes that<a name="line.38"></a>
  47. <span class="sourceLineNo">039</span> * implement Comparable can be used as keys (DG);<a name="line.39"></a>
  48. <span class="sourceLineNo">040</span> * 02-Jul-2013 : Use ParamChecks class (DG);<a name="line.40"></a>
  49. <span class="sourceLineNo">041</span> *<a name="line.41"></a>
  50. <span class="sourceLineNo">042</span> */<a name="line.42"></a>
  51. <span class="sourceLineNo">043</span><a name="line.43"></a>
  52. <span class="sourceLineNo">044</span>package org.jfree.chart;<a name="line.44"></a>
  53. <span class="sourceLineNo">045</span><a name="line.45"></a>
  54. <span class="sourceLineNo">046</span>import java.awt.Paint;<a name="line.46"></a>
  55. <span class="sourceLineNo">047</span>import java.io.IOException;<a name="line.47"></a>
  56. <span class="sourceLineNo">048</span>import java.io.ObjectInputStream;<a name="line.48"></a>
  57. <span class="sourceLineNo">049</span>import java.io.ObjectOutputStream;<a name="line.49"></a>
  58. <span class="sourceLineNo">050</span>import java.io.Serializable;<a name="line.50"></a>
  59. <span class="sourceLineNo">051</span>import java.util.HashMap;<a name="line.51"></a>
  60. <span class="sourceLineNo">052</span>import java.util.Iterator;<a name="line.52"></a>
  61. <span class="sourceLineNo">053</span>import java.util.Map;<a name="line.53"></a>
  62. <span class="sourceLineNo">054</span>import java.util.Set;<a name="line.54"></a>
  63. <span class="sourceLineNo">055</span>import org.jfree.chart.util.ParamChecks;<a name="line.55"></a>
  64. <span class="sourceLineNo">056</span><a name="line.56"></a>
  65. <span class="sourceLineNo">057</span>import org.jfree.io.SerialUtilities;<a name="line.57"></a>
  66. <span class="sourceLineNo">058</span>import org.jfree.util.PaintUtilities;<a name="line.58"></a>
  67. <span class="sourceLineNo">059</span><a name="line.59"></a>
  68. <span class="sourceLineNo">060</span>/**<a name="line.60"></a>
  69. <span class="sourceLineNo">061</span> * A storage structure that maps &lt;code&gt;Comparable&lt;/code&gt; instances with<a name="line.61"></a>
  70. <span class="sourceLineNo">062</span> * &lt;code&gt;Paint&lt;/code&gt; instances.<a name="line.62"></a>
  71. <span class="sourceLineNo">063</span> * &lt;br&gt;&lt;br&gt;<a name="line.63"></a>
  72. <span class="sourceLineNo">064</span> * To support cloning and serialization, you should only use keys that are<a name="line.64"></a>
  73. <span class="sourceLineNo">065</span> * cloneable and serializable. Special handling for the &lt;code&gt;Paint&lt;/code&gt;<a name="line.65"></a>
  74. <span class="sourceLineNo">066</span> * instances is included in this class.<a name="line.66"></a>
  75. <span class="sourceLineNo">067</span> *<a name="line.67"></a>
  76. <span class="sourceLineNo">068</span> * @since 1.0.3<a name="line.68"></a>
  77. <span class="sourceLineNo">069</span> */<a name="line.69"></a>
  78. <span class="sourceLineNo">070</span>public class PaintMap implements Cloneable, Serializable {<a name="line.70"></a>
  79. <span class="sourceLineNo">071</span><a name="line.71"></a>
  80. <span class="sourceLineNo">072</span> /** For serialization. */<a name="line.72"></a>
  81. <span class="sourceLineNo">073</span> static final long serialVersionUID = -4639833772123069274L;<a name="line.73"></a>
  82. <span class="sourceLineNo">074</span><a name="line.74"></a>
  83. <span class="sourceLineNo">075</span> /** Storage for the keys and values. */<a name="line.75"></a>
  84. <span class="sourceLineNo">076</span> private transient Map store;<a name="line.76"></a>
  85. <span class="sourceLineNo">077</span><a name="line.77"></a>
  86. <span class="sourceLineNo">078</span> /**<a name="line.78"></a>
  87. <span class="sourceLineNo">079</span> * Creates a new (empty) map.<a name="line.79"></a>
  88. <span class="sourceLineNo">080</span> */<a name="line.80"></a>
  89. <span class="sourceLineNo">081</span> public PaintMap() {<a name="line.81"></a>
  90. <span class="sourceLineNo">082</span> this.store = new HashMap();<a name="line.82"></a>
  91. <span class="sourceLineNo">083</span> }<a name="line.83"></a>
  92. <span class="sourceLineNo">084</span><a name="line.84"></a>
  93. <span class="sourceLineNo">085</span> /**<a name="line.85"></a>
  94. <span class="sourceLineNo">086</span> * Returns the paint associated with the specified key, or<a name="line.86"></a>
  95. <span class="sourceLineNo">087</span> * &lt;code&gt;null&lt;/code&gt;.<a name="line.87"></a>
  96. <span class="sourceLineNo">088</span> *<a name="line.88"></a>
  97. <span class="sourceLineNo">089</span> * @param key the key (&lt;code&gt;null&lt;/code&gt; not permitted).<a name="line.89"></a>
  98. <span class="sourceLineNo">090</span> *<a name="line.90"></a>
  99. <span class="sourceLineNo">091</span> * @return The paint, or &lt;code&gt;null&lt;/code&gt;.<a name="line.91"></a>
  100. <span class="sourceLineNo">092</span> *<a name="line.92"></a>
  101. <span class="sourceLineNo">093</span> * @throws IllegalArgumentException if &lt;code&gt;key&lt;/code&gt; is<a name="line.93"></a>
  102. <span class="sourceLineNo">094</span> * &lt;code&gt;null&lt;/code&gt;.<a name="line.94"></a>
  103. <span class="sourceLineNo">095</span> */<a name="line.95"></a>
  104. <span class="sourceLineNo">096</span> public Paint getPaint(Comparable key) {<a name="line.96"></a>
  105. <span class="sourceLineNo">097</span> ParamChecks.nullNotPermitted(key, "key");<a name="line.97"></a>
  106. <span class="sourceLineNo">098</span> return (Paint) this.store.get(key);<a name="line.98"></a>
  107. <span class="sourceLineNo">099</span> }<a name="line.99"></a>
  108. <span class="sourceLineNo">100</span><a name="line.100"></a>
  109. <span class="sourceLineNo">101</span> /**<a name="line.101"></a>
  110. <span class="sourceLineNo">102</span> * Returns &lt;code&gt;true&lt;/code&gt; if the map contains the specified key, and<a name="line.102"></a>
  111. <span class="sourceLineNo">103</span> * &lt;code&gt;false&lt;/code&gt; otherwise.<a name="line.103"></a>
  112. <span class="sourceLineNo">104</span> *<a name="line.104"></a>
  113. <span class="sourceLineNo">105</span> * @param key the key.<a name="line.105"></a>
  114. <span class="sourceLineNo">106</span> *<a name="line.106"></a>
  115. <span class="sourceLineNo">107</span> * @return &lt;code&gt;true&lt;/code&gt; if the map contains the specified key, and<a name="line.107"></a>
  116. <span class="sourceLineNo">108</span> * &lt;code&gt;false&lt;/code&gt; otherwise.<a name="line.108"></a>
  117. <span class="sourceLineNo">109</span> */<a name="line.109"></a>
  118. <span class="sourceLineNo">110</span> public boolean containsKey(Comparable key) {<a name="line.110"></a>
  119. <span class="sourceLineNo">111</span> return this.store.containsKey(key);<a name="line.111"></a>
  120. <span class="sourceLineNo">112</span> }<a name="line.112"></a>
  121. <span class="sourceLineNo">113</span><a name="line.113"></a>
  122. <span class="sourceLineNo">114</span> /**<a name="line.114"></a>
  123. <span class="sourceLineNo">115</span> * Adds a mapping between the specified &lt;code&gt;key&lt;/code&gt; and<a name="line.115"></a>
  124. <span class="sourceLineNo">116</span> * &lt;code&gt;paint&lt;/code&gt; values.<a name="line.116"></a>
  125. <span class="sourceLineNo">117</span> *<a name="line.117"></a>
  126. <span class="sourceLineNo">118</span> * @param key the key (&lt;code&gt;null&lt;/code&gt; not permitted).<a name="line.118"></a>
  127. <span class="sourceLineNo">119</span> * @param paint the paint.<a name="line.119"></a>
  128. <span class="sourceLineNo">120</span> *<a name="line.120"></a>
  129. <span class="sourceLineNo">121</span> * @throws IllegalArgumentException if &lt;code&gt;key&lt;/code&gt; is<a name="line.121"></a>
  130. <span class="sourceLineNo">122</span> * &lt;code&gt;null&lt;/code&gt;.<a name="line.122"></a>
  131. <span class="sourceLineNo">123</span> */<a name="line.123"></a>
  132. <span class="sourceLineNo">124</span> public void put(Comparable key, Paint paint) {<a name="line.124"></a>
  133. <span class="sourceLineNo">125</span> ParamChecks.nullNotPermitted(key, "key");<a name="line.125"></a>
  134. <span class="sourceLineNo">126</span> this.store.put(key, paint);<a name="line.126"></a>
  135. <span class="sourceLineNo">127</span> }<a name="line.127"></a>
  136. <span class="sourceLineNo">128</span><a name="line.128"></a>
  137. <span class="sourceLineNo">129</span> /**<a name="line.129"></a>
  138. <span class="sourceLineNo">130</span> * Resets the map to empty.<a name="line.130"></a>
  139. <span class="sourceLineNo">131</span> */<a name="line.131"></a>
  140. <span class="sourceLineNo">132</span> public void clear() {<a name="line.132"></a>
  141. <span class="sourceLineNo">133</span> this.store.clear();<a name="line.133"></a>
  142. <span class="sourceLineNo">134</span> }<a name="line.134"></a>
  143. <span class="sourceLineNo">135</span><a name="line.135"></a>
  144. <span class="sourceLineNo">136</span> /**<a name="line.136"></a>
  145. <span class="sourceLineNo">137</span> * Tests this map for equality with an arbitrary object.<a name="line.137"></a>
  146. <span class="sourceLineNo">138</span> *<a name="line.138"></a>
  147. <span class="sourceLineNo">139</span> * @param obj the object (&lt;code&gt;null&lt;/code&gt; permitted).<a name="line.139"></a>
  148. <span class="sourceLineNo">140</span> *<a name="line.140"></a>
  149. <span class="sourceLineNo">141</span> * @return A boolean.<a name="line.141"></a>
  150. <span class="sourceLineNo">142</span> */<a name="line.142"></a>
  151. <span class="sourceLineNo">143</span> @Override<a name="line.143"></a>
  152. <span class="sourceLineNo">144</span> public boolean equals(Object obj) {<a name="line.144"></a>
  153. <span class="sourceLineNo">145</span> if (obj == this) {<a name="line.145"></a>
  154. <span class="sourceLineNo">146</span> return true;<a name="line.146"></a>
  155. <span class="sourceLineNo">147</span> }<a name="line.147"></a>
  156. <span class="sourceLineNo">148</span> if (!(obj instanceof PaintMap)) {<a name="line.148"></a>
  157. <span class="sourceLineNo">149</span> return false;<a name="line.149"></a>
  158. <span class="sourceLineNo">150</span> }<a name="line.150"></a>
  159. <span class="sourceLineNo">151</span> PaintMap that = (PaintMap) obj;<a name="line.151"></a>
  160. <span class="sourceLineNo">152</span> if (this.store.size() != that.store.size()) {<a name="line.152"></a>
  161. <span class="sourceLineNo">153</span> return false;<a name="line.153"></a>
  162. <span class="sourceLineNo">154</span> }<a name="line.154"></a>
  163. <span class="sourceLineNo">155</span> Set keys = this.store.keySet();<a name="line.155"></a>
  164. <span class="sourceLineNo">156</span> Iterator iterator = keys.iterator();<a name="line.156"></a>
  165. <span class="sourceLineNo">157</span> while (iterator.hasNext()) {<a name="line.157"></a>
  166. <span class="sourceLineNo">158</span> Comparable key = (Comparable) iterator.next();<a name="line.158"></a>
  167. <span class="sourceLineNo">159</span> Paint p1 = getPaint(key);<a name="line.159"></a>
  168. <span class="sourceLineNo">160</span> Paint p2 = that.getPaint(key);<a name="line.160"></a>
  169. <span class="sourceLineNo">161</span> if (!PaintUtilities.equal(p1, p2)) {<a name="line.161"></a>
  170. <span class="sourceLineNo">162</span> return false;<a name="line.162"></a>
  171. <span class="sourceLineNo">163</span> }<a name="line.163"></a>
  172. <span class="sourceLineNo">164</span> }<a name="line.164"></a>
  173. <span class="sourceLineNo">165</span> return true;<a name="line.165"></a>
  174. <span class="sourceLineNo">166</span> }<a name="line.166"></a>
  175. <span class="sourceLineNo">167</span><a name="line.167"></a>
  176. <span class="sourceLineNo">168</span> /**<a name="line.168"></a>
  177. <span class="sourceLineNo">169</span> * Returns a clone of this &lt;code&gt;PaintMap&lt;/code&gt;.<a name="line.169"></a>
  178. <span class="sourceLineNo">170</span> *<a name="line.170"></a>
  179. <span class="sourceLineNo">171</span> * @return A clone of this instance.<a name="line.171"></a>
  180. <span class="sourceLineNo">172</span> *<a name="line.172"></a>
  181. <span class="sourceLineNo">173</span> * @throws CloneNotSupportedException if any key is not cloneable.<a name="line.173"></a>
  182. <span class="sourceLineNo">174</span> */<a name="line.174"></a>
  183. <span class="sourceLineNo">175</span> @Override<a name="line.175"></a>
  184. <span class="sourceLineNo">176</span> public Object clone() throws CloneNotSupportedException {<a name="line.176"></a>
  185. <span class="sourceLineNo">177</span> PaintMap clone = (PaintMap) super.clone();<a name="line.177"></a>
  186. <span class="sourceLineNo">178</span> clone.store = new HashMap();<a name="line.178"></a>
  187. <span class="sourceLineNo">179</span> clone.store.putAll(this.store);<a name="line.179"></a>
  188. <span class="sourceLineNo">180</span> // TODO: I think we need to make sure the keys are actually cloned,<a name="line.180"></a>
  189. <span class="sourceLineNo">181</span> // whereas the paint instances are always immutable so they're OK<a name="line.181"></a>
  190. <span class="sourceLineNo">182</span> return clone;<a name="line.182"></a>
  191. <span class="sourceLineNo">183</span> }<a name="line.183"></a>
  192. <span class="sourceLineNo">184</span><a name="line.184"></a>
  193. <span class="sourceLineNo">185</span> /**<a name="line.185"></a>
  194. <span class="sourceLineNo">186</span> * Provides serialization support.<a name="line.186"></a>
  195. <span class="sourceLineNo">187</span> *<a name="line.187"></a>
  196. <span class="sourceLineNo">188</span> * @param stream the output stream.<a name="line.188"></a>
  197. <span class="sourceLineNo">189</span> *<a name="line.189"></a>
  198. <span class="sourceLineNo">190</span> * @throws IOException if there is an I/O error.<a name="line.190"></a>
  199. <span class="sourceLineNo">191</span> */<a name="line.191"></a>
  200. <span class="sourceLineNo">192</span> private void writeObject(ObjectOutputStream stream) throws IOException {<a name="line.192"></a>
  201. <span class="sourceLineNo">193</span> stream.defaultWriteObject();<a name="line.193"></a>
  202. <span class="sourceLineNo">194</span> stream.writeInt(this.store.size());<a name="line.194"></a>
  203. <span class="sourceLineNo">195</span> Set keys = this.store.keySet();<a name="line.195"></a>
  204. <span class="sourceLineNo">196</span> Iterator iterator = keys.iterator();<a name="line.196"></a>
  205. <span class="sourceLineNo">197</span> while (iterator.hasNext()) {<a name="line.197"></a>
  206. <span class="sourceLineNo">198</span> Comparable key = (Comparable) iterator.next();<a name="line.198"></a>
  207. <span class="sourceLineNo">199</span> stream.writeObject(key);<a name="line.199"></a>
  208. <span class="sourceLineNo">200</span> Paint paint = getPaint(key);<a name="line.200"></a>
  209. <span class="sourceLineNo">201</span> SerialUtilities.writePaint(paint, stream);<a name="line.201"></a>
  210. <span class="sourceLineNo">202</span> }<a name="line.202"></a>
  211. <span class="sourceLineNo">203</span> }<a name="line.203"></a>
  212. <span class="sourceLineNo">204</span><a name="line.204"></a>
  213. <span class="sourceLineNo">205</span> /**<a name="line.205"></a>
  214. <span class="sourceLineNo">206</span> * Provides serialization support.<a name="line.206"></a>
  215. <span class="sourceLineNo">207</span> *<a name="line.207"></a>
  216. <span class="sourceLineNo">208</span> * @param stream the input stream.<a name="line.208"></a>
  217. <span class="sourceLineNo">209</span> *<a name="line.209"></a>
  218. <span class="sourceLineNo">210</span> * @throws IOException if there is an I/O error.<a name="line.210"></a>
  219. <span class="sourceLineNo">211</span> * @throws ClassNotFoundException if there is a classpath problem.<a name="line.211"></a>
  220. <span class="sourceLineNo">212</span> */<a name="line.212"></a>
  221. <span class="sourceLineNo">213</span> private void readObject(ObjectInputStream stream)<a name="line.213"></a>
  222. <span class="sourceLineNo">214</span> throws IOException, ClassNotFoundException {<a name="line.214"></a>
  223. <span class="sourceLineNo">215</span> stream.defaultReadObject();<a name="line.215"></a>
  224. <span class="sourceLineNo">216</span> this.store = new HashMap();<a name="line.216"></a>
  225. <span class="sourceLineNo">217</span> int keyCount = stream.readInt();<a name="line.217"></a>
  226. <span class="sourceLineNo">218</span> for (int i = 0; i &lt; keyCount; i++) {<a name="line.218"></a>
  227. <span class="sourceLineNo">219</span> Comparable key = (Comparable) stream.readObject();<a name="line.219"></a>
  228. <span class="sourceLineNo">220</span> Paint paint = SerialUtilities.readPaint(stream);<a name="line.220"></a>
  229. <span class="sourceLineNo">221</span> this.store.put(key, paint);<a name="line.221"></a>
  230. <span class="sourceLineNo">222</span> }<a name="line.222"></a>
  231. <span class="sourceLineNo">223</span> }<a name="line.223"></a>
  232. <span class="sourceLineNo">224</span><a name="line.224"></a>
  233. <span class="sourceLineNo">225</span>}<a name="line.225"></a>
  234. </pre>
  235. </div>
  236. </body>
  237. </html>