DateTickUnit.html 58 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724
  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> * DateTickUnit.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 2000-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): Chris Boek;<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> * 08-Nov-2002 : Moved to new package com.jrefinery.chart.axis (DG);<a name="line.37"></a>
  46. <span class="sourceLineNo">038</span> * 27-Nov-2002 : Added IllegalArgumentException to getMillisecondCount()<a name="line.38"></a>
  47. <span class="sourceLineNo">039</span> * method (DG);<a name="line.39"></a>
  48. <span class="sourceLineNo">040</span> * 26-Mar-2003 : Implemented Serializable (DG);<a name="line.40"></a>
  49. <span class="sourceLineNo">041</span> * 12-Nov-2003 : Added roll fields that can improve the labelling on segmented<a name="line.41"></a>
  50. <span class="sourceLineNo">042</span> * date axes (DG);<a name="line.42"></a>
  51. <span class="sourceLineNo">043</span> * 03-Dec-2003 : DateFormat constructor argument is now filled with an default<a name="line.43"></a>
  52. <span class="sourceLineNo">044</span> * if null (TM);<a name="line.44"></a>
  53. <span class="sourceLineNo">045</span> * 07-Dec-2003 : Fixed bug (null pointer exception) in constructor (DG);<a name="line.45"></a>
  54. <span class="sourceLineNo">046</span> * ------------- JFREECHART 1.0.x ---------------------------------------------<a name="line.46"></a>
  55. <span class="sourceLineNo">047</span> * 21-Mar-2007 : Added toString() for debugging (DG);<a name="line.47"></a>
  56. <span class="sourceLineNo">048</span> * 04-Apr-2007 : Added new methods addToDate(Date, TimeZone) and rollDate(Date,<a name="line.48"></a>
  57. <span class="sourceLineNo">049</span> * TimeZone) (CB);<a name="line.49"></a>
  58. <span class="sourceLineNo">050</span> * 09-Jun-2008 : Deprecated addToDate(Date) (DG);<a name="line.50"></a>
  59. <span class="sourceLineNo">051</span> * 09-Jan-2009 : Replaced the unit and rollUnit fields with an enumerated<a name="line.51"></a>
  60. <span class="sourceLineNo">052</span> * type (DG);<a name="line.52"></a>
  61. <span class="sourceLineNo">053</span> * 02-Jul-2013 : Use ParamChecks (DG);<a name="line.53"></a>
  62. <span class="sourceLineNo">054</span> *<a name="line.54"></a>
  63. <span class="sourceLineNo">055</span> */<a name="line.55"></a>
  64. <span class="sourceLineNo">056</span><a name="line.56"></a>
  65. <span class="sourceLineNo">057</span>package org.jfree.chart.axis;<a name="line.57"></a>
  66. <span class="sourceLineNo">058</span><a name="line.58"></a>
  67. <span class="sourceLineNo">059</span>import java.io.Serializable;<a name="line.59"></a>
  68. <span class="sourceLineNo">060</span>import java.text.DateFormat;<a name="line.60"></a>
  69. <span class="sourceLineNo">061</span>import java.util.Calendar;<a name="line.61"></a>
  70. <span class="sourceLineNo">062</span>import java.util.Date;<a name="line.62"></a>
  71. <span class="sourceLineNo">063</span>import java.util.TimeZone;<a name="line.63"></a>
  72. <span class="sourceLineNo">064</span>import org.jfree.chart.util.ParamChecks;<a name="line.64"></a>
  73. <span class="sourceLineNo">065</span><a name="line.65"></a>
  74. <span class="sourceLineNo">066</span>import org.jfree.util.ObjectUtilities;<a name="line.66"></a>
  75. <span class="sourceLineNo">067</span><a name="line.67"></a>
  76. <span class="sourceLineNo">068</span>/**<a name="line.68"></a>
  77. <span class="sourceLineNo">069</span> * A tick unit for use by subclasses of {@link DateAxis}. Instances of this<a name="line.69"></a>
  78. <span class="sourceLineNo">070</span> * class are immutable.<a name="line.70"></a>
  79. <span class="sourceLineNo">071</span> */<a name="line.71"></a>
  80. <span class="sourceLineNo">072</span>public class DateTickUnit extends TickUnit implements Serializable {<a name="line.72"></a>
  81. <span class="sourceLineNo">073</span><a name="line.73"></a>
  82. <span class="sourceLineNo">074</span> /** For serialization. */<a name="line.74"></a>
  83. <span class="sourceLineNo">075</span> private static final long serialVersionUID = -7289292157229621901L;<a name="line.75"></a>
  84. <span class="sourceLineNo">076</span><a name="line.76"></a>
  85. <span class="sourceLineNo">077</span> /**<a name="line.77"></a>
  86. <span class="sourceLineNo">078</span> * The units.<a name="line.78"></a>
  87. <span class="sourceLineNo">079</span> *<a name="line.79"></a>
  88. <span class="sourceLineNo">080</span> * @since 1.0.13<a name="line.80"></a>
  89. <span class="sourceLineNo">081</span> */<a name="line.81"></a>
  90. <span class="sourceLineNo">082</span> private DateTickUnitType unitType;<a name="line.82"></a>
  91. <span class="sourceLineNo">083</span><a name="line.83"></a>
  92. <span class="sourceLineNo">084</span> /** The unit count. */<a name="line.84"></a>
  93. <span class="sourceLineNo">085</span> private int count;<a name="line.85"></a>
  94. <span class="sourceLineNo">086</span><a name="line.86"></a>
  95. <span class="sourceLineNo">087</span> /**<a name="line.87"></a>
  96. <span class="sourceLineNo">088</span> * The roll unit type.<a name="line.88"></a>
  97. <span class="sourceLineNo">089</span> *<a name="line.89"></a>
  98. <span class="sourceLineNo">090</span> * @since 1.0.13<a name="line.90"></a>
  99. <span class="sourceLineNo">091</span> */<a name="line.91"></a>
  100. <span class="sourceLineNo">092</span> private DateTickUnitType rollUnitType;<a name="line.92"></a>
  101. <span class="sourceLineNo">093</span><a name="line.93"></a>
  102. <span class="sourceLineNo">094</span> /** The roll count. */<a name="line.94"></a>
  103. <span class="sourceLineNo">095</span> private int rollCount;<a name="line.95"></a>
  104. <span class="sourceLineNo">096</span><a name="line.96"></a>
  105. <span class="sourceLineNo">097</span> /** The date formatter. */<a name="line.97"></a>
  106. <span class="sourceLineNo">098</span> private DateFormat formatter;<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> * Creates a new date tick unit.<a name="line.101"></a>
  110. <span class="sourceLineNo">102</span> *<a name="line.102"></a>
  111. <span class="sourceLineNo">103</span> * @param unitType the unit type (&lt;code&gt;null&lt;/code&gt; not permitted).<a name="line.103"></a>
  112. <span class="sourceLineNo">104</span> * @param multiple the multiple (of the unit type, must be &amp;gt; 0).<a name="line.104"></a>
  113. <span class="sourceLineNo">105</span> *<a name="line.105"></a>
  114. <span class="sourceLineNo">106</span> * @since 1.0.13<a name="line.106"></a>
  115. <span class="sourceLineNo">107</span> */<a name="line.107"></a>
  116. <span class="sourceLineNo">108</span> public DateTickUnit(DateTickUnitType unitType, int multiple) {<a name="line.108"></a>
  117. <span class="sourceLineNo">109</span> this(unitType, multiple, DateFormat.getDateInstance(DateFormat.SHORT));<a name="line.109"></a>
  118. <span class="sourceLineNo">110</span> }<a name="line.110"></a>
  119. <span class="sourceLineNo">111</span><a name="line.111"></a>
  120. <span class="sourceLineNo">112</span> /**<a name="line.112"></a>
  121. <span class="sourceLineNo">113</span> * Creates a new date tick unit.<a name="line.113"></a>
  122. <span class="sourceLineNo">114</span> *<a name="line.114"></a>
  123. <span class="sourceLineNo">115</span> * @param unitType the unit type (&lt;code&gt;null&lt;/code&gt; not permitted).<a name="line.115"></a>
  124. <span class="sourceLineNo">116</span> * @param multiple the multiple (of the unit type, must be &amp;gt; 0).<a name="line.116"></a>
  125. <span class="sourceLineNo">117</span> * @param formatter the date formatter (&lt;code&gt;null&lt;/code&gt; not permitted).<a name="line.117"></a>
  126. <span class="sourceLineNo">118</span> *<a name="line.118"></a>
  127. <span class="sourceLineNo">119</span> * @since 1.0.13<a name="line.119"></a>
  128. <span class="sourceLineNo">120</span> */<a name="line.120"></a>
  129. <span class="sourceLineNo">121</span> public DateTickUnit(DateTickUnitType unitType, int multiple,<a name="line.121"></a>
  130. <span class="sourceLineNo">122</span> DateFormat formatter) {<a name="line.122"></a>
  131. <span class="sourceLineNo">123</span> this(unitType, multiple, unitType, multiple, formatter);<a name="line.123"></a>
  132. <span class="sourceLineNo">124</span> }<a name="line.124"></a>
  133. <span class="sourceLineNo">125</span><a name="line.125"></a>
  134. <span class="sourceLineNo">126</span> /**<a name="line.126"></a>
  135. <span class="sourceLineNo">127</span> * Creates a new unit.<a name="line.127"></a>
  136. <span class="sourceLineNo">128</span> *<a name="line.128"></a>
  137. <span class="sourceLineNo">129</span> * @param unitType the unit.<a name="line.129"></a>
  138. <span class="sourceLineNo">130</span> * @param multiple the multiple.<a name="line.130"></a>
  139. <span class="sourceLineNo">131</span> * @param rollUnitType the roll unit.<a name="line.131"></a>
  140. <span class="sourceLineNo">132</span> * @param rollMultiple the roll multiple.<a name="line.132"></a>
  141. <span class="sourceLineNo">133</span> * @param formatter the date formatter (&lt;code&gt;null&lt;/code&gt; not permitted).<a name="line.133"></a>
  142. <span class="sourceLineNo">134</span> *<a name="line.134"></a>
  143. <span class="sourceLineNo">135</span> * @since 1.0.13<a name="line.135"></a>
  144. <span class="sourceLineNo">136</span> */<a name="line.136"></a>
  145. <span class="sourceLineNo">137</span> public DateTickUnit(DateTickUnitType unitType, int multiple,<a name="line.137"></a>
  146. <span class="sourceLineNo">138</span> DateTickUnitType rollUnitType, int rollMultiple,<a name="line.138"></a>
  147. <span class="sourceLineNo">139</span> DateFormat formatter) {<a name="line.139"></a>
  148. <span class="sourceLineNo">140</span> super(DateTickUnit.getMillisecondCount(unitType, multiple));<a name="line.140"></a>
  149. <span class="sourceLineNo">141</span> ParamChecks.nullNotPermitted(formatter, "formatter");<a name="line.141"></a>
  150. <span class="sourceLineNo">142</span> if (multiple &lt;= 0) {<a name="line.142"></a>
  151. <span class="sourceLineNo">143</span> throw new IllegalArgumentException("Requires 'multiple' &gt; 0.");<a name="line.143"></a>
  152. <span class="sourceLineNo">144</span> }<a name="line.144"></a>
  153. <span class="sourceLineNo">145</span> if (rollMultiple &lt;= 0) {<a name="line.145"></a>
  154. <span class="sourceLineNo">146</span> throw new IllegalArgumentException("Requires 'rollMultiple' &gt; 0.");<a name="line.146"></a>
  155. <span class="sourceLineNo">147</span> }<a name="line.147"></a>
  156. <span class="sourceLineNo">148</span> this.unitType = unitType;<a name="line.148"></a>
  157. <span class="sourceLineNo">149</span> this.count = multiple;<a name="line.149"></a>
  158. <span class="sourceLineNo">150</span> this.rollUnitType = rollUnitType;<a name="line.150"></a>
  159. <span class="sourceLineNo">151</span> this.rollCount = rollMultiple;<a name="line.151"></a>
  160. <span class="sourceLineNo">152</span> this.formatter = formatter;<a name="line.152"></a>
  161. <span class="sourceLineNo">153</span><a name="line.153"></a>
  162. <span class="sourceLineNo">154</span> // populate deprecated fields<a name="line.154"></a>
  163. <span class="sourceLineNo">155</span> this.unit = unitTypeToInt(unitType);<a name="line.155"></a>
  164. <span class="sourceLineNo">156</span> this.rollUnit = unitTypeToInt(rollUnitType);<a name="line.156"></a>
  165. <span class="sourceLineNo">157</span> }<a name="line.157"></a>
  166. <span class="sourceLineNo">158</span><a name="line.158"></a>
  167. <span class="sourceLineNo">159</span> /**<a name="line.159"></a>
  168. <span class="sourceLineNo">160</span> * Returns the unit type.<a name="line.160"></a>
  169. <span class="sourceLineNo">161</span> *<a name="line.161"></a>
  170. <span class="sourceLineNo">162</span> * @return The unit type (never &lt;code&gt;null&lt;/code&gt;).<a name="line.162"></a>
  171. <span class="sourceLineNo">163</span> *<a name="line.163"></a>
  172. <span class="sourceLineNo">164</span> * @since 1.0.13<a name="line.164"></a>
  173. <span class="sourceLineNo">165</span> */<a name="line.165"></a>
  174. <span class="sourceLineNo">166</span> public DateTickUnitType getUnitType() {<a name="line.166"></a>
  175. <span class="sourceLineNo">167</span> return this.unitType;<a name="line.167"></a>
  176. <span class="sourceLineNo">168</span> }<a name="line.168"></a>
  177. <span class="sourceLineNo">169</span><a name="line.169"></a>
  178. <span class="sourceLineNo">170</span> /**<a name="line.170"></a>
  179. <span class="sourceLineNo">171</span> * Returns the unit multiple.<a name="line.171"></a>
  180. <span class="sourceLineNo">172</span> *<a name="line.172"></a>
  181. <span class="sourceLineNo">173</span> * @return The unit multiple (always &amp;gt; 0).<a name="line.173"></a>
  182. <span class="sourceLineNo">174</span> */<a name="line.174"></a>
  183. <span class="sourceLineNo">175</span> public int getMultiple() {<a name="line.175"></a>
  184. <span class="sourceLineNo">176</span> return this.count;<a name="line.176"></a>
  185. <span class="sourceLineNo">177</span> }<a name="line.177"></a>
  186. <span class="sourceLineNo">178</span><a name="line.178"></a>
  187. <span class="sourceLineNo">179</span> /**<a name="line.179"></a>
  188. <span class="sourceLineNo">180</span> * Returns the roll unit type.<a name="line.180"></a>
  189. <span class="sourceLineNo">181</span> *<a name="line.181"></a>
  190. <span class="sourceLineNo">182</span> * @return The roll unit type (never &lt;code&gt;null&lt;/code&gt;).<a name="line.182"></a>
  191. <span class="sourceLineNo">183</span> *<a name="line.183"></a>
  192. <span class="sourceLineNo">184</span> * @since 1.0.13<a name="line.184"></a>
  193. <span class="sourceLineNo">185</span> */<a name="line.185"></a>
  194. <span class="sourceLineNo">186</span> public DateTickUnitType getRollUnitType() {<a name="line.186"></a>
  195. <span class="sourceLineNo">187</span> return this.rollUnitType;<a name="line.187"></a>
  196. <span class="sourceLineNo">188</span> }<a name="line.188"></a>
  197. <span class="sourceLineNo">189</span><a name="line.189"></a>
  198. <span class="sourceLineNo">190</span> /**<a name="line.190"></a>
  199. <span class="sourceLineNo">191</span> * Returns the roll unit multiple.<a name="line.191"></a>
  200. <span class="sourceLineNo">192</span> *<a name="line.192"></a>
  201. <span class="sourceLineNo">193</span> * @return The roll unit multiple.<a name="line.193"></a>
  202. <span class="sourceLineNo">194</span> *<a name="line.194"></a>
  203. <span class="sourceLineNo">195</span> * @since 1.0.13<a name="line.195"></a>
  204. <span class="sourceLineNo">196</span> */<a name="line.196"></a>
  205. <span class="sourceLineNo">197</span> public int getRollMultiple() {<a name="line.197"></a>
  206. <span class="sourceLineNo">198</span> return this.rollCount;<a name="line.198"></a>
  207. <span class="sourceLineNo">199</span> }<a name="line.199"></a>
  208. <span class="sourceLineNo">200</span><a name="line.200"></a>
  209. <span class="sourceLineNo">201</span> /**<a name="line.201"></a>
  210. <span class="sourceLineNo">202</span> * Formats a value.<a name="line.202"></a>
  211. <span class="sourceLineNo">203</span> *<a name="line.203"></a>
  212. <span class="sourceLineNo">204</span> * @param milliseconds date in milliseconds since 01-01-1970.<a name="line.204"></a>
  213. <span class="sourceLineNo">205</span> *<a name="line.205"></a>
  214. <span class="sourceLineNo">206</span> * @return The formatted date.<a name="line.206"></a>
  215. <span class="sourceLineNo">207</span> */<a name="line.207"></a>
  216. <span class="sourceLineNo">208</span> @Override<a name="line.208"></a>
  217. <span class="sourceLineNo">209</span> public String valueToString(double milliseconds) {<a name="line.209"></a>
  218. <span class="sourceLineNo">210</span> return this.formatter.format(new Date((long) milliseconds));<a name="line.210"></a>
  219. <span class="sourceLineNo">211</span> }<a name="line.211"></a>
  220. <span class="sourceLineNo">212</span><a name="line.212"></a>
  221. <span class="sourceLineNo">213</span> /**<a name="line.213"></a>
  222. <span class="sourceLineNo">214</span> * Formats a date using the tick unit's formatter.<a name="line.214"></a>
  223. <span class="sourceLineNo">215</span> *<a name="line.215"></a>
  224. <span class="sourceLineNo">216</span> * @param date the date.<a name="line.216"></a>
  225. <span class="sourceLineNo">217</span> *<a name="line.217"></a>
  226. <span class="sourceLineNo">218</span> * @return The formatted date.<a name="line.218"></a>
  227. <span class="sourceLineNo">219</span> */<a name="line.219"></a>
  228. <span class="sourceLineNo">220</span> public String dateToString(Date date) {<a name="line.220"></a>
  229. <span class="sourceLineNo">221</span> return this.formatter.format(date);<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> * Calculates a new date by adding this unit to the base date.<a name="line.225"></a>
  234. <span class="sourceLineNo">226</span> *<a name="line.226"></a>
  235. <span class="sourceLineNo">227</span> * @param base the base date.<a name="line.227"></a>
  236. <span class="sourceLineNo">228</span> * @param zone the time zone for the date calculation.<a name="line.228"></a>
  237. <span class="sourceLineNo">229</span> *<a name="line.229"></a>
  238. <span class="sourceLineNo">230</span> * @return A new date one unit after the base date.<a name="line.230"></a>
  239. <span class="sourceLineNo">231</span> *<a name="line.231"></a>
  240. <span class="sourceLineNo">232</span> * @since 1.0.6<a name="line.232"></a>
  241. <span class="sourceLineNo">233</span> */<a name="line.233"></a>
  242. <span class="sourceLineNo">234</span> public Date addToDate(Date base, TimeZone zone) {<a name="line.234"></a>
  243. <span class="sourceLineNo">235</span> // as far as I know, the Locale for the calendar only affects week<a name="line.235"></a>
  244. <span class="sourceLineNo">236</span> // number calculations, and since DateTickUnit doesn't do week<a name="line.236"></a>
  245. <span class="sourceLineNo">237</span> // arithmetic, the default locale (whatever it is) should be fine<a name="line.237"></a>
  246. <span class="sourceLineNo">238</span> // here...<a name="line.238"></a>
  247. <span class="sourceLineNo">239</span> Calendar calendar = Calendar.getInstance(zone);<a name="line.239"></a>
  248. <span class="sourceLineNo">240</span> calendar.setTime(base);<a name="line.240"></a>
  249. <span class="sourceLineNo">241</span> calendar.add(this.unitType.getCalendarField(), this.count);<a name="line.241"></a>
  250. <span class="sourceLineNo">242</span> return calendar.getTime();<a name="line.242"></a>
  251. <span class="sourceLineNo">243</span> }<a name="line.243"></a>
  252. <span class="sourceLineNo">244</span><a name="line.244"></a>
  253. <span class="sourceLineNo">245</span> /**<a name="line.245"></a>
  254. <span class="sourceLineNo">246</span> * Rolls the date forward by the amount specified by the roll unit and<a name="line.246"></a>
  255. <span class="sourceLineNo">247</span> * count.<a name="line.247"></a>
  256. <span class="sourceLineNo">248</span> *<a name="line.248"></a>
  257. <span class="sourceLineNo">249</span> * @param base the base date.<a name="line.249"></a>
  258. <span class="sourceLineNo">250</span><a name="line.250"></a>
  259. <span class="sourceLineNo">251</span> * @return The rolled date.<a name="line.251"></a>
  260. <span class="sourceLineNo">252</span> *<a name="line.252"></a>
  261. <span class="sourceLineNo">253</span> * @see #rollDate(Date, TimeZone)<a name="line.253"></a>
  262. <span class="sourceLineNo">254</span> */<a name="line.254"></a>
  263. <span class="sourceLineNo">255</span> public Date rollDate(Date base) {<a name="line.255"></a>
  264. <span class="sourceLineNo">256</span> return rollDate(base, TimeZone.getDefault());<a name="line.256"></a>
  265. <span class="sourceLineNo">257</span> }<a name="line.257"></a>
  266. <span class="sourceLineNo">258</span><a name="line.258"></a>
  267. <span class="sourceLineNo">259</span> /**<a name="line.259"></a>
  268. <span class="sourceLineNo">260</span> * Rolls the date forward by the amount specified by the roll unit and<a name="line.260"></a>
  269. <span class="sourceLineNo">261</span> * count.<a name="line.261"></a>
  270. <span class="sourceLineNo">262</span> *<a name="line.262"></a>
  271. <span class="sourceLineNo">263</span> * @param base the base date.<a name="line.263"></a>
  272. <span class="sourceLineNo">264</span> * @param zone the time zone.<a name="line.264"></a>
  273. <span class="sourceLineNo">265</span> *<a name="line.265"></a>
  274. <span class="sourceLineNo">266</span> * @return The rolled date.<a name="line.266"></a>
  275. <span class="sourceLineNo">267</span> *<a name="line.267"></a>
  276. <span class="sourceLineNo">268</span> * @since 1.0.6<a name="line.268"></a>
  277. <span class="sourceLineNo">269</span> */<a name="line.269"></a>
  278. <span class="sourceLineNo">270</span> public Date rollDate(Date base, TimeZone zone) {<a name="line.270"></a>
  279. <span class="sourceLineNo">271</span> // as far as I know, the Locale for the calendar only affects week<a name="line.271"></a>
  280. <span class="sourceLineNo">272</span> // number calculations, and since DateTickUnit doesn't do week<a name="line.272"></a>
  281. <span class="sourceLineNo">273</span> // arithmetic, the default locale (whatever it is) should be fine<a name="line.273"></a>
  282. <span class="sourceLineNo">274</span> // here...<a name="line.274"></a>
  283. <span class="sourceLineNo">275</span> Calendar calendar = Calendar.getInstance(zone);<a name="line.275"></a>
  284. <span class="sourceLineNo">276</span> calendar.setTime(base);<a name="line.276"></a>
  285. <span class="sourceLineNo">277</span> calendar.add(this.rollUnitType.getCalendarField(), this.rollCount);<a name="line.277"></a>
  286. <span class="sourceLineNo">278</span> return calendar.getTime();<a name="line.278"></a>
  287. <span class="sourceLineNo">279</span> }<a name="line.279"></a>
  288. <span class="sourceLineNo">280</span><a name="line.280"></a>
  289. <span class="sourceLineNo">281</span> /**<a name="line.281"></a>
  290. <span class="sourceLineNo">282</span> * Returns a field code that can be used with the &lt;code&gt;Calendar&lt;/code&gt;<a name="line.282"></a>
  291. <span class="sourceLineNo">283</span> * class.<a name="line.283"></a>
  292. <span class="sourceLineNo">284</span> *<a name="line.284"></a>
  293. <span class="sourceLineNo">285</span> * @return The field code.<a name="line.285"></a>
  294. <span class="sourceLineNo">286</span> */<a name="line.286"></a>
  295. <span class="sourceLineNo">287</span> public int getCalendarField() {<a name="line.287"></a>
  296. <span class="sourceLineNo">288</span> return this.unitType.getCalendarField();<a name="line.288"></a>
  297. <span class="sourceLineNo">289</span> }<a name="line.289"></a>
  298. <span class="sourceLineNo">290</span><a name="line.290"></a>
  299. <span class="sourceLineNo">291</span> /**<a name="line.291"></a>
  300. <span class="sourceLineNo">292</span> * Returns the (approximate) number of milliseconds for the given unit and<a name="line.292"></a>
  301. <span class="sourceLineNo">293</span> * unit count.<a name="line.293"></a>
  302. <span class="sourceLineNo">294</span> * &lt;P&gt;<a name="line.294"></a>
  303. <span class="sourceLineNo">295</span> * This value is an approximation some of the time (e.g. months are<a name="line.295"></a>
  304. <span class="sourceLineNo">296</span> * assumed to have 31 days) but this shouldn't matter.<a name="line.296"></a>
  305. <span class="sourceLineNo">297</span> *<a name="line.297"></a>
  306. <span class="sourceLineNo">298</span> * @param unit the unit.<a name="line.298"></a>
  307. <span class="sourceLineNo">299</span> * @param count the unit count.<a name="line.299"></a>
  308. <span class="sourceLineNo">300</span> *<a name="line.300"></a>
  309. <span class="sourceLineNo">301</span> * @return The number of milliseconds.<a name="line.301"></a>
  310. <span class="sourceLineNo">302</span> *<a name="line.302"></a>
  311. <span class="sourceLineNo">303</span> * @since 1.0.13<a name="line.303"></a>
  312. <span class="sourceLineNo">304</span> */<a name="line.304"></a>
  313. <span class="sourceLineNo">305</span> private static long getMillisecondCount(DateTickUnitType unit, int count) {<a name="line.305"></a>
  314. <span class="sourceLineNo">306</span><a name="line.306"></a>
  315. <span class="sourceLineNo">307</span> if (unit.equals(DateTickUnitType.YEAR)) {<a name="line.307"></a>
  316. <span class="sourceLineNo">308</span> return (365L * 24L * 60L * 60L * 1000L) * count;<a name="line.308"></a>
  317. <span class="sourceLineNo">309</span> }<a name="line.309"></a>
  318. <span class="sourceLineNo">310</span> else if (unit.equals(DateTickUnitType.MONTH)) {<a name="line.310"></a>
  319. <span class="sourceLineNo">311</span> return (31L * 24L * 60L * 60L * 1000L) * count;<a name="line.311"></a>
  320. <span class="sourceLineNo">312</span> }<a name="line.312"></a>
  321. <span class="sourceLineNo">313</span> else if (unit.equals(DateTickUnitType.DAY)) {<a name="line.313"></a>
  322. <span class="sourceLineNo">314</span> return (24L * 60L * 60L * 1000L) * count;<a name="line.314"></a>
  323. <span class="sourceLineNo">315</span> }<a name="line.315"></a>
  324. <span class="sourceLineNo">316</span> else if (unit.equals(DateTickUnitType.HOUR)) {<a name="line.316"></a>
  325. <span class="sourceLineNo">317</span> return (60L * 60L * 1000L) * count;<a name="line.317"></a>
  326. <span class="sourceLineNo">318</span> }<a name="line.318"></a>
  327. <span class="sourceLineNo">319</span> else if (unit.equals(DateTickUnitType.MINUTE)) {<a name="line.319"></a>
  328. <span class="sourceLineNo">320</span> return (60L * 1000L) * count;<a name="line.320"></a>
  329. <span class="sourceLineNo">321</span> }<a name="line.321"></a>
  330. <span class="sourceLineNo">322</span> else if (unit.equals(DateTickUnitType.SECOND)) {<a name="line.322"></a>
  331. <span class="sourceLineNo">323</span> return 1000L * count;<a name="line.323"></a>
  332. <span class="sourceLineNo">324</span> }<a name="line.324"></a>
  333. <span class="sourceLineNo">325</span> else if (unit.equals(DateTickUnitType.MILLISECOND)) {<a name="line.325"></a>
  334. <span class="sourceLineNo">326</span> return count;<a name="line.326"></a>
  335. <span class="sourceLineNo">327</span> }<a name="line.327"></a>
  336. <span class="sourceLineNo">328</span> else {<a name="line.328"></a>
  337. <span class="sourceLineNo">329</span> throw new IllegalArgumentException("The 'unit' argument has a " <a name="line.329"></a>
  338. <span class="sourceLineNo">330</span> + "value that is not recognised.");<a name="line.330"></a>
  339. <span class="sourceLineNo">331</span> }<a name="line.331"></a>
  340. <span class="sourceLineNo">332</span><a name="line.332"></a>
  341. <span class="sourceLineNo">333</span> }<a name="line.333"></a>
  342. <span class="sourceLineNo">334</span><a name="line.334"></a>
  343. <span class="sourceLineNo">335</span> /**<a name="line.335"></a>
  344. <span class="sourceLineNo">336</span> * A utility method that is used internally to convert the old unit<a name="line.336"></a>
  345. <span class="sourceLineNo">337</span> * constants into the corresponding enumerated value.<a name="line.337"></a>
  346. <span class="sourceLineNo">338</span> *<a name="line.338"></a>
  347. <span class="sourceLineNo">339</span> * @param unit the unit specified using the deprecated integer codes.<a name="line.339"></a>
  348. <span class="sourceLineNo">340</span> *<a name="line.340"></a>
  349. <span class="sourceLineNo">341</span> * @return The unit type.<a name="line.341"></a>
  350. <span class="sourceLineNo">342</span> *<a name="line.342"></a>
  351. <span class="sourceLineNo">343</span> * @since 1.0.13<a name="line.343"></a>
  352. <span class="sourceLineNo">344</span> */<a name="line.344"></a>
  353. <span class="sourceLineNo">345</span> private static DateTickUnitType intToUnitType(int unit) {<a name="line.345"></a>
  354. <span class="sourceLineNo">346</span> switch (unit) {<a name="line.346"></a>
  355. <span class="sourceLineNo">347</span> case YEAR: return DateTickUnitType.YEAR;<a name="line.347"></a>
  356. <span class="sourceLineNo">348</span> case MONTH: return DateTickUnitType.MONTH;<a name="line.348"></a>
  357. <span class="sourceLineNo">349</span> case DAY: return DateTickUnitType.DAY;<a name="line.349"></a>
  358. <span class="sourceLineNo">350</span> case HOUR: return DateTickUnitType.HOUR;<a name="line.350"></a>
  359. <span class="sourceLineNo">351</span> case MINUTE: return DateTickUnitType.MINUTE;<a name="line.351"></a>
  360. <span class="sourceLineNo">352</span> case SECOND: return DateTickUnitType.SECOND;<a name="line.352"></a>
  361. <span class="sourceLineNo">353</span> case MILLISECOND: return DateTickUnitType.MILLISECOND;<a name="line.353"></a>
  362. <span class="sourceLineNo">354</span> default: throw new IllegalArgumentException(<a name="line.354"></a>
  363. <span class="sourceLineNo">355</span> "Unrecognised 'unit' value " + unit + ".");<a name="line.355"></a>
  364. <span class="sourceLineNo">356</span> }<a name="line.356"></a>
  365. <span class="sourceLineNo">357</span> }<a name="line.357"></a>
  366. <span class="sourceLineNo">358</span><a name="line.358"></a>
  367. <span class="sourceLineNo">359</span> /**<a name="line.359"></a>
  368. <span class="sourceLineNo">360</span> * Converts a unit type to the corresponding deprecated integer constant.<a name="line.360"></a>
  369. <span class="sourceLineNo">361</span> *<a name="line.361"></a>
  370. <span class="sourceLineNo">362</span> * @param unitType the unit type (&lt;code&gt;null&lt;/code&gt; not permitted).<a name="line.362"></a>
  371. <span class="sourceLineNo">363</span> *<a name="line.363"></a>
  372. <span class="sourceLineNo">364</span> * @return The int code.<a name="line.364"></a>
  373. <span class="sourceLineNo">365</span> *<a name="line.365"></a>
  374. <span class="sourceLineNo">366</span> * @since 1.0.13<a name="line.366"></a>
  375. <span class="sourceLineNo">367</span> */<a name="line.367"></a>
  376. <span class="sourceLineNo">368</span> private static int unitTypeToInt(DateTickUnitType unitType) {<a name="line.368"></a>
  377. <span class="sourceLineNo">369</span> ParamChecks.nullNotPermitted(unitType, "unitType");<a name="line.369"></a>
  378. <span class="sourceLineNo">370</span> if (unitType.equals(DateTickUnitType.YEAR)) {<a name="line.370"></a>
  379. <span class="sourceLineNo">371</span> return YEAR;<a name="line.371"></a>
  380. <span class="sourceLineNo">372</span> }<a name="line.372"></a>
  381. <span class="sourceLineNo">373</span> else if (unitType.equals(DateTickUnitType.MONTH)) {<a name="line.373"></a>
  382. <span class="sourceLineNo">374</span> return MONTH;<a name="line.374"></a>
  383. <span class="sourceLineNo">375</span> }<a name="line.375"></a>
  384. <span class="sourceLineNo">376</span> else if (unitType.equals(DateTickUnitType.DAY)) {<a name="line.376"></a>
  385. <span class="sourceLineNo">377</span> return DAY;<a name="line.377"></a>
  386. <span class="sourceLineNo">378</span> }<a name="line.378"></a>
  387. <span class="sourceLineNo">379</span> else if (unitType.equals(DateTickUnitType.HOUR)) {<a name="line.379"></a>
  388. <span class="sourceLineNo">380</span> return HOUR;<a name="line.380"></a>
  389. <span class="sourceLineNo">381</span> }<a name="line.381"></a>
  390. <span class="sourceLineNo">382</span> else if (unitType.equals(DateTickUnitType.MINUTE)) {<a name="line.382"></a>
  391. <span class="sourceLineNo">383</span> return MINUTE;<a name="line.383"></a>
  392. <span class="sourceLineNo">384</span> }<a name="line.384"></a>
  393. <span class="sourceLineNo">385</span> else if (unitType.equals(DateTickUnitType.SECOND)) {<a name="line.385"></a>
  394. <span class="sourceLineNo">386</span> return SECOND;<a name="line.386"></a>
  395. <span class="sourceLineNo">387</span> }<a name="line.387"></a>
  396. <span class="sourceLineNo">388</span> else if (unitType.equals(DateTickUnitType.MILLISECOND)) {<a name="line.388"></a>
  397. <span class="sourceLineNo">389</span> return MILLISECOND;<a name="line.389"></a>
  398. <span class="sourceLineNo">390</span> }<a name="line.390"></a>
  399. <span class="sourceLineNo">391</span> else {<a name="line.391"></a>
  400. <span class="sourceLineNo">392</span> throw new IllegalArgumentException(<a name="line.392"></a>
  401. <span class="sourceLineNo">393</span> "The 'unitType' is not recognised");<a name="line.393"></a>
  402. <span class="sourceLineNo">394</span> }<a name="line.394"></a>
  403. <span class="sourceLineNo">395</span> }<a name="line.395"></a>
  404. <span class="sourceLineNo">396</span><a name="line.396"></a>
  405. <span class="sourceLineNo">397</span> /**<a name="line.397"></a>
  406. <span class="sourceLineNo">398</span> * A utility method to put a default in place if a null formatter is<a name="line.398"></a>
  407. <span class="sourceLineNo">399</span> * supplied.<a name="line.399"></a>
  408. <span class="sourceLineNo">400</span> *<a name="line.400"></a>
  409. <span class="sourceLineNo">401</span> * @param formatter the formatter (&lt;code&gt;null&lt;/code&gt; permitted).<a name="line.401"></a>
  410. <span class="sourceLineNo">402</span> *<a name="line.402"></a>
  411. <span class="sourceLineNo">403</span> * @return The formatter if it is not null, otherwise a default.<a name="line.403"></a>
  412. <span class="sourceLineNo">404</span> */<a name="line.404"></a>
  413. <span class="sourceLineNo">405</span> private static DateFormat notNull(DateFormat formatter) {<a name="line.405"></a>
  414. <span class="sourceLineNo">406</span> if (formatter == null) {<a name="line.406"></a>
  415. <span class="sourceLineNo">407</span> return DateFormat.getDateInstance(DateFormat.SHORT);<a name="line.407"></a>
  416. <span class="sourceLineNo">408</span> }<a name="line.408"></a>
  417. <span class="sourceLineNo">409</span> else {<a name="line.409"></a>
  418. <span class="sourceLineNo">410</span> return formatter;<a name="line.410"></a>
  419. <span class="sourceLineNo">411</span> }<a name="line.411"></a>
  420. <span class="sourceLineNo">412</span> }<a name="line.412"></a>
  421. <span class="sourceLineNo">413</span><a name="line.413"></a>
  422. <span class="sourceLineNo">414</span> /**<a name="line.414"></a>
  423. <span class="sourceLineNo">415</span> * Tests this unit for equality with another object.<a name="line.415"></a>
  424. <span class="sourceLineNo">416</span> *<a name="line.416"></a>
  425. <span class="sourceLineNo">417</span> * @param obj the object (&lt;code&gt;null&lt;/code&gt; permitted).<a name="line.417"></a>
  426. <span class="sourceLineNo">418</span> *<a name="line.418"></a>
  427. <span class="sourceLineNo">419</span> * @return &lt;code&gt;true&lt;/code&gt; or &lt;code&gt;false&lt;/code&gt;.<a name="line.419"></a>
  428. <span class="sourceLineNo">420</span> */<a name="line.420"></a>
  429. <span class="sourceLineNo">421</span> @Override<a name="line.421"></a>
  430. <span class="sourceLineNo">422</span> public boolean equals(Object obj) {<a name="line.422"></a>
  431. <span class="sourceLineNo">423</span> if (obj == this) {<a name="line.423"></a>
  432. <span class="sourceLineNo">424</span> return true;<a name="line.424"></a>
  433. <span class="sourceLineNo">425</span> }<a name="line.425"></a>
  434. <span class="sourceLineNo">426</span> if (!(obj instanceof DateTickUnit)) {<a name="line.426"></a>
  435. <span class="sourceLineNo">427</span> return false;<a name="line.427"></a>
  436. <span class="sourceLineNo">428</span> }<a name="line.428"></a>
  437. <span class="sourceLineNo">429</span> if (!super.equals(obj)) {<a name="line.429"></a>
  438. <span class="sourceLineNo">430</span> return false;<a name="line.430"></a>
  439. <span class="sourceLineNo">431</span> }<a name="line.431"></a>
  440. <span class="sourceLineNo">432</span> DateTickUnit that = (DateTickUnit) obj;<a name="line.432"></a>
  441. <span class="sourceLineNo">433</span> if (!(this.unitType.equals(that.unitType))) {<a name="line.433"></a>
  442. <span class="sourceLineNo">434</span> return false;<a name="line.434"></a>
  443. <span class="sourceLineNo">435</span> }<a name="line.435"></a>
  444. <span class="sourceLineNo">436</span> if (this.count != that.count) {<a name="line.436"></a>
  445. <span class="sourceLineNo">437</span> return false;<a name="line.437"></a>
  446. <span class="sourceLineNo">438</span> }<a name="line.438"></a>
  447. <span class="sourceLineNo">439</span> if (!ObjectUtilities.equal(this.formatter, that.formatter)) {<a name="line.439"></a>
  448. <span class="sourceLineNo">440</span> return false;<a name="line.440"></a>
  449. <span class="sourceLineNo">441</span> }<a name="line.441"></a>
  450. <span class="sourceLineNo">442</span> return true;<a name="line.442"></a>
  451. <span class="sourceLineNo">443</span> }<a name="line.443"></a>
  452. <span class="sourceLineNo">444</span><a name="line.444"></a>
  453. <span class="sourceLineNo">445</span> /**<a name="line.445"></a>
  454. <span class="sourceLineNo">446</span> * Returns a hash code for this object.<a name="line.446"></a>
  455. <span class="sourceLineNo">447</span> *<a name="line.447"></a>
  456. <span class="sourceLineNo">448</span> * @return A hash code.<a name="line.448"></a>
  457. <span class="sourceLineNo">449</span> */<a name="line.449"></a>
  458. <span class="sourceLineNo">450</span> @Override<a name="line.450"></a>
  459. <span class="sourceLineNo">451</span> public int hashCode() {<a name="line.451"></a>
  460. <span class="sourceLineNo">452</span> int result = 19;<a name="line.452"></a>
  461. <span class="sourceLineNo">453</span> result = 37 * result + this.unitType.hashCode();<a name="line.453"></a>
  462. <span class="sourceLineNo">454</span> result = 37 * result + this.count;<a name="line.454"></a>
  463. <span class="sourceLineNo">455</span> result = 37 * result + this.formatter.hashCode();<a name="line.455"></a>
  464. <span class="sourceLineNo">456</span> return result;<a name="line.456"></a>
  465. <span class="sourceLineNo">457</span> }<a name="line.457"></a>
  466. <span class="sourceLineNo">458</span><a name="line.458"></a>
  467. <span class="sourceLineNo">459</span> /**<a name="line.459"></a>
  468. <span class="sourceLineNo">460</span> * Returns a string representation of this instance, primarily used for<a name="line.460"></a>
  469. <span class="sourceLineNo">461</span> * debugging purposes.<a name="line.461"></a>
  470. <span class="sourceLineNo">462</span> *<a name="line.462"></a>
  471. <span class="sourceLineNo">463</span> * @return A string representation of this instance.<a name="line.463"></a>
  472. <span class="sourceLineNo">464</span> */<a name="line.464"></a>
  473. <span class="sourceLineNo">465</span> @Override<a name="line.465"></a>
  474. <span class="sourceLineNo">466</span> public String toString() {<a name="line.466"></a>
  475. <span class="sourceLineNo">467</span> return "DateTickUnit[" + this.unitType.toString() + ", "<a name="line.467"></a>
  476. <span class="sourceLineNo">468</span> + this.count + "]";<a name="line.468"></a>
  477. <span class="sourceLineNo">469</span> }<a name="line.469"></a>
  478. <span class="sourceLineNo">470</span><a name="line.470"></a>
  479. <span class="sourceLineNo">471</span> /**<a name="line.471"></a>
  480. <span class="sourceLineNo">472</span> * A constant for years.<a name="line.472"></a>
  481. <span class="sourceLineNo">473</span> *<a name="line.473"></a>
  482. <span class="sourceLineNo">474</span> * @deprecated As of version 1.0.13, use {@link DateTickUnitType} instead.<a name="line.474"></a>
  483. <span class="sourceLineNo">475</span> */<a name="line.475"></a>
  484. <span class="sourceLineNo">476</span> public static final int YEAR = 0;<a name="line.476"></a>
  485. <span class="sourceLineNo">477</span><a name="line.477"></a>
  486. <span class="sourceLineNo">478</span> /**<a name="line.478"></a>
  487. <span class="sourceLineNo">479</span> * A constant for months.<a name="line.479"></a>
  488. <span class="sourceLineNo">480</span> *<a name="line.480"></a>
  489. <span class="sourceLineNo">481</span> * @deprecated As of version 1.0.13, use {@link DateTickUnitType} instead.<a name="line.481"></a>
  490. <span class="sourceLineNo">482</span> */<a name="line.482"></a>
  491. <span class="sourceLineNo">483</span> public static final int MONTH = 1;<a name="line.483"></a>
  492. <span class="sourceLineNo">484</span><a name="line.484"></a>
  493. <span class="sourceLineNo">485</span> /**<a name="line.485"></a>
  494. <span class="sourceLineNo">486</span> * A constant for days.<a name="line.486"></a>
  495. <span class="sourceLineNo">487</span> *<a name="line.487"></a>
  496. <span class="sourceLineNo">488</span> * @deprecated As of version 1.0.13, use {@link DateTickUnitType} instead.<a name="line.488"></a>
  497. <span class="sourceLineNo">489</span> */<a name="line.489"></a>
  498. <span class="sourceLineNo">490</span> public static final int DAY = 2;<a name="line.490"></a>
  499. <span class="sourceLineNo">491</span><a name="line.491"></a>
  500. <span class="sourceLineNo">492</span> /**<a name="line.492"></a>
  501. <span class="sourceLineNo">493</span> * A constant for hours.<a name="line.493"></a>
  502. <span class="sourceLineNo">494</span> *<a name="line.494"></a>
  503. <span class="sourceLineNo">495</span> * @deprecated As of version 1.0.13, use {@link DateTickUnitType} instead.<a name="line.495"></a>
  504. <span class="sourceLineNo">496</span> */<a name="line.496"></a>
  505. <span class="sourceLineNo">497</span> public static final int HOUR = 3;<a name="line.497"></a>
  506. <span class="sourceLineNo">498</span><a name="line.498"></a>
  507. <span class="sourceLineNo">499</span> /**<a name="line.499"></a>
  508. <span class="sourceLineNo">500</span> * A constant for minutes.<a name="line.500"></a>
  509. <span class="sourceLineNo">501</span> *<a name="line.501"></a>
  510. <span class="sourceLineNo">502</span> * @deprecated As of version 1.0.13, use {@link DateTickUnitType} instead.<a name="line.502"></a>
  511. <span class="sourceLineNo">503</span> */<a name="line.503"></a>
  512. <span class="sourceLineNo">504</span> public static final int MINUTE = 4;<a name="line.504"></a>
  513. <span class="sourceLineNo">505</span><a name="line.505"></a>
  514. <span class="sourceLineNo">506</span> /**<a name="line.506"></a>
  515. <span class="sourceLineNo">507</span> * A constant for seconds.<a name="line.507"></a>
  516. <span class="sourceLineNo">508</span> *<a name="line.508"></a>
  517. <span class="sourceLineNo">509</span> * @deprecated As of version 1.0.13, use {@link DateTickUnitType} instead.<a name="line.509"></a>
  518. <span class="sourceLineNo">510</span> */<a name="line.510"></a>
  519. <span class="sourceLineNo">511</span> public static final int SECOND = 5;<a name="line.511"></a>
  520. <span class="sourceLineNo">512</span><a name="line.512"></a>
  521. <span class="sourceLineNo">513</span> /**<a name="line.513"></a>
  522. <span class="sourceLineNo">514</span> * A constant for milliseconds.<a name="line.514"></a>
  523. <span class="sourceLineNo">515</span> *<a name="line.515"></a>
  524. <span class="sourceLineNo">516</span> * @deprecated As of version 1.0.13, use {@link DateTickUnitType} instead.<a name="line.516"></a>
  525. <span class="sourceLineNo">517</span> */<a name="line.517"></a>
  526. <span class="sourceLineNo">518</span> public static final int MILLISECOND = 6;<a name="line.518"></a>
  527. <span class="sourceLineNo">519</span><a name="line.519"></a>
  528. <span class="sourceLineNo">520</span> /**<a name="line.520"></a>
  529. <span class="sourceLineNo">521</span> * The unit.<a name="line.521"></a>
  530. <span class="sourceLineNo">522</span> *<a name="line.522"></a>
  531. <span class="sourceLineNo">523</span> * @deprecated As of version 1.0.13, use the unitType field.<a name="line.523"></a>
  532. <span class="sourceLineNo">524</span> */<a name="line.524"></a>
  533. <span class="sourceLineNo">525</span> private int unit;<a name="line.525"></a>
  534. <span class="sourceLineNo">526</span><a name="line.526"></a>
  535. <span class="sourceLineNo">527</span> /**<a name="line.527"></a>
  536. <span class="sourceLineNo">528</span> * The roll unit.<a name="line.528"></a>
  537. <span class="sourceLineNo">529</span> *<a name="line.529"></a>
  538. <span class="sourceLineNo">530</span> * @deprecated As of version 1.0.13, use the rollUnitType field.<a name="line.530"></a>
  539. <span class="sourceLineNo">531</span> */<a name="line.531"></a>
  540. <span class="sourceLineNo">532</span> private int rollUnit;<a name="line.532"></a>
  541. <span class="sourceLineNo">533</span><a name="line.533"></a>
  542. <span class="sourceLineNo">534</span> /**<a name="line.534"></a>
  543. <span class="sourceLineNo">535</span> * Creates a new date tick unit. You can specify the units using one of<a name="line.535"></a>
  544. <span class="sourceLineNo">536</span> * the constants YEAR, MONTH, DAY, HOUR, MINUTE, SECOND or MILLISECOND.<a name="line.536"></a>
  545. <span class="sourceLineNo">537</span> * In addition, you can specify a unit count, and a date format.<a name="line.537"></a>
  546. <span class="sourceLineNo">538</span> *<a name="line.538"></a>
  547. <span class="sourceLineNo">539</span> * @param unit the unit.<a name="line.539"></a>
  548. <span class="sourceLineNo">540</span> * @param count the unit count.<a name="line.540"></a>
  549. <span class="sourceLineNo">541</span> * @param formatter the date formatter (defaults to DateFormat.SHORT).<a name="line.541"></a>
  550. <span class="sourceLineNo">542</span> *<a name="line.542"></a>
  551. <span class="sourceLineNo">543</span> * @deprecated As of version 1.0.13, use {@link #DateTickUnit(<a name="line.543"></a>
  552. <span class="sourceLineNo">544</span> * DateTickUnitType, int, DateFormat)}.<a name="line.544"></a>
  553. <span class="sourceLineNo">545</span> */<a name="line.545"></a>
  554. <span class="sourceLineNo">546</span> public DateTickUnit(int unit, int count, DateFormat formatter) {<a name="line.546"></a>
  555. <span class="sourceLineNo">547</span> this(unit, count, unit, count, formatter);<a name="line.547"></a>
  556. <span class="sourceLineNo">548</span> }<a name="line.548"></a>
  557. <span class="sourceLineNo">549</span><a name="line.549"></a>
  558. <span class="sourceLineNo">550</span> /**<a name="line.550"></a>
  559. <span class="sourceLineNo">551</span> * Creates a new date tick unit. The dates will be formatted using a<a name="line.551"></a>
  560. <span class="sourceLineNo">552</span> * SHORT format for the default locale.<a name="line.552"></a>
  561. <span class="sourceLineNo">553</span> *<a name="line.553"></a>
  562. <span class="sourceLineNo">554</span> * @param unit the unit.<a name="line.554"></a>
  563. <span class="sourceLineNo">555</span> * @param count the unit count.<a name="line.555"></a>
  564. <span class="sourceLineNo">556</span> *<a name="line.556"></a>
  565. <span class="sourceLineNo">557</span> * @deprecated As of version 1.0.13, use {@link #DateTickUnit(<a name="line.557"></a>
  566. <span class="sourceLineNo">558</span> * DateTickUnitType, int)}.<a name="line.558"></a>
  567. <span class="sourceLineNo">559</span> */<a name="line.559"></a>
  568. <span class="sourceLineNo">560</span> public DateTickUnit(int unit, int count) {<a name="line.560"></a>
  569. <span class="sourceLineNo">561</span> this(unit, count, null);<a name="line.561"></a>
  570. <span class="sourceLineNo">562</span> }<a name="line.562"></a>
  571. <span class="sourceLineNo">563</span><a name="line.563"></a>
  572. <span class="sourceLineNo">564</span> /**<a name="line.564"></a>
  573. <span class="sourceLineNo">565</span> * Creates a new unit.<a name="line.565"></a>
  574. <span class="sourceLineNo">566</span> *<a name="line.566"></a>
  575. <span class="sourceLineNo">567</span> * @param unit the unit.<a name="line.567"></a>
  576. <span class="sourceLineNo">568</span> * @param count the count.<a name="line.568"></a>
  577. <span class="sourceLineNo">569</span> * @param rollUnit the roll unit.<a name="line.569"></a>
  578. <span class="sourceLineNo">570</span> * @param rollCount the roll count.<a name="line.570"></a>
  579. <span class="sourceLineNo">571</span> * @param formatter the date formatter (defaults to DateFormat.SHORT).<a name="line.571"></a>
  580. <span class="sourceLineNo">572</span> *<a name="line.572"></a>
  581. <span class="sourceLineNo">573</span> * @deprecated As of version 1.0.13, use {@link #DateTickUnit(<a name="line.573"></a>
  582. <span class="sourceLineNo">574</span> * DateTickUnitType, int, DateTickUnitType, int, DateFormat)}.<a name="line.574"></a>
  583. <span class="sourceLineNo">575</span> */<a name="line.575"></a>
  584. <span class="sourceLineNo">576</span> public DateTickUnit(int unit, int count, int rollUnit, int rollCount,<a name="line.576"></a>
  585. <span class="sourceLineNo">577</span> DateFormat formatter) {<a name="line.577"></a>
  586. <span class="sourceLineNo">578</span> this(intToUnitType(unit), count, intToUnitType(rollUnit), rollCount,<a name="line.578"></a>
  587. <span class="sourceLineNo">579</span> notNull(formatter));<a name="line.579"></a>
  588. <span class="sourceLineNo">580</span> }<a name="line.580"></a>
  589. <span class="sourceLineNo">581</span><a name="line.581"></a>
  590. <span class="sourceLineNo">582</span> /**<a name="line.582"></a>
  591. <span class="sourceLineNo">583</span> * Returns the date unit. This will be one of the constants<a name="line.583"></a>
  592. <span class="sourceLineNo">584</span> * &lt;code&gt;YEAR&lt;/code&gt;, &lt;code&gt;MONTH&lt;/code&gt;, &lt;code&gt;DAY&lt;/code&gt;,<a name="line.584"></a>
  593. <span class="sourceLineNo">585</span> * &lt;code&gt;HOUR&lt;/code&gt;, &lt;code&gt;MINUTE&lt;/code&gt;, &lt;code&gt;SECOND&lt;/code&gt; or<a name="line.585"></a>
  594. <span class="sourceLineNo">586</span> * &lt;code&gt;MILLISECOND&lt;/code&gt;, defined by this class. Note that these<a name="line.586"></a>
  595. <span class="sourceLineNo">587</span> * constants do NOT correspond to those defined in Java's<a name="line.587"></a>
  596. <span class="sourceLineNo">588</span> * &lt;code&gt;Calendar&lt;/code&gt; class.<a name="line.588"></a>
  597. <span class="sourceLineNo">589</span> *<a name="line.589"></a>
  598. <span class="sourceLineNo">590</span> * @return The date unit.<a name="line.590"></a>
  599. <span class="sourceLineNo">591</span> *<a name="line.591"></a>
  600. <span class="sourceLineNo">592</span> * @deprecated As of 1.0.13, use the getUnitType() method.<a name="line.592"></a>
  601. <span class="sourceLineNo">593</span> */<a name="line.593"></a>
  602. <span class="sourceLineNo">594</span> public int getUnit() {<a name="line.594"></a>
  603. <span class="sourceLineNo">595</span> return this.unit;<a name="line.595"></a>
  604. <span class="sourceLineNo">596</span> }<a name="line.596"></a>
  605. <span class="sourceLineNo">597</span><a name="line.597"></a>
  606. <span class="sourceLineNo">598</span> /**<a name="line.598"></a>
  607. <span class="sourceLineNo">599</span> * Returns the unit count.<a name="line.599"></a>
  608. <span class="sourceLineNo">600</span> *<a name="line.600"></a>
  609. <span class="sourceLineNo">601</span> * @return The unit count.<a name="line.601"></a>
  610. <span class="sourceLineNo">602</span> *<a name="line.602"></a>
  611. <span class="sourceLineNo">603</span> * @deprecated As of version 1.0.13, use {@link #getMultiple()}.<a name="line.603"></a>
  612. <span class="sourceLineNo">604</span> */<a name="line.604"></a>
  613. <span class="sourceLineNo">605</span> public int getCount() {<a name="line.605"></a>
  614. <span class="sourceLineNo">606</span> return this.count;<a name="line.606"></a>
  615. <span class="sourceLineNo">607</span> }<a name="line.607"></a>
  616. <span class="sourceLineNo">608</span><a name="line.608"></a>
  617. <span class="sourceLineNo">609</span> /**<a name="line.609"></a>
  618. <span class="sourceLineNo">610</span> * Returns the roll unit. This is the amount by which the tick advances if<a name="line.610"></a>
  619. <span class="sourceLineNo">611</span> * it is "hidden" when displayed on a segmented date axis. Typically the<a name="line.611"></a>
  620. <span class="sourceLineNo">612</span> * roll will be smaller than the regular tick unit (for example, a 7 day<a name="line.612"></a>
  621. <span class="sourceLineNo">613</span> * tick unit might use a 1 day roll).<a name="line.613"></a>
  622. <span class="sourceLineNo">614</span> *<a name="line.614"></a>
  623. <span class="sourceLineNo">615</span> * @return The roll unit.<a name="line.615"></a>
  624. <span class="sourceLineNo">616</span> *<a name="line.616"></a>
  625. <span class="sourceLineNo">617</span> * @deprecated As of version 1.0.13, use {@link #getRollUnitType()}.<a name="line.617"></a>
  626. <span class="sourceLineNo">618</span> */<a name="line.618"></a>
  627. <span class="sourceLineNo">619</span> public int getRollUnit() {<a name="line.619"></a>
  628. <span class="sourceLineNo">620</span> return this.rollUnit;<a name="line.620"></a>
  629. <span class="sourceLineNo">621</span> }<a name="line.621"></a>
  630. <span class="sourceLineNo">622</span><a name="line.622"></a>
  631. <span class="sourceLineNo">623</span> /**<a name="line.623"></a>
  632. <span class="sourceLineNo">624</span> * Returns the roll count.<a name="line.624"></a>
  633. <span class="sourceLineNo">625</span> *<a name="line.625"></a>
  634. <span class="sourceLineNo">626</span> * @return The roll count.<a name="line.626"></a>
  635. <span class="sourceLineNo">627</span> *<a name="line.627"></a>
  636. <span class="sourceLineNo">628</span> * @deprecated As of version 1.0.13, use the {@link #getRollMultiple()}<a name="line.628"></a>
  637. <span class="sourceLineNo">629</span> *<a name="line.629"></a>
  638. <span class="sourceLineNo">630</span> */<a name="line.630"></a>
  639. <span class="sourceLineNo">631</span> public int getRollCount() {<a name="line.631"></a>
  640. <span class="sourceLineNo">632</span> return this.rollCount;<a name="line.632"></a>
  641. <span class="sourceLineNo">633</span> }<a name="line.633"></a>
  642. <span class="sourceLineNo">634</span><a name="line.634"></a>
  643. <span class="sourceLineNo">635</span> /**<a name="line.635"></a>
  644. <span class="sourceLineNo">636</span> * Calculates a new date by adding this unit to the base date, with<a name="line.636"></a>
  645. <span class="sourceLineNo">637</span> * calculations performed in the default timezone and locale.<a name="line.637"></a>
  646. <span class="sourceLineNo">638</span> *<a name="line.638"></a>
  647. <span class="sourceLineNo">639</span> * @param base the base date.<a name="line.639"></a>
  648. <span class="sourceLineNo">640</span> *<a name="line.640"></a>
  649. <span class="sourceLineNo">641</span> * @return A new date one unit after the base date.<a name="line.641"></a>
  650. <span class="sourceLineNo">642</span> *<a name="line.642"></a>
  651. <span class="sourceLineNo">643</span> * @see #addToDate(Date, TimeZone)<a name="line.643"></a>
  652. <span class="sourceLineNo">644</span> *<a name="line.644"></a>
  653. <span class="sourceLineNo">645</span> * @deprecated As of JFreeChart 1.0.10, this method is deprecated - you<a name="line.645"></a>
  654. <span class="sourceLineNo">646</span> * should use {@link #addToDate(Date, TimeZone)} instead.<a name="line.646"></a>
  655. <span class="sourceLineNo">647</span> */<a name="line.647"></a>
  656. <span class="sourceLineNo">648</span> public Date addToDate(Date base) {<a name="line.648"></a>
  657. <span class="sourceLineNo">649</span> return addToDate(base, TimeZone.getDefault());<a name="line.649"></a>
  658. <span class="sourceLineNo">650</span> }<a name="line.650"></a>
  659. <span class="sourceLineNo">651</span><a name="line.651"></a>
  660. <span class="sourceLineNo">652</span>}<a name="line.652"></a>
  661. </pre>
  662. </div>
  663. </body>
  664. </html>