RegularTimePeriod.html 40 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837
  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
  2. <!-- NewPage -->
  3. <html lang="en">
  4. <head>
  5. <!-- Generated by javadoc (1.8.0_05) on Thu Jul 31 14:50:43 CEST 2014 -->
  6. <title>RegularTimePeriod (JFreeChart Class Library (version 1.0.19-fx))</title>
  7. <meta name="date" content="2014-07-31">
  8. <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
  9. <script type="text/javascript" src="../../../../script.js"></script>
  10. </head>
  11. <body>
  12. <script type="text/javascript"><!--
  13. try {
  14. if (location.href.indexOf('is-external=true') == -1) {
  15. parent.document.title="RegularTimePeriod (JFreeChart Class Library (version 1.0.19-fx))";
  16. }
  17. }
  18. catch(err) {
  19. }
  20. //-->
  21. var methods = {"i0":9,"i1":9,"i2":10,"i3":6,"i4":6,"i5":42,"i6":6,"i7":6,"i8":42,"i9":10,"i10":10,"i11":42,"i12":10,"i13":6,"i14":10,"i15":6,"i16":6,"i17":6,"i18":10};
  22. var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated Methods"]};
  23. var altColor = "altColor";
  24. var rowColor = "rowColor";
  25. var tableTab = "tableTab";
  26. var activeTableTab = "activeTableTab";
  27. </script>
  28. <noscript>
  29. <div>JavaScript is disabled on your browser.</div>
  30. </noscript>
  31. <!-- ========= START OF TOP NAVBAR ======= -->
  32. <div class="topNav"><a name="navbar.top">
  33. <!-- -->
  34. </a>
  35. <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
  36. <a name="navbar.top.firstrow">
  37. <!-- -->
  38. </a>
  39. <ul class="navList" title="Navigation">
  40. <li><a href="../../../../overview-summary.html">Overview</a></li>
  41. <li><a href="package-summary.html">Package</a></li>
  42. <li class="navBarCell1Rev">Class</li>
  43. <li><a href="class-use/RegularTimePeriod.html">Use</a></li>
  44. <li><a href="package-tree.html">Tree</a></li>
  45. <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
  46. <li><a href="../../../../index-files/index-1.html">Index</a></li>
  47. <li><a href="../../../../help-doc.html">Help</a></li>
  48. </ul>
  49. </div>
  50. <div class="subNav">
  51. <ul class="navList">
  52. <li><a href="../../../../org/jfree/data/time/Quarter.html" title="class in org.jfree.data.time"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  53. <li><a href="../../../../org/jfree/data/time/Second.html" title="class in org.jfree.data.time"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  54. </ul>
  55. <ul class="navList">
  56. <li><a href="../../../../index.html?org/jfree/data/time/RegularTimePeriod.html" target="_top">Frames</a></li>
  57. <li><a href="RegularTimePeriod.html" target="_top">No&nbsp;Frames</a></li>
  58. </ul>
  59. <ul class="navList" id="allclasses_navbar_top">
  60. <li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  61. </ul>
  62. <div>
  63. <script type="text/javascript"><!--
  64. allClassesLink = document.getElementById("allclasses_navbar_top");
  65. if(window==top) {
  66. allClassesLink.style.display = "block";
  67. }
  68. else {
  69. allClassesLink.style.display = "none";
  70. }
  71. //-->
  72. </script>
  73. </div>
  74. <div>
  75. <ul class="subNavList">
  76. <li>Summary:&nbsp;</li>
  77. <li>Nested&nbsp;|&nbsp;</li>
  78. <li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
  79. <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
  80. <li><a href="#method.summary">Method</a></li>
  81. </ul>
  82. <ul class="subNavList">
  83. <li>Detail:&nbsp;</li>
  84. <li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
  85. <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
  86. <li><a href="#method.detail">Method</a></li>
  87. </ul>
  88. </div>
  89. <a name="skip.navbar.top">
  90. <!-- -->
  91. </a></div>
  92. <!-- ========= END OF TOP NAVBAR ========= -->
  93. <!-- ======== START OF CLASS DATA ======== -->
  94. <div class="header">
  95. <div class="subTitle">org.jfree.data.time</div>
  96. <h2 title="Class RegularTimePeriod" class="title">Class RegularTimePeriod</h2>
  97. </div>
  98. <div class="contentContainer">
  99. <ul class="inheritance">
  100. <li>java.lang.Object</li>
  101. <li>
  102. <ul class="inheritance">
  103. <li>org.jfree.data.time.RegularTimePeriod</li>
  104. </ul>
  105. </li>
  106. </ul>
  107. <div class="description">
  108. <ul class="blockList">
  109. <li class="blockList">
  110. <dl>
  111. <dt>All Implemented Interfaces:</dt>
  112. <dd>java.lang.Comparable, <a href="../../../../org/jfree/data/time/TimePeriod.html" title="interface in org.jfree.data.time">TimePeriod</a>, org.jfree.date.MonthConstants</dd>
  113. </dl>
  114. <dl>
  115. <dt>Direct Known Subclasses:</dt>
  116. <dd><a href="../../../../org/jfree/data/time/Day.html" title="class in org.jfree.data.time">Day</a>, <a href="../../../../org/jfree/data/time/FixedMillisecond.html" title="class in org.jfree.data.time">FixedMillisecond</a>, <a href="../../../../org/jfree/data/time/Hour.html" title="class in org.jfree.data.time">Hour</a>, <a href="../../../../org/jfree/data/time/Millisecond.html" title="class in org.jfree.data.time">Millisecond</a>, <a href="../../../../org/jfree/data/time/Minute.html" title="class in org.jfree.data.time">Minute</a>, <a href="../../../../org/jfree/data/time/Month.html" title="class in org.jfree.data.time">Month</a>, <a href="../../../../org/jfree/data/time/Quarter.html" title="class in org.jfree.data.time">Quarter</a>, <a href="../../../../org/jfree/data/time/Second.html" title="class in org.jfree.data.time">Second</a>, <a href="../../../../org/jfree/data/time/Week.html" title="class in org.jfree.data.time">Week</a>, <a href="../../../../org/jfree/data/time/Year.html" title="class in org.jfree.data.time">Year</a></dd>
  117. </dl>
  118. <hr>
  119. <br>
  120. <pre>public abstract class <a href="../../../../src-html/org/jfree/data/time/RegularTimePeriod.html#line.72">RegularTimePeriod</a>
  121. extends java.lang.Object
  122. implements <a href="../../../../org/jfree/data/time/TimePeriod.html" title="interface in org.jfree.data.time">TimePeriod</a>, java.lang.Comparable, org.jfree.date.MonthConstants</pre>
  123. <div class="block">An abstract class representing a unit of time. Convenient methods are
  124. provided for calculating the next and previous time periods. Conversion
  125. methods are defined that return the first and last milliseconds of the time
  126. period. The results from these methods are timezone dependent.
  127. <P>
  128. This class is immutable, and all subclasses should be immutable also.</div>
  129. </li>
  130. </ul>
  131. </div>
  132. <div class="summary">
  133. <ul class="blockList">
  134. <li class="blockList">
  135. <!-- =========== FIELD SUMMARY =========== -->
  136. <ul class="blockList">
  137. <li class="blockList"><a name="field.summary">
  138. <!-- -->
  139. </a>
  140. <h3>Field Summary</h3>
  141. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
  142. <caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
  143. <tr>
  144. <th class="colFirst" scope="col">Modifier and Type</th>
  145. <th class="colLast" scope="col">Field and Description</th>
  146. </tr>
  147. <tr class="altColor">
  148. <td class="colFirst"><code>static java.util.TimeZone</code></td>
  149. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/time/RegularTimePeriod.html#DEFAULT_TIME_ZONE">DEFAULT_TIME_ZONE</a></span></code>
  150. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
  151. <div class="block"><span class="deprecationComment">As of 1.0.11, we discourage the use of this field - use
  152. <code>TimeZone.getDefault()</code> instead.</span></div>
  153. </div>
  154. </td>
  155. </tr>
  156. <tr class="rowColor">
  157. <td class="colFirst"><code>static java.util.Calendar</code></td>
  158. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/time/RegularTimePeriod.html#WORKING_CALENDAR">WORKING_CALENDAR</a></span></code>
  159. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
  160. <div class="block"><span class="deprecationComment">This was a bad idea, don't use it!</span></div>
  161. </div>
  162. </td>
  163. </tr>
  164. </table>
  165. <ul class="blockList">
  166. <li class="blockList"><a name="fields.inherited.from.class.org.jfree.date.MonthConstants">
  167. <!-- -->
  168. </a>
  169. <h3>Fields inherited from interface&nbsp;org.jfree.date.MonthConstants</h3>
  170. <code>APRIL, AUGUST, DECEMBER, FEBRUARY, JANUARY, JULY, JUNE, MARCH, MAY, NOVEMBER, OCTOBER, SEPTEMBER</code></li>
  171. </ul>
  172. </li>
  173. </ul>
  174. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  175. <ul class="blockList">
  176. <li class="blockList"><a name="constructor.summary">
  177. <!-- -->
  178. </a>
  179. <h3>Constructor Summary</h3>
  180. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
  181. <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
  182. <tr>
  183. <th class="colOne" scope="col">Constructor and Description</th>
  184. </tr>
  185. <tr class="altColor">
  186. <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/time/RegularTimePeriod.html#RegularTimePeriod--">RegularTimePeriod</a></span>()</code>&nbsp;</td>
  187. </tr>
  188. </table>
  189. </li>
  190. </ul>
  191. <!-- ========== METHOD SUMMARY =========== -->
  192. <ul class="blockList">
  193. <li class="blockList"><a name="method.summary">
  194. <!-- -->
  195. </a>
  196. <h3>Method Summary</h3>
  197. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  198. <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
  199. <tr>
  200. <th class="colFirst" scope="col">Modifier and Type</th>
  201. <th class="colLast" scope="col">Method and Description</th>
  202. </tr>
  203. <tr id="i0" class="altColor">
  204. <td class="colFirst"><code>static <a href="../../../../org/jfree/data/time/RegularTimePeriod.html" title="class in org.jfree.data.time">RegularTimePeriod</a></code></td>
  205. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/time/RegularTimePeriod.html#createInstance-java.lang.Class-java.util.Date-java.util.TimeZone-">createInstance</a></span>(java.lang.Class&nbsp;c,
  206. java.util.Date&nbsp;millisecond,
  207. java.util.TimeZone&nbsp;zone)</code>
  208. <div class="block">Creates a time period that includes the specified millisecond, assuming
  209. the given time zone.</div>
  210. </td>
  211. </tr>
  212. <tr id="i1" class="rowColor">
  213. <td class="colFirst"><code>static java.lang.Class</code></td>
  214. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/time/RegularTimePeriod.html#downsize-java.lang.Class-">downsize</a></span>(java.lang.Class&nbsp;c)</code>
  215. <div class="block">Returns a subclass of <a href="../../../../org/jfree/data/time/RegularTimePeriod.html" title="class in org.jfree.data.time"><code>RegularTimePeriod</code></a> that is smaller than
  216. the specified class.</div>
  217. </td>
  218. </tr>
  219. <tr id="i2" class="altColor">
  220. <td class="colFirst"><code>java.util.Date</code></td>
  221. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/time/RegularTimePeriod.html#getEnd--">getEnd</a></span>()</code>
  222. <div class="block">Returns the date/time that marks the end of the time period.</div>
  223. </td>
  224. </tr>
  225. <tr id="i3" class="rowColor">
  226. <td class="colFirst"><code>abstract long</code></td>
  227. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/time/RegularTimePeriod.html#getFirstMillisecond--">getFirstMillisecond</a></span>()</code>
  228. <div class="block">Returns the first millisecond of the time period.</div>
  229. </td>
  230. </tr>
  231. <tr id="i4" class="altColor">
  232. <td class="colFirst"><code>abstract long</code></td>
  233. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/time/RegularTimePeriod.html#getFirstMillisecond-java.util.Calendar-">getFirstMillisecond</a></span>(java.util.Calendar&nbsp;calendar)</code>
  234. <div class="block">Returns the first millisecond of the time period, evaluated using the
  235. supplied calendar (which incorporates a timezone).</div>
  236. </td>
  237. </tr>
  238. <tr id="i5" class="rowColor">
  239. <td class="colFirst"><code>long</code></td>
  240. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/time/RegularTimePeriod.html#getFirstMillisecond-java.util.TimeZone-">getFirstMillisecond</a></span>(java.util.TimeZone&nbsp;zone)</code>
  241. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
  242. <div class="block"><span class="deprecationComment">As of 1.0.3, you should avoid using this method (it creates
  243. a new Calendar instance every time it is called). You are advised
  244. to call <a href="../../../../org/jfree/data/time/RegularTimePeriod.html#getFirstMillisecond-java.util.Calendar-"><code>getFirstMillisecond(Calendar)</code></a> instead.</span></div>
  245. </div>
  246. </td>
  247. </tr>
  248. <tr id="i6" class="altColor">
  249. <td class="colFirst"><code>abstract long</code></td>
  250. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/time/RegularTimePeriod.html#getLastMillisecond--">getLastMillisecond</a></span>()</code>
  251. <div class="block">Returns the last millisecond of the time period.</div>
  252. </td>
  253. </tr>
  254. <tr id="i7" class="rowColor">
  255. <td class="colFirst"><code>abstract long</code></td>
  256. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/time/RegularTimePeriod.html#getLastMillisecond-java.util.Calendar-">getLastMillisecond</a></span>(java.util.Calendar&nbsp;calendar)</code>
  257. <div class="block">Returns the last millisecond of the time period, evaluated using the
  258. supplied calendar (which incorporates a timezone).</div>
  259. </td>
  260. </tr>
  261. <tr id="i8" class="altColor">
  262. <td class="colFirst"><code>long</code></td>
  263. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/time/RegularTimePeriod.html#getLastMillisecond-java.util.TimeZone-">getLastMillisecond</a></span>(java.util.TimeZone&nbsp;zone)</code>
  264. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
  265. <div class="block"><span class="deprecationComment">As of 1.0.3, you should avoid using this method (it creates
  266. a new Calendar instance every time it is called). You are advised
  267. to call <a href="../../../../org/jfree/data/time/RegularTimePeriod.html#getLastMillisecond-java.util.Calendar-"><code>getLastMillisecond(Calendar)</code></a> instead.</span></div>
  268. </div>
  269. </td>
  270. </tr>
  271. <tr id="i9" class="rowColor">
  272. <td class="colFirst"><code>long</code></td>
  273. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/time/RegularTimePeriod.html#getMiddleMillisecond--">getMiddleMillisecond</a></span>()</code>
  274. <div class="block">Returns the millisecond closest to the middle of the time period.</div>
  275. </td>
  276. </tr>
  277. <tr id="i10" class="altColor">
  278. <td class="colFirst"><code>long</code></td>
  279. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/time/RegularTimePeriod.html#getMiddleMillisecond-java.util.Calendar-">getMiddleMillisecond</a></span>(java.util.Calendar&nbsp;calendar)</code>
  280. <div class="block">Returns the millisecond closest to the middle of the time period,
  281. evaluated using the supplied calendar (which incorporates a timezone).</div>
  282. </td>
  283. </tr>
  284. <tr id="i11" class="rowColor">
  285. <td class="colFirst"><code>long</code></td>
  286. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/time/RegularTimePeriod.html#getMiddleMillisecond-java.util.TimeZone-">getMiddleMillisecond</a></span>(java.util.TimeZone&nbsp;zone)</code>
  287. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
  288. <div class="block"><span class="deprecationComment">As of 1.0.3, you should avoid using this method (it creates
  289. a new Calendar instance every time it is called). You are advised
  290. to call <a href="../../../../org/jfree/data/time/RegularTimePeriod.html#getMiddleMillisecond-java.util.Calendar-"><code>getMiddleMillisecond(Calendar)</code></a> instead.</span></div>
  291. </div>
  292. </td>
  293. </tr>
  294. <tr id="i12" class="altColor">
  295. <td class="colFirst"><code>long</code></td>
  296. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/time/RegularTimePeriod.html#getMillisecond-org.jfree.data.time.TimePeriodAnchor-java.util.Calendar-">getMillisecond</a></span>(<a href="../../../../org/jfree/data/time/TimePeriodAnchor.html" title="class in org.jfree.data.time">TimePeriodAnchor</a>&nbsp;anchor,
  297. java.util.Calendar&nbsp;calendar)</code>
  298. <div class="block">Returns the millisecond (relative to the epoch) corresponding to the
  299. specified <code>anchor</code> using the supplied <code>calendar</code>
  300. (which incorporates a time zone).</div>
  301. </td>
  302. </tr>
  303. <tr id="i13" class="rowColor">
  304. <td class="colFirst"><code>abstract long</code></td>
  305. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/time/RegularTimePeriod.html#getSerialIndex--">getSerialIndex</a></span>()</code>
  306. <div class="block">Returns a serial index number for the time unit.</div>
  307. </td>
  308. </tr>
  309. <tr id="i14" class="altColor">
  310. <td class="colFirst"><code>java.util.Date</code></td>
  311. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/time/RegularTimePeriod.html#getStart--">getStart</a></span>()</code>
  312. <div class="block">Returns the date/time that marks the start of the time period.</div>
  313. </td>
  314. </tr>
  315. <tr id="i15" class="rowColor">
  316. <td class="colFirst"><code>abstract <a href="../../../../org/jfree/data/time/RegularTimePeriod.html" title="class in org.jfree.data.time">RegularTimePeriod</a></code></td>
  317. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/time/RegularTimePeriod.html#next--">next</a></span>()</code>
  318. <div class="block">Returns the time period following this one, or <code>null</code> if some
  319. limit has been reached.</div>
  320. </td>
  321. </tr>
  322. <tr id="i16" class="altColor">
  323. <td class="colFirst"><code>abstract void</code></td>
  324. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/time/RegularTimePeriod.html#peg-java.util.Calendar-">peg</a></span>(java.util.Calendar&nbsp;calendar)</code>
  325. <div class="block">Recalculates the start date/time and end date/time for this time period
  326. relative to the supplied calendar (which incorporates a time zone).</div>
  327. </td>
  328. </tr>
  329. <tr id="i17" class="rowColor">
  330. <td class="colFirst"><code>abstract <a href="../../../../org/jfree/data/time/RegularTimePeriod.html" title="class in org.jfree.data.time">RegularTimePeriod</a></code></td>
  331. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/time/RegularTimePeriod.html#previous--">previous</a></span>()</code>
  332. <div class="block">Returns the time period preceding this one, or <code>null</code> if some
  333. lower limit has been reached.</div>
  334. </td>
  335. </tr>
  336. <tr id="i18" class="altColor">
  337. <td class="colFirst"><code>java.lang.String</code></td>
  338. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/time/RegularTimePeriod.html#toString--">toString</a></span>()</code>
  339. <div class="block">Returns a string representation of the time period.</div>
  340. </td>
  341. </tr>
  342. </table>
  343. <ul class="blockList">
  344. <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
  345. <!-- -->
  346. </a>
  347. <h3>Methods inherited from class&nbsp;java.lang.Object</h3>
  348. <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li>
  349. </ul>
  350. <ul class="blockList">
  351. <li class="blockList"><a name="methods.inherited.from.class.java.lang.Comparable">
  352. <!-- -->
  353. </a>
  354. <h3>Methods inherited from interface&nbsp;java.lang.Comparable</h3>
  355. <code>compareTo</code></li>
  356. </ul>
  357. </li>
  358. </ul>
  359. </li>
  360. </ul>
  361. </div>
  362. <div class="details">
  363. <ul class="blockList">
  364. <li class="blockList">
  365. <!-- ============ FIELD DETAIL =========== -->
  366. <ul class="blockList">
  367. <li class="blockList"><a name="field.detail">
  368. <!-- -->
  369. </a>
  370. <h3>Field Detail</h3>
  371. <a name="DEFAULT_TIME_ZONE">
  372. <!-- -->
  373. </a>
  374. <ul class="blockList">
  375. <li class="blockList">
  376. <h4>DEFAULT_TIME_ZONE</h4>
  377. <pre>public static final&nbsp;java.util.TimeZone <a href="../../../../src-html/org/jfree/data/time/RegularTimePeriod.html#line.166">DEFAULT_TIME_ZONE</a></pre>
  378. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">As of 1.0.11, we discourage the use of this field - use
  379. <code>TimeZone.getDefault()</code> instead.</span></div>
  380. <div class="block">The default time zone.</div>
  381. </li>
  382. </ul>
  383. <a name="WORKING_CALENDAR">
  384. <!-- -->
  385. </a>
  386. <ul class="blockListLast">
  387. <li class="blockList">
  388. <h4>WORKING_CALENDAR</h4>
  389. <pre>public static final&nbsp;java.util.Calendar <a href="../../../../src-html/org/jfree/data/time/RegularTimePeriod.html#line.173">WORKING_CALENDAR</a></pre>
  390. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">This was a bad idea, don't use it!</span></div>
  391. <div class="block">A working calendar (recycle to avoid unnecessary object creation).</div>
  392. </li>
  393. </ul>
  394. </li>
  395. </ul>
  396. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  397. <ul class="blockList">
  398. <li class="blockList"><a name="constructor.detail">
  399. <!-- -->
  400. </a>
  401. <h3>Constructor Detail</h3>
  402. <a name="RegularTimePeriod--">
  403. <!-- -->
  404. </a>
  405. <ul class="blockListLast">
  406. <li class="blockList">
  407. <h4>RegularTimePeriod</h4>
  408. <pre>public&nbsp;<a href="../../../../src-html/org/jfree/data/time/RegularTimePeriod.html#line.72">RegularTimePeriod</a>()</pre>
  409. </li>
  410. </ul>
  411. </li>
  412. </ul>
  413. <!-- ============ METHOD DETAIL ========== -->
  414. <ul class="blockList">
  415. <li class="blockList"><a name="method.detail">
  416. <!-- -->
  417. </a>
  418. <h3>Method Detail</h3>
  419. <a name="createInstance-java.lang.Class-java.util.Date-java.util.TimeZone-">
  420. <!-- -->
  421. </a>
  422. <ul class="blockList">
  423. <li class="blockList">
  424. <h4>createInstance</h4>
  425. <pre>public static&nbsp;<a href="../../../../org/jfree/data/time/RegularTimePeriod.html" title="class in org.jfree.data.time">RegularTimePeriod</a>&nbsp;<a href="../../../../src-html/org/jfree/data/time/RegularTimePeriod.html#line.85">createInstance</a>(java.lang.Class&nbsp;c,
  426. java.util.Date&nbsp;millisecond,
  427. java.util.TimeZone&nbsp;zone)</pre>
  428. <div class="block">Creates a time period that includes the specified millisecond, assuming
  429. the given time zone.</div>
  430. <dl>
  431. <dt><span class="paramLabel">Parameters:</span></dt>
  432. <dd><code>c</code> - the time period class.</dd>
  433. <dd><code>millisecond</code> - the time.</dd>
  434. <dd><code>zone</code> - the time zone.</dd>
  435. <dt><span class="returnLabel">Returns:</span></dt>
  436. <dd>The time period.</dd>
  437. </dl>
  438. </li>
  439. </ul>
  440. <a name="downsize-java.lang.Class-">
  441. <!-- -->
  442. </a>
  443. <ul class="blockList">
  444. <li class="blockList">
  445. <h4>downsize</h4>
  446. <pre>public static&nbsp;java.lang.Class&nbsp;<a href="../../../../src-html/org/jfree/data/time/RegularTimePeriod.html#line.108">downsize</a>(java.lang.Class&nbsp;c)</pre>
  447. <div class="block">Returns a subclass of <a href="../../../../org/jfree/data/time/RegularTimePeriod.html" title="class in org.jfree.data.time"><code>RegularTimePeriod</code></a> that is smaller than
  448. the specified class.</div>
  449. <dl>
  450. <dt><span class="paramLabel">Parameters:</span></dt>
  451. <dd><code>c</code> - a subclass of <a href="../../../../org/jfree/data/time/RegularTimePeriod.html" title="class in org.jfree.data.time"><code>RegularTimePeriod</code></a>.</dd>
  452. <dt><span class="returnLabel">Returns:</span></dt>
  453. <dd>A class.</dd>
  454. </dl>
  455. </li>
  456. </ul>
  457. <a name="previous--">
  458. <!-- -->
  459. </a>
  460. <ul class="blockList">
  461. <li class="blockList">
  462. <h4>previous</h4>
  463. <pre>public abstract&nbsp;<a href="../../../../org/jfree/data/time/RegularTimePeriod.html" title="class in org.jfree.data.time">RegularTimePeriod</a>&nbsp;<a href="../../../../src-html/org/jfree/data/time/RegularTimePeriod.html#line.141">previous</a>()</pre>
  464. <div class="block">Returns the time period preceding this one, or <code>null</code> if some
  465. lower limit has been reached.</div>
  466. <dl>
  467. <dt><span class="returnLabel">Returns:</span></dt>
  468. <dd>The previous time period (possibly <code>null</code>).</dd>
  469. </dl>
  470. </li>
  471. </ul>
  472. <a name="next--">
  473. <!-- -->
  474. </a>
  475. <ul class="blockList">
  476. <li class="blockList">
  477. <h4>next</h4>
  478. <pre>public abstract&nbsp;<a href="../../../../org/jfree/data/time/RegularTimePeriod.html" title="class in org.jfree.data.time">RegularTimePeriod</a>&nbsp;<a href="../../../../src-html/org/jfree/data/time/RegularTimePeriod.html#line.149">next</a>()</pre>
  479. <div class="block">Returns the time period following this one, or <code>null</code> if some
  480. limit has been reached.</div>
  481. <dl>
  482. <dt><span class="returnLabel">Returns:</span></dt>
  483. <dd>The next time period (possibly <code>null</code>).</dd>
  484. </dl>
  485. </li>
  486. </ul>
  487. <a name="getSerialIndex--">
  488. <!-- -->
  489. </a>
  490. <ul class="blockList">
  491. <li class="blockList">
  492. <h4>getSerialIndex</h4>
  493. <pre>public abstract&nbsp;long&nbsp;<a href="../../../../src-html/org/jfree/data/time/RegularTimePeriod.html#line.156">getSerialIndex</a>()</pre>
  494. <div class="block">Returns a serial index number for the time unit.</div>
  495. <dl>
  496. <dt><span class="returnLabel">Returns:</span></dt>
  497. <dd>The serial index number.</dd>
  498. </dl>
  499. </li>
  500. </ul>
  501. <a name="peg-java.util.Calendar-">
  502. <!-- -->
  503. </a>
  504. <ul class="blockList">
  505. <li class="blockList">
  506. <h4>peg</h4>
  507. <pre>public abstract&nbsp;void&nbsp;<a href="../../../../src-html/org/jfree/data/time/RegularTimePeriod.html#line.184">peg</a>(java.util.Calendar&nbsp;calendar)</pre>
  508. <div class="block">Recalculates the start date/time and end date/time for this time period
  509. relative to the supplied calendar (which incorporates a time zone).</div>
  510. <dl>
  511. <dt><span class="paramLabel">Parameters:</span></dt>
  512. <dd><code>calendar</code> - the calendar (<code>null</code> not permitted).</dd>
  513. <dt><span class="simpleTagLabel">Since:</span></dt>
  514. <dd>1.0.3</dd>
  515. </dl>
  516. </li>
  517. </ul>
  518. <a name="getStart--">
  519. <!-- -->
  520. </a>
  521. <ul class="blockList">
  522. <li class="blockList">
  523. <h4>getStart</h4>
  524. <pre>public&nbsp;java.util.Date&nbsp;<a href="../../../../src-html/org/jfree/data/time/RegularTimePeriod.html#line.195">getStart</a>()</pre>
  525. <div class="block">Returns the date/time that marks the start of the time period. This
  526. method returns a new <code>Date</code> instance every time it is called.</div>
  527. <dl>
  528. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  529. <dd><code><a href="../../../../org/jfree/data/time/TimePeriod.html#getStart--">getStart</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/jfree/data/time/TimePeriod.html" title="interface in org.jfree.data.time">TimePeriod</a></code></dd>
  530. <dt><span class="returnLabel">Returns:</span></dt>
  531. <dd>The start date/time.</dd>
  532. <dt><span class="seeLabel">See Also:</span></dt>
  533. <dd><a href="../../../../org/jfree/data/time/RegularTimePeriod.html#getFirstMillisecond--"><code>getFirstMillisecond()</code></a></dd>
  534. </dl>
  535. </li>
  536. </ul>
  537. <a name="getEnd--">
  538. <!-- -->
  539. </a>
  540. <ul class="blockList">
  541. <li class="blockList">
  542. <h4>getEnd</h4>
  543. <pre>public&nbsp;java.util.Date&nbsp;<a href="../../../../src-html/org/jfree/data/time/RegularTimePeriod.html#line.208">getEnd</a>()</pre>
  544. <div class="block">Returns the date/time that marks the end of the time period. This
  545. method returns a new <code>Date</code> instance every time it is called.</div>
  546. <dl>
  547. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  548. <dd><code><a href="../../../../org/jfree/data/time/TimePeriod.html#getEnd--">getEnd</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/jfree/data/time/TimePeriod.html" title="interface in org.jfree.data.time">TimePeriod</a></code></dd>
  549. <dt><span class="returnLabel">Returns:</span></dt>
  550. <dd>The end date/time.</dd>
  551. <dt><span class="seeLabel">See Also:</span></dt>
  552. <dd><a href="../../../../org/jfree/data/time/RegularTimePeriod.html#getLastMillisecond--"><code>getLastMillisecond()</code></a></dd>
  553. </dl>
  554. </li>
  555. </ul>
  556. <a name="getFirstMillisecond--">
  557. <!-- -->
  558. </a>
  559. <ul class="blockList">
  560. <li class="blockList">
  561. <h4>getFirstMillisecond</h4>
  562. <pre>public abstract&nbsp;long&nbsp;<a href="../../../../src-html/org/jfree/data/time/RegularTimePeriod.html#line.222">getFirstMillisecond</a>()</pre>
  563. <div class="block">Returns the first millisecond of the time period. This will be
  564. determined relative to the time zone specified in the constructor, or
  565. in the calendar instance passed in the most recent call to the
  566. <a href="../../../../org/jfree/data/time/RegularTimePeriod.html#peg-java.util.Calendar-"><code>peg(Calendar)</code></a> method.</div>
  567. <dl>
  568. <dt><span class="returnLabel">Returns:</span></dt>
  569. <dd>The first millisecond of the time period.</dd>
  570. <dt><span class="seeLabel">See Also:</span></dt>
  571. <dd><a href="../../../../org/jfree/data/time/RegularTimePeriod.html#getLastMillisecond--"><code>getLastMillisecond()</code></a></dd>
  572. </dl>
  573. </li>
  574. </ul>
  575. <a name="getFirstMillisecond-java.util.TimeZone-">
  576. <!-- -->
  577. </a>
  578. <ul class="blockList">
  579. <li class="blockList">
  580. <h4>getFirstMillisecond</h4>
  581. <pre>public&nbsp;long&nbsp;<a href="../../../../src-html/org/jfree/data/time/RegularTimePeriod.html#line.238">getFirstMillisecond</a>(java.util.TimeZone&nbsp;zone)</pre>
  582. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">As of 1.0.3, you should avoid using this method (it creates
  583. a new Calendar instance every time it is called). You are advised
  584. to call <a href="../../../../org/jfree/data/time/RegularTimePeriod.html#getFirstMillisecond-java.util.Calendar-"><code>getFirstMillisecond(Calendar)</code></a> instead.</span></div>
  585. <div class="block">Returns the first millisecond of the time period, evaluated within a
  586. specific time zone.</div>
  587. <dl>
  588. <dt><span class="paramLabel">Parameters:</span></dt>
  589. <dd><code>zone</code> - the time zone (<code>null</code> not permitted).</dd>
  590. <dt><span class="returnLabel">Returns:</span></dt>
  591. <dd>The first millisecond of the time period.</dd>
  592. <dt><span class="seeLabel">See Also:</span></dt>
  593. <dd><a href="../../../../org/jfree/data/time/RegularTimePeriod.html#getLastMillisecond-java.util.TimeZone-"><code>getLastMillisecond(TimeZone)</code></a></dd>
  594. </dl>
  595. </li>
  596. </ul>
  597. <a name="getFirstMillisecond-java.util.Calendar-">
  598. <!-- -->
  599. </a>
  600. <ul class="blockList">
  601. <li class="blockList">
  602. <h4>getFirstMillisecond</h4>
  603. <pre>public abstract&nbsp;long&nbsp;<a href="../../../../src-html/org/jfree/data/time/RegularTimePeriod.html#line.255">getFirstMillisecond</a>(java.util.Calendar&nbsp;calendar)</pre>
  604. <div class="block">Returns the first millisecond of the time period, evaluated using the
  605. supplied calendar (which incorporates a timezone).</div>
  606. <dl>
  607. <dt><span class="paramLabel">Parameters:</span></dt>
  608. <dd><code>calendar</code> - the calendar (<code>null</code> not permitted).</dd>
  609. <dt><span class="returnLabel">Returns:</span></dt>
  610. <dd>The first millisecond of the time period.</dd>
  611. <dt><span class="throwsLabel">Throws:</span></dt>
  612. <dd><code>java.lang.NullPointerException</code> - if <code>calendar</code> is <code>null</code>.</dd>
  613. <dt><span class="seeLabel">See Also:</span></dt>
  614. <dd><a href="../../../../org/jfree/data/time/RegularTimePeriod.html#getLastMillisecond-java.util.Calendar-"><code>getLastMillisecond(Calendar)</code></a></dd>
  615. </dl>
  616. </li>
  617. </ul>
  618. <a name="getLastMillisecond--">
  619. <!-- -->
  620. </a>
  621. <ul class="blockList">
  622. <li class="blockList">
  623. <h4>getLastMillisecond</h4>
  624. <pre>public abstract&nbsp;long&nbsp;<a href="../../../../src-html/org/jfree/data/time/RegularTimePeriod.html#line.267">getLastMillisecond</a>()</pre>
  625. <div class="block">Returns the last millisecond of the time period. This will be
  626. determined relative to the time zone specified in the constructor, or
  627. in the calendar instance passed in the most recent call to the
  628. <a href="../../../../org/jfree/data/time/RegularTimePeriod.html#peg-java.util.Calendar-"><code>peg(Calendar)</code></a> method.</div>
  629. <dl>
  630. <dt><span class="returnLabel">Returns:</span></dt>
  631. <dd>The last millisecond of the time period.</dd>
  632. <dt><span class="seeLabel">See Also:</span></dt>
  633. <dd><a href="../../../../org/jfree/data/time/RegularTimePeriod.html#getFirstMillisecond--"><code>getFirstMillisecond()</code></a></dd>
  634. </dl>
  635. </li>
  636. </ul>
  637. <a name="getLastMillisecond-java.util.TimeZone-">
  638. <!-- -->
  639. </a>
  640. <ul class="blockList">
  641. <li class="blockList">
  642. <h4>getLastMillisecond</h4>
  643. <pre>public&nbsp;long&nbsp;<a href="../../../../src-html/org/jfree/data/time/RegularTimePeriod.html#line.283">getLastMillisecond</a>(java.util.TimeZone&nbsp;zone)</pre>
  644. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">As of 1.0.3, you should avoid using this method (it creates
  645. a new Calendar instance every time it is called). You are advised
  646. to call <a href="../../../../org/jfree/data/time/RegularTimePeriod.html#getLastMillisecond-java.util.Calendar-"><code>getLastMillisecond(Calendar)</code></a> instead.</span></div>
  647. <div class="block">Returns the last millisecond of the time period, evaluated within a
  648. specific time zone.</div>
  649. <dl>
  650. <dt><span class="paramLabel">Parameters:</span></dt>
  651. <dd><code>zone</code> - the time zone (<code>null</code> not permitted).</dd>
  652. <dt><span class="returnLabel">Returns:</span></dt>
  653. <dd>The last millisecond of the time period.</dd>
  654. <dt><span class="seeLabel">See Also:</span></dt>
  655. <dd><a href="../../../../org/jfree/data/time/RegularTimePeriod.html#getFirstMillisecond-java.util.TimeZone-"><code>getFirstMillisecond(TimeZone)</code></a></dd>
  656. </dl>
  657. </li>
  658. </ul>
  659. <a name="getLastMillisecond-java.util.Calendar-">
  660. <!-- -->
  661. </a>
  662. <ul class="blockList">
  663. <li class="blockList">
  664. <h4>getLastMillisecond</h4>
  665. <pre>public abstract&nbsp;long&nbsp;<a href="../../../../src-html/org/jfree/data/time/RegularTimePeriod.html#line.298">getLastMillisecond</a>(java.util.Calendar&nbsp;calendar)</pre>
  666. <div class="block">Returns the last millisecond of the time period, evaluated using the
  667. supplied calendar (which incorporates a timezone).</div>
  668. <dl>
  669. <dt><span class="paramLabel">Parameters:</span></dt>
  670. <dd><code>calendar</code> - the calendar (<code>null</code> not permitted).</dd>
  671. <dt><span class="returnLabel">Returns:</span></dt>
  672. <dd>The last millisecond of the time period.</dd>
  673. <dt><span class="seeLabel">See Also:</span></dt>
  674. <dd><a href="../../../../org/jfree/data/time/RegularTimePeriod.html#getFirstMillisecond-java.util.Calendar-"><code>getFirstMillisecond(Calendar)</code></a></dd>
  675. </dl>
  676. </li>
  677. </ul>
  678. <a name="getMiddleMillisecond--">
  679. <!-- -->
  680. </a>
  681. <ul class="blockList">
  682. <li class="blockList">
  683. <h4>getMiddleMillisecond</h4>
  684. <pre>public&nbsp;long&nbsp;<a href="../../../../src-html/org/jfree/data/time/RegularTimePeriod.html#line.305">getMiddleMillisecond</a>()</pre>
  685. <div class="block">Returns the millisecond closest to the middle of the time period.</div>
  686. <dl>
  687. <dt><span class="returnLabel">Returns:</span></dt>
  688. <dd>The middle millisecond.</dd>
  689. </dl>
  690. </li>
  691. </ul>
  692. <a name="getMiddleMillisecond-java.util.TimeZone-">
  693. <!-- -->
  694. </a>
  695. <ul class="blockList">
  696. <li class="blockList">
  697. <h4>getMiddleMillisecond</h4>
  698. <pre>public&nbsp;long&nbsp;<a href="../../../../src-html/org/jfree/data/time/RegularTimePeriod.html#line.323">getMiddleMillisecond</a>(java.util.TimeZone&nbsp;zone)</pre>
  699. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">As of 1.0.3, you should avoid using this method (it creates
  700. a new Calendar instance every time it is called). You are advised
  701. to call <a href="../../../../org/jfree/data/time/RegularTimePeriod.html#getMiddleMillisecond-java.util.Calendar-"><code>getMiddleMillisecond(Calendar)</code></a> instead.</span></div>
  702. <div class="block">Returns the millisecond closest to the middle of the time period,
  703. evaluated within a specific time zone.</div>
  704. <dl>
  705. <dt><span class="paramLabel">Parameters:</span></dt>
  706. <dd><code>zone</code> - the time zone (<code>null</code> not permitted).</dd>
  707. <dt><span class="returnLabel">Returns:</span></dt>
  708. <dd>The middle millisecond.</dd>
  709. </dl>
  710. </li>
  711. </ul>
  712. <a name="getMiddleMillisecond-java.util.Calendar-">
  713. <!-- -->
  714. </a>
  715. <ul class="blockList">
  716. <li class="blockList">
  717. <h4>getMiddleMillisecond</h4>
  718. <pre>public&nbsp;long&nbsp;<a href="../../../../src-html/org/jfree/data/time/RegularTimePeriod.html#line.338">getMiddleMillisecond</a>(java.util.Calendar&nbsp;calendar)</pre>
  719. <div class="block">Returns the millisecond closest to the middle of the time period,
  720. evaluated using the supplied calendar (which incorporates a timezone).</div>
  721. <dl>
  722. <dt><span class="paramLabel">Parameters:</span></dt>
  723. <dd><code>calendar</code> - the calendar.</dd>
  724. <dt><span class="returnLabel">Returns:</span></dt>
  725. <dd>The middle millisecond.</dd>
  726. </dl>
  727. </li>
  728. </ul>
  729. <a name="getMillisecond-org.jfree.data.time.TimePeriodAnchor-java.util.Calendar-">
  730. <!-- -->
  731. </a>
  732. <ul class="blockList">
  733. <li class="blockList">
  734. <h4>getMillisecond</h4>
  735. <pre>public&nbsp;long&nbsp;<a href="../../../../src-html/org/jfree/data/time/RegularTimePeriod.html#line.356">getMillisecond</a>(<a href="../../../../org/jfree/data/time/TimePeriodAnchor.html" title="class in org.jfree.data.time">TimePeriodAnchor</a>&nbsp;anchor,
  736. java.util.Calendar&nbsp;calendar)</pre>
  737. <div class="block">Returns the millisecond (relative to the epoch) corresponding to the
  738. specified <code>anchor</code> using the supplied <code>calendar</code>
  739. (which incorporates a time zone).</div>
  740. <dl>
  741. <dt><span class="paramLabel">Parameters:</span></dt>
  742. <dd><code>anchor</code> - the anchor (<code>null</code> not permitted).</dd>
  743. <dd><code>calendar</code> - the calendar (<code>null</code> not permitted).</dd>
  744. <dt><span class="returnLabel">Returns:</span></dt>
  745. <dd>Milliseconds since the epoch.</dd>
  746. <dt><span class="simpleTagLabel">Since:</span></dt>
  747. <dd>1.0.18</dd>
  748. </dl>
  749. </li>
  750. </ul>
  751. <a name="toString--">
  752. <!-- -->
  753. </a>
  754. <ul class="blockListLast">
  755. <li class="blockList">
  756. <h4>toString</h4>
  757. <pre>public&nbsp;java.lang.String&nbsp;<a href="../../../../src-html/org/jfree/data/time/RegularTimePeriod.html#line.374">toString</a>()</pre>
  758. <div class="block">Returns a string representation of the time period.</div>
  759. <dl>
  760. <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
  761. <dd><code>toString</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
  762. <dt><span class="returnLabel">Returns:</span></dt>
  763. <dd>The string.</dd>
  764. </dl>
  765. </li>
  766. </ul>
  767. </li>
  768. </ul>
  769. </li>
  770. </ul>
  771. </div>
  772. </div>
  773. <!-- ========= END OF CLASS DATA ========= -->
  774. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  775. <div class="bottomNav"><a name="navbar.bottom">
  776. <!-- -->
  777. </a>
  778. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  779. <a name="navbar.bottom.firstrow">
  780. <!-- -->
  781. </a>
  782. <ul class="navList" title="Navigation">
  783. <li><a href="../../../../overview-summary.html">Overview</a></li>
  784. <li><a href="package-summary.html">Package</a></li>
  785. <li class="navBarCell1Rev">Class</li>
  786. <li><a href="class-use/RegularTimePeriod.html">Use</a></li>
  787. <li><a href="package-tree.html">Tree</a></li>
  788. <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
  789. <li><a href="../../../../index-files/index-1.html">Index</a></li>
  790. <li><a href="../../../../help-doc.html">Help</a></li>
  791. </ul>
  792. </div>
  793. <div class="subNav">
  794. <ul class="navList">
  795. <li><a href="../../../../org/jfree/data/time/Quarter.html" title="class in org.jfree.data.time"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  796. <li><a href="../../../../org/jfree/data/time/Second.html" title="class in org.jfree.data.time"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  797. </ul>
  798. <ul class="navList">
  799. <li><a href="../../../../index.html?org/jfree/data/time/RegularTimePeriod.html" target="_top">Frames</a></li>
  800. <li><a href="RegularTimePeriod.html" target="_top">No&nbsp;Frames</a></li>
  801. </ul>
  802. <ul class="navList" id="allclasses_navbar_bottom">
  803. <li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  804. </ul>
  805. <div>
  806. <script type="text/javascript"><!--
  807. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  808. if(window==top) {
  809. allClassesLink.style.display = "block";
  810. }
  811. else {
  812. allClassesLink.style.display = "none";
  813. }
  814. //-->
  815. </script>
  816. </div>
  817. <div>
  818. <ul class="subNavList">
  819. <li>Summary:&nbsp;</li>
  820. <li>Nested&nbsp;|&nbsp;</li>
  821. <li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
  822. <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
  823. <li><a href="#method.summary">Method</a></li>
  824. </ul>
  825. <ul class="subNavList">
  826. <li>Detail:&nbsp;</li>
  827. <li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
  828. <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
  829. <li><a href="#method.detail">Method</a></li>
  830. </ul>
  831. </div>
  832. <a name="skip.navbar.bottom">
  833. <!-- -->
  834. </a></div>
  835. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  836. </body>
  837. </html>