Week.html 41 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903
  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>Week (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="Week (JFreeChart Class Library (version 1.0.19-fx))";
  16. }
  17. }
  18. catch(err) {
  19. }
  20. //-->
  21. var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":9,"i13":10,"i14":10,"i15":10};
  22. var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete 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/Week.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/TimeTableXYDataset.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/Year.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/Week.html" target="_top">Frames</a></li>
  57. <li><a href="Week.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 Week" class="title">Class Week</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><a href="../../../../org/jfree/data/time/RegularTimePeriod.html" title="class in org.jfree.data.time">org.jfree.data.time.RegularTimePeriod</a></li>
  104. <li>
  105. <ul class="inheritance">
  106. <li>org.jfree.data.time.Week</li>
  107. </ul>
  108. </li>
  109. </ul>
  110. </li>
  111. </ul>
  112. <div class="description">
  113. <ul class="blockList">
  114. <li class="blockList">
  115. <dl>
  116. <dt>All Implemented Interfaces:</dt>
  117. <dd>java.io.Serializable, 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>
  118. </dl>
  119. <hr>
  120. <br>
  121. <pre>public class <a href="../../../../src-html/org/jfree/data/time/Week.html#line.94">Week</a>
  122. extends <a href="../../../../org/jfree/data/time/RegularTimePeriod.html" title="class in org.jfree.data.time">RegularTimePeriod</a>
  123. implements java.io.Serializable</pre>
  124. <div class="block">A calendar week. All years are considered to have 53 weeks, numbered from 1
  125. to 53, although in many cases the 53rd week is empty. Most of the time, the
  126. 1st week of the year *begins* in the previous calendar year, but it always
  127. finishes in the current year (this behaviour matches the workings of the
  128. <code>GregorianCalendar</code> class).
  129. <P>
  130. This class is immutable, which is a requirement for all
  131. <a href="../../../../org/jfree/data/time/RegularTimePeriod.html" title="class in org.jfree.data.time"><code>RegularTimePeriod</code></a> subclasses.</div>
  132. <dl>
  133. <dt><span class="seeLabel">See Also:</span></dt>
  134. <dd><a href="../../../../serialized-form.html#org.jfree.data.time.Week">Serialized Form</a></dd>
  135. </dl>
  136. </li>
  137. </ul>
  138. </div>
  139. <div class="summary">
  140. <ul class="blockList">
  141. <li class="blockList">
  142. <!-- =========== FIELD SUMMARY =========== -->
  143. <ul class="blockList">
  144. <li class="blockList"><a name="field.summary">
  145. <!-- -->
  146. </a>
  147. <h3>Field Summary</h3>
  148. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
  149. <caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
  150. <tr>
  151. <th class="colFirst" scope="col">Modifier and Type</th>
  152. <th class="colLast" scope="col">Field and Description</th>
  153. </tr>
  154. <tr class="altColor">
  155. <td class="colFirst"><code>static int</code></td>
  156. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/time/Week.html#FIRST_WEEK_IN_YEAR">FIRST_WEEK_IN_YEAR</a></span></code>
  157. <div class="block">Constant for the first week in the year.</div>
  158. </td>
  159. </tr>
  160. <tr class="rowColor">
  161. <td class="colFirst"><code>static int</code></td>
  162. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/time/Week.html#LAST_WEEK_IN_YEAR">LAST_WEEK_IN_YEAR</a></span></code>
  163. <div class="block">Constant for the last week in the year.</div>
  164. </td>
  165. </tr>
  166. </table>
  167. <ul class="blockList">
  168. <li class="blockList"><a name="fields.inherited.from.class.org.jfree.data.time.RegularTimePeriod">
  169. <!-- -->
  170. </a>
  171. <h3>Fields inherited from class&nbsp;org.jfree.data.time.<a href="../../../../org/jfree/data/time/RegularTimePeriod.html" title="class in org.jfree.data.time">RegularTimePeriod</a></h3>
  172. <code><a href="../../../../org/jfree/data/time/RegularTimePeriod.html#DEFAULT_TIME_ZONE">DEFAULT_TIME_ZONE</a>, <a href="../../../../org/jfree/data/time/RegularTimePeriod.html#WORKING_CALENDAR">WORKING_CALENDAR</a></code></li>
  173. </ul>
  174. <ul class="blockList">
  175. <li class="blockList"><a name="fields.inherited.from.class.org.jfree.date.MonthConstants">
  176. <!-- -->
  177. </a>
  178. <h3>Fields inherited from interface&nbsp;org.jfree.date.MonthConstants</h3>
  179. <code>APRIL, AUGUST, DECEMBER, FEBRUARY, JANUARY, JULY, JUNE, MARCH, MAY, NOVEMBER, OCTOBER, SEPTEMBER</code></li>
  180. </ul>
  181. </li>
  182. </ul>
  183. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  184. <ul class="blockList">
  185. <li class="blockList"><a name="constructor.summary">
  186. <!-- -->
  187. </a>
  188. <h3>Constructor Summary</h3>
  189. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
  190. <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
  191. <tr>
  192. <th class="colOne" scope="col">Constructor and Description</th>
  193. </tr>
  194. <tr class="altColor">
  195. <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/time/Week.html#Week--">Week</a></span>()</code>
  196. <div class="block">Creates a new time period for the week in which the current system
  197. date/time falls.</div>
  198. </td>
  199. </tr>
  200. <tr class="rowColor">
  201. <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/time/Week.html#Week-java.util.Date-">Week</a></span>(java.util.Date&nbsp;time)</code>
  202. <div class="block">Creates a time period for the week in which the specified date/time
  203. falls, using the default time zone and locale (the locale can affect the
  204. day-of-the-week that marks the beginning of the week, as well as the
  205. minimal number of days in the first week of the year).</div>
  206. </td>
  207. </tr>
  208. <tr class="altColor">
  209. <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/time/Week.html#Week-java.util.Date-java.util.TimeZone-">Week</a></span>(java.util.Date&nbsp;time,
  210. java.util.TimeZone&nbsp;zone)</code>
  211. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
  212. <div class="block"><span class="deprecationComment">As of 1.0.7, use <a href="../../../../org/jfree/data/time/Week.html#Week-java.util.Date-java.util.TimeZone-java.util.Locale-"><code>Week(Date, TimeZone, Locale)</code></a>.</span></div>
  213. </div>
  214. </td>
  215. </tr>
  216. <tr class="rowColor">
  217. <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/time/Week.html#Week-java.util.Date-java.util.TimeZone-java.util.Locale-">Week</a></span>(java.util.Date&nbsp;time,
  218. java.util.TimeZone&nbsp;zone,
  219. java.util.Locale&nbsp;locale)</code>
  220. <div class="block">Creates a time period for the week in which the specified date/time
  221. falls, calculated relative to the specified time zone.</div>
  222. </td>
  223. </tr>
  224. <tr class="altColor">
  225. <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/time/Week.html#Week-int-int-">Week</a></span>(int&nbsp;week,
  226. int&nbsp;year)</code>
  227. <div class="block">Creates a time period representing the week in the specified year.</div>
  228. </td>
  229. </tr>
  230. <tr class="rowColor">
  231. <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/time/Week.html#Week-int-org.jfree.data.time.Year-">Week</a></span>(int&nbsp;week,
  232. <a href="../../../../org/jfree/data/time/Year.html" title="class in org.jfree.data.time">Year</a>&nbsp;year)</code>
  233. <div class="block">Creates a time period representing the week in the specified year.</div>
  234. </td>
  235. </tr>
  236. </table>
  237. </li>
  238. </ul>
  239. <!-- ========== METHOD SUMMARY =========== -->
  240. <ul class="blockList">
  241. <li class="blockList"><a name="method.summary">
  242. <!-- -->
  243. </a>
  244. <h3>Method Summary</h3>
  245. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  246. <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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
  247. <tr>
  248. <th class="colFirst" scope="col">Modifier and Type</th>
  249. <th class="colLast" scope="col">Method and Description</th>
  250. </tr>
  251. <tr id="i0" class="altColor">
  252. <td class="colFirst"><code>int</code></td>
  253. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/time/Week.html#compareTo-java.lang.Object-">compareTo</a></span>(java.lang.Object&nbsp;o1)</code>
  254. <div class="block">Returns an integer indicating the order of this Week object relative to
  255. the specified object:
  256. negative == before, zero == same, positive == after.</div>
  257. </td>
  258. </tr>
  259. <tr id="i1" class="rowColor">
  260. <td class="colFirst"><code>boolean</code></td>
  261. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/time/Week.html#equals-java.lang.Object-">equals</a></span>(java.lang.Object&nbsp;obj)</code>
  262. <div class="block">Tests the equality of this Week object to an arbitrary object.</div>
  263. </td>
  264. </tr>
  265. <tr id="i2" class="altColor">
  266. <td class="colFirst"><code>long</code></td>
  267. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/time/Week.html#getFirstMillisecond--">getFirstMillisecond</a></span>()</code>
  268. <div class="block">Returns the first millisecond of the week.</div>
  269. </td>
  270. </tr>
  271. <tr id="i3" class="rowColor">
  272. <td class="colFirst"><code>long</code></td>
  273. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/time/Week.html#getFirstMillisecond-java.util.Calendar-">getFirstMillisecond</a></span>(java.util.Calendar&nbsp;calendar)</code>
  274. <div class="block">Returns the first millisecond of the week, evaluated using the supplied
  275. calendar (which determines the time zone).</div>
  276. </td>
  277. </tr>
  278. <tr id="i4" class="altColor">
  279. <td class="colFirst"><code>long</code></td>
  280. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/time/Week.html#getLastMillisecond--">getLastMillisecond</a></span>()</code>
  281. <div class="block">Returns the last millisecond of the week.</div>
  282. </td>
  283. </tr>
  284. <tr id="i5" class="rowColor">
  285. <td class="colFirst"><code>long</code></td>
  286. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/time/Week.html#getLastMillisecond-java.util.Calendar-">getLastMillisecond</a></span>(java.util.Calendar&nbsp;calendar)</code>
  287. <div class="block">Returns the last millisecond of the week, evaluated using the supplied
  288. calendar (which determines the time zone).</div>
  289. </td>
  290. </tr>
  291. <tr id="i6" class="altColor">
  292. <td class="colFirst"><code>long</code></td>
  293. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/time/Week.html#getSerialIndex--">getSerialIndex</a></span>()</code>
  294. <div class="block">Returns a serial index number for the week.</div>
  295. </td>
  296. </tr>
  297. <tr id="i7" class="rowColor">
  298. <td class="colFirst"><code>int</code></td>
  299. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/time/Week.html#getWeek--">getWeek</a></span>()</code>
  300. <div class="block">Returns the week.</div>
  301. </td>
  302. </tr>
  303. <tr id="i8" class="altColor">
  304. <td class="colFirst"><code><a href="../../../../org/jfree/data/time/Year.html" title="class in org.jfree.data.time">Year</a></code></td>
  305. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/time/Week.html#getYear--">getYear</a></span>()</code>
  306. <div class="block">Returns the year in which the week falls.</div>
  307. </td>
  308. </tr>
  309. <tr id="i9" class="rowColor">
  310. <td class="colFirst"><code>int</code></td>
  311. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/time/Week.html#getYearValue--">getYearValue</a></span>()</code>
  312. <div class="block">Returns the year in which the week falls, as an integer value.</div>
  313. </td>
  314. </tr>
  315. <tr id="i10" class="altColor">
  316. <td class="colFirst"><code>int</code></td>
  317. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/time/Week.html#hashCode--">hashCode</a></span>()</code>
  318. <div class="block">Returns a hash code for this object instance.</div>
  319. </td>
  320. </tr>
  321. <tr id="i11" class="rowColor">
  322. <td class="colFirst"><code><a href="../../../../org/jfree/data/time/RegularTimePeriod.html" title="class in org.jfree.data.time">RegularTimePeriod</a></code></td>
  323. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/time/Week.html#next--">next</a></span>()</code>
  324. <div class="block">Returns the week following this one.</div>
  325. </td>
  326. </tr>
  327. <tr id="i12" class="altColor">
  328. <td class="colFirst"><code>static <a href="../../../../org/jfree/data/time/Week.html" title="class in org.jfree.data.time">Week</a></code></td>
  329. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/time/Week.html#parseWeek-java.lang.String-">parseWeek</a></span>(java.lang.String&nbsp;s)</code>
  330. <div class="block">Parses the string argument as a week.</div>
  331. </td>
  332. </tr>
  333. <tr id="i13" class="rowColor">
  334. <td class="colFirst"><code>void</code></td>
  335. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/time/Week.html#peg-java.util.Calendar-">peg</a></span>(java.util.Calendar&nbsp;calendar)</code>
  336. <div class="block">Recalculates the start date/time and end date/time for this time period
  337. relative to the supplied calendar (which incorporates a time zone).</div>
  338. </td>
  339. </tr>
  340. <tr id="i14" class="altColor">
  341. <td class="colFirst"><code><a href="../../../../org/jfree/data/time/RegularTimePeriod.html" title="class in org.jfree.data.time">RegularTimePeriod</a></code></td>
  342. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/time/Week.html#previous--">previous</a></span>()</code>
  343. <div class="block">Returns the week preceding this one.</div>
  344. </td>
  345. </tr>
  346. <tr id="i15" class="rowColor">
  347. <td class="colFirst"><code>java.lang.String</code></td>
  348. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/time/Week.html#toString--">toString</a></span>()</code>
  349. <div class="block">Returns a string representing the week (e.g.</div>
  350. </td>
  351. </tr>
  352. </table>
  353. <ul class="blockList">
  354. <li class="blockList"><a name="methods.inherited.from.class.org.jfree.data.time.RegularTimePeriod">
  355. <!-- -->
  356. </a>
  357. <h3>Methods inherited from class&nbsp;org.jfree.data.time.<a href="../../../../org/jfree/data/time/RegularTimePeriod.html" title="class in org.jfree.data.time">RegularTimePeriod</a></h3>
  358. <code><a href="../../../../org/jfree/data/time/RegularTimePeriod.html#createInstance-java.lang.Class-java.util.Date-java.util.TimeZone-">createInstance</a>, <a href="../../../../org/jfree/data/time/RegularTimePeriod.html#downsize-java.lang.Class-">downsize</a>, <a href="../../../../org/jfree/data/time/RegularTimePeriod.html#getEnd--">getEnd</a>, <a href="../../../../org/jfree/data/time/RegularTimePeriod.html#getFirstMillisecond-java.util.TimeZone-">getFirstMillisecond</a>, <a href="../../../../org/jfree/data/time/RegularTimePeriod.html#getLastMillisecond-java.util.TimeZone-">getLastMillisecond</a>, <a href="../../../../org/jfree/data/time/RegularTimePeriod.html#getMiddleMillisecond--">getMiddleMillisecond</a>, <a href="../../../../org/jfree/data/time/RegularTimePeriod.html#getMiddleMillisecond-java.util.Calendar-">getMiddleMillisecond</a>, <a href="../../../../org/jfree/data/time/RegularTimePeriod.html#getMiddleMillisecond-java.util.TimeZone-">getMiddleMillisecond</a>, <a href="../../../../org/jfree/data/time/RegularTimePeriod.html#getMillisecond-org.jfree.data.time.TimePeriodAnchor-java.util.Calendar-">getMillisecond</a>, <a href="../../../../org/jfree/data/time/RegularTimePeriod.html#getStart--">getStart</a></code></li>
  359. </ul>
  360. <ul class="blockList">
  361. <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
  362. <!-- -->
  363. </a>
  364. <h3>Methods inherited from class&nbsp;java.lang.Object</h3>
  365. <code>clone, finalize, getClass, notify, notifyAll, wait, wait, wait</code></li>
  366. </ul>
  367. </li>
  368. </ul>
  369. </li>
  370. </ul>
  371. </div>
  372. <div class="details">
  373. <ul class="blockList">
  374. <li class="blockList">
  375. <!-- ============ FIELD DETAIL =========== -->
  376. <ul class="blockList">
  377. <li class="blockList"><a name="field.detail">
  378. <!-- -->
  379. </a>
  380. <h3>Field Detail</h3>
  381. <a name="FIRST_WEEK_IN_YEAR">
  382. <!-- -->
  383. </a>
  384. <ul class="blockList">
  385. <li class="blockList">
  386. <h4>FIRST_WEEK_IN_YEAR</h4>
  387. <pre>public static final&nbsp;int <a href="../../../../src-html/org/jfree/data/time/Week.html#line.100">FIRST_WEEK_IN_YEAR</a></pre>
  388. <div class="block">Constant for the first week in the year.</div>
  389. <dl>
  390. <dt><span class="seeLabel">See Also:</span></dt>
  391. <dd><a href="../../../../constant-values.html#org.jfree.data.time.Week.FIRST_WEEK_IN_YEAR">Constant Field Values</a></dd>
  392. </dl>
  393. </li>
  394. </ul>
  395. <a name="LAST_WEEK_IN_YEAR">
  396. <!-- -->
  397. </a>
  398. <ul class="blockListLast">
  399. <li class="blockList">
  400. <h4>LAST_WEEK_IN_YEAR</h4>
  401. <pre>public static final&nbsp;int <a href="../../../../src-html/org/jfree/data/time/Week.html#line.103">LAST_WEEK_IN_YEAR</a></pre>
  402. <div class="block">Constant for the last week in the year.</div>
  403. <dl>
  404. <dt><span class="seeLabel">See Also:</span></dt>
  405. <dd><a href="../../../../constant-values.html#org.jfree.data.time.Week.LAST_WEEK_IN_YEAR">Constant Field Values</a></dd>
  406. </dl>
  407. </li>
  408. </ul>
  409. </li>
  410. </ul>
  411. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  412. <ul class="blockList">
  413. <li class="blockList"><a name="constructor.detail">
  414. <!-- -->
  415. </a>
  416. <h3>Constructor Detail</h3>
  417. <a name="Week--">
  418. <!-- -->
  419. </a>
  420. <ul class="blockList">
  421. <li class="blockList">
  422. <h4>Week</h4>
  423. <pre>public&nbsp;<a href="../../../../src-html/org/jfree/data/time/Week.html#line.121">Week</a>()</pre>
  424. <div class="block">Creates a new time period for the week in which the current system
  425. date/time falls.</div>
  426. </li>
  427. </ul>
  428. <a name="Week-int-int-">
  429. <!-- -->
  430. </a>
  431. <ul class="blockList">
  432. <li class="blockList">
  433. <h4>Week</h4>
  434. <pre>public&nbsp;<a href="../../../../src-html/org/jfree/data/time/Week.html#line.131">Week</a>(int&nbsp;week,
  435. int&nbsp;year)</pre>
  436. <div class="block">Creates a time period representing the week in the specified year.</div>
  437. <dl>
  438. <dt><span class="paramLabel">Parameters:</span></dt>
  439. <dd><code>week</code> - the week (1 to 53).</dd>
  440. <dd><code>year</code> - the year (1900 to 9999).</dd>
  441. </dl>
  442. </li>
  443. </ul>
  444. <a name="Week-int-org.jfree.data.time.Year-">
  445. <!-- -->
  446. </a>
  447. <ul class="blockList">
  448. <li class="blockList">
  449. <h4>Week</h4>
  450. <pre>public&nbsp;<a href="../../../../src-html/org/jfree/data/time/Week.html#line.147">Week</a>(int&nbsp;week,
  451. <a href="../../../../org/jfree/data/time/Year.html" title="class in org.jfree.data.time">Year</a>&nbsp;year)</pre>
  452. <div class="block">Creates a time period representing the week in the specified year.</div>
  453. <dl>
  454. <dt><span class="paramLabel">Parameters:</span></dt>
  455. <dd><code>week</code> - the week (1 to 53).</dd>
  456. <dd><code>year</code> - the year (1900 to 9999).</dd>
  457. </dl>
  458. </li>
  459. </ul>
  460. <a name="Week-java.util.Date-">
  461. <!-- -->
  462. </a>
  463. <ul class="blockList">
  464. <li class="blockList">
  465. <h4>Week</h4>
  466. <pre>public&nbsp;<a href="../../../../src-html/org/jfree/data/time/Week.html#line.167">Week</a>(java.util.Date&nbsp;time)</pre>
  467. <div class="block">Creates a time period for the week in which the specified date/time
  468. falls, using the default time zone and locale (the locale can affect the
  469. day-of-the-week that marks the beginning of the week, as well as the
  470. minimal number of days in the first week of the year).</div>
  471. <dl>
  472. <dt><span class="paramLabel">Parameters:</span></dt>
  473. <dd><code>time</code> - the time (<code>null</code> not permitted).</dd>
  474. <dt><span class="seeLabel">See Also:</span></dt>
  475. <dd><a href="../../../../org/jfree/data/time/Week.html#Week-java.util.Date-java.util.TimeZone-java.util.Locale-"><code>Week(Date, TimeZone, Locale)</code></a></dd>
  476. </dl>
  477. </li>
  478. </ul>
  479. <a name="Week-java.util.Date-java.util.TimeZone-">
  480. <!-- -->
  481. </a>
  482. <ul class="blockList">
  483. <li class="blockList">
  484. <h4>Week</h4>
  485. <pre>public&nbsp;<a href="../../../../src-html/org/jfree/data/time/Week.html#line.181">Week</a>(java.util.Date&nbsp;time,
  486. java.util.TimeZone&nbsp;zone)</pre>
  487. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">As of 1.0.7, use <a href="../../../../org/jfree/data/time/Week.html#Week-java.util.Date-java.util.TimeZone-java.util.Locale-"><code>Week(Date, TimeZone, Locale)</code></a>.</span></div>
  488. <div class="block">Creates a time period for the week in which the specified date/time
  489. falls, calculated relative to the specified time zone.</div>
  490. <dl>
  491. <dt><span class="paramLabel">Parameters:</span></dt>
  492. <dd><code>time</code> - the date/time (<code>null</code> not permitted).</dd>
  493. <dd><code>zone</code> - the time zone (<code>null</code> not permitted).</dd>
  494. </dl>
  495. </li>
  496. </ul>
  497. <a name="Week-java.util.Date-java.util.TimeZone-java.util.Locale-">
  498. <!-- -->
  499. </a>
  500. <ul class="blockListLast">
  501. <li class="blockList">
  502. <h4>Week</h4>
  503. <pre>public&nbsp;<a href="../../../../src-html/org/jfree/data/time/Week.html#line.196">Week</a>(java.util.Date&nbsp;time,
  504. java.util.TimeZone&nbsp;zone,
  505. java.util.Locale&nbsp;locale)</pre>
  506. <div class="block">Creates a time period for the week in which the specified date/time
  507. falls, calculated relative to the specified time zone.</div>
  508. <dl>
  509. <dt><span class="paramLabel">Parameters:</span></dt>
  510. <dd><code>time</code> - the date/time (<code>null</code> not permitted).</dd>
  511. <dd><code>zone</code> - the time zone (<code>null</code> not permitted).</dd>
  512. <dd><code>locale</code> - the locale (<code>null</code> not permitted).</dd>
  513. <dt><span class="simpleTagLabel">Since:</span></dt>
  514. <dd>1.0.7</dd>
  515. </dl>
  516. </li>
  517. </ul>
  518. </li>
  519. </ul>
  520. <!-- ============ METHOD DETAIL ========== -->
  521. <ul class="blockList">
  522. <li class="blockList"><a name="method.detail">
  523. <!-- -->
  524. </a>
  525. <h3>Method Detail</h3>
  526. <a name="getYear--">
  527. <!-- -->
  528. </a>
  529. <ul class="blockList">
  530. <li class="blockList">
  531. <h4>getYear</h4>
  532. <pre>public&nbsp;<a href="../../../../org/jfree/data/time/Year.html" title="class in org.jfree.data.time">Year</a>&nbsp;<a href="../../../../src-html/org/jfree/data/time/Week.html#line.231">getYear</a>()</pre>
  533. <div class="block">Returns the year in which the week falls.</div>
  534. <dl>
  535. <dt><span class="returnLabel">Returns:</span></dt>
  536. <dd>The year (never <code>null</code>).</dd>
  537. </dl>
  538. </li>
  539. </ul>
  540. <a name="getYearValue--">
  541. <!-- -->
  542. </a>
  543. <ul class="blockList">
  544. <li class="blockList">
  545. <h4>getYearValue</h4>
  546. <pre>public&nbsp;int&nbsp;<a href="../../../../src-html/org/jfree/data/time/Week.html#line.240">getYearValue</a>()</pre>
  547. <div class="block">Returns the year in which the week falls, as an integer value.</div>
  548. <dl>
  549. <dt><span class="returnLabel">Returns:</span></dt>
  550. <dd>The year.</dd>
  551. </dl>
  552. </li>
  553. </ul>
  554. <a name="getWeek--">
  555. <!-- -->
  556. </a>
  557. <ul class="blockList">
  558. <li class="blockList">
  559. <h4>getWeek</h4>
  560. <pre>public&nbsp;int&nbsp;<a href="../../../../src-html/org/jfree/data/time/Week.html#line.249">getWeek</a>()</pre>
  561. <div class="block">Returns the week.</div>
  562. <dl>
  563. <dt><span class="returnLabel">Returns:</span></dt>
  564. <dd>The week.</dd>
  565. </dl>
  566. </li>
  567. </ul>
  568. <a name="getFirstMillisecond--">
  569. <!-- -->
  570. </a>
  571. <ul class="blockList">
  572. <li class="blockList">
  573. <h4>getFirstMillisecond</h4>
  574. <pre>public&nbsp;long&nbsp;<a href="../../../../src-html/org/jfree/data/time/Week.html#line.264">getFirstMillisecond</a>()</pre>
  575. <div class="block">Returns the first millisecond of the week. This will be determined
  576. relative to the time zone specified in the constructor, or in the
  577. calendar instance passed in the most recent call to the
  578. <a href="../../../../org/jfree/data/time/Week.html#peg-java.util.Calendar-"><code>peg(Calendar)</code></a> method.</div>
  579. <dl>
  580. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  581. <dd><code><a href="../../../../org/jfree/data/time/RegularTimePeriod.html#getFirstMillisecond--">getFirstMillisecond</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/jfree/data/time/RegularTimePeriod.html" title="class in org.jfree.data.time">RegularTimePeriod</a></code></dd>
  582. <dt><span class="returnLabel">Returns:</span></dt>
  583. <dd>The first millisecond of the week.</dd>
  584. <dt><span class="seeLabel">See Also:</span></dt>
  585. <dd><a href="../../../../org/jfree/data/time/Week.html#getLastMillisecond--"><code>getLastMillisecond()</code></a></dd>
  586. </dl>
  587. </li>
  588. </ul>
  589. <a name="getLastMillisecond--">
  590. <!-- -->
  591. </a>
  592. <ul class="blockList">
  593. <li class="blockList">
  594. <h4>getLastMillisecond</h4>
  595. <pre>public&nbsp;long&nbsp;<a href="../../../../src-html/org/jfree/data/time/Week.html#line.279">getLastMillisecond</a>()</pre>
  596. <div class="block">Returns the last millisecond of the week. This will be
  597. determined relative to the time zone specified in the constructor, or
  598. in the calendar instance passed in the most recent call to the
  599. <a href="../../../../org/jfree/data/time/Week.html#peg-java.util.Calendar-"><code>peg(Calendar)</code></a> method.</div>
  600. <dl>
  601. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  602. <dd><code><a href="../../../../org/jfree/data/time/RegularTimePeriod.html#getLastMillisecond--">getLastMillisecond</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/jfree/data/time/RegularTimePeriod.html" title="class in org.jfree.data.time">RegularTimePeriod</a></code></dd>
  603. <dt><span class="returnLabel">Returns:</span></dt>
  604. <dd>The last millisecond of the week.</dd>
  605. <dt><span class="seeLabel">See Also:</span></dt>
  606. <dd><a href="../../../../org/jfree/data/time/Week.html#getFirstMillisecond--"><code>getFirstMillisecond()</code></a></dd>
  607. </dl>
  608. </li>
  609. </ul>
  610. <a name="peg-java.util.Calendar-">
  611. <!-- -->
  612. </a>
  613. <ul class="blockList">
  614. <li class="blockList">
  615. <h4>peg</h4>
  616. <pre>public&nbsp;void&nbsp;<a href="../../../../src-html/org/jfree/data/time/Week.html#line.292">peg</a>(java.util.Calendar&nbsp;calendar)</pre>
  617. <div class="block">Recalculates the start date/time and end date/time for this time period
  618. relative to the supplied calendar (which incorporates a time zone).</div>
  619. <dl>
  620. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  621. <dd><code><a href="../../../../org/jfree/data/time/RegularTimePeriod.html#peg-java.util.Calendar-">peg</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/jfree/data/time/RegularTimePeriod.html" title="class in org.jfree.data.time">RegularTimePeriod</a></code></dd>
  622. <dt><span class="paramLabel">Parameters:</span></dt>
  623. <dd><code>calendar</code> - the calendar (<code>null</code> not permitted).</dd>
  624. <dt><span class="simpleTagLabel">Since:</span></dt>
  625. <dd>1.0.3</dd>
  626. </dl>
  627. </li>
  628. </ul>
  629. <a name="previous--">
  630. <!-- -->
  631. </a>
  632. <ul class="blockList">
  633. <li class="blockList">
  634. <h4>previous</h4>
  635. <pre>public&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/Week.html#line.306">previous</a>()</pre>
  636. <div class="block">Returns the week preceding this one. This method will return
  637. <code>null</code> for some lower limit on the range of weeks (currently
  638. week 1, 1900). For week 1 of any year, the previous week is always week
  639. 53, but week 53 may not contain any days (you should check for this).</div>
  640. <dl>
  641. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  642. <dd><code><a href="../../../../org/jfree/data/time/RegularTimePeriod.html#previous--">previous</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/jfree/data/time/RegularTimePeriod.html" title="class in org.jfree.data.time">RegularTimePeriod</a></code></dd>
  643. <dt><span class="returnLabel">Returns:</span></dt>
  644. <dd>The preceding week (possibly <code>null</code>).</dd>
  645. </dl>
  646. </li>
  647. </ul>
  648. <a name="next--">
  649. <!-- -->
  650. </a>
  651. <ul class="blockList">
  652. <li class="blockList">
  653. <h4>next</h4>
  654. <pre>public&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/Week.html#line.339">next</a>()</pre>
  655. <div class="block">Returns the week following this one. This method will return
  656. <code>null</code> for some upper limit on the range of weeks (currently
  657. week 53, 9999). For week 52 of any year, the following week is always
  658. week 53, but week 53 may not contain any days (you should check for
  659. this).</div>
  660. <dl>
  661. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  662. <dd><code><a href="../../../../org/jfree/data/time/RegularTimePeriod.html#next--">next</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/jfree/data/time/RegularTimePeriod.html" title="class in org.jfree.data.time">RegularTimePeriod</a></code></dd>
  663. <dt><span class="returnLabel">Returns:</span></dt>
  664. <dd>The following week (possibly <code>null</code>).</dd>
  665. </dl>
  666. </li>
  667. </ul>
  668. <a name="getSerialIndex--">
  669. <!-- -->
  670. </a>
  671. <ul class="blockList">
  672. <li class="blockList">
  673. <h4>getSerialIndex</h4>
  674. <pre>public&nbsp;long&nbsp;<a href="../../../../src-html/org/jfree/data/time/Week.html#line.372">getSerialIndex</a>()</pre>
  675. <div class="block">Returns a serial index number for the week.</div>
  676. <dl>
  677. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  678. <dd><code><a href="../../../../org/jfree/data/time/RegularTimePeriod.html#getSerialIndex--">getSerialIndex</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/jfree/data/time/RegularTimePeriod.html" title="class in org.jfree.data.time">RegularTimePeriod</a></code></dd>
  679. <dt><span class="returnLabel">Returns:</span></dt>
  680. <dd>The serial index number.</dd>
  681. </dl>
  682. </li>
  683. </ul>
  684. <a name="getFirstMillisecond-java.util.Calendar-">
  685. <!-- -->
  686. </a>
  687. <ul class="blockList">
  688. <li class="blockList">
  689. <h4>getFirstMillisecond</h4>
  690. <pre>public&nbsp;long&nbsp;<a href="../../../../src-html/org/jfree/data/time/Week.html#line.388">getFirstMillisecond</a>(java.util.Calendar&nbsp;calendar)</pre>
  691. <div class="block">Returns the first millisecond of the week, evaluated using the supplied
  692. calendar (which determines the time zone).</div>
  693. <dl>
  694. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  695. <dd><code><a href="../../../../org/jfree/data/time/RegularTimePeriod.html#getFirstMillisecond-java.util.Calendar-">getFirstMillisecond</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/jfree/data/time/RegularTimePeriod.html" title="class in org.jfree.data.time">RegularTimePeriod</a></code></dd>
  696. <dt><span class="paramLabel">Parameters:</span></dt>
  697. <dd><code>calendar</code> - the calendar (<code>null</code> not permitted).</dd>
  698. <dt><span class="returnLabel">Returns:</span></dt>
  699. <dd>The first millisecond of the week.</dd>
  700. <dt><span class="throwsLabel">Throws:</span></dt>
  701. <dd><code>java.lang.NullPointerException</code> - if <code>calendar</code> is
  702. <code>null</code>.</dd>
  703. <dt><span class="seeLabel">See Also:</span></dt>
  704. <dd><a href="../../../../org/jfree/data/time/RegularTimePeriod.html#getLastMillisecond-java.util.Calendar-"><code>RegularTimePeriod.getLastMillisecond(Calendar)</code></a></dd>
  705. </dl>
  706. </li>
  707. </ul>
  708. <a name="getLastMillisecond-java.util.Calendar-">
  709. <!-- -->
  710. </a>
  711. <ul class="blockList">
  712. <li class="blockList">
  713. <h4>getLastMillisecond</h4>
  714. <pre>public&nbsp;long&nbsp;<a href="../../../../src-html/org/jfree/data/time/Week.html#line.413">getLastMillisecond</a>(java.util.Calendar&nbsp;calendar)</pre>
  715. <div class="block">Returns the last millisecond of the week, evaluated using the supplied
  716. calendar (which determines the time zone).</div>
  717. <dl>
  718. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  719. <dd><code><a href="../../../../org/jfree/data/time/RegularTimePeriod.html#getLastMillisecond-java.util.Calendar-">getLastMillisecond</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/jfree/data/time/RegularTimePeriod.html" title="class in org.jfree.data.time">RegularTimePeriod</a></code></dd>
  720. <dt><span class="paramLabel">Parameters:</span></dt>
  721. <dd><code>calendar</code> - the calendar (<code>null</code> not permitted).</dd>
  722. <dt><span class="returnLabel">Returns:</span></dt>
  723. <dd>The last millisecond of the week.</dd>
  724. <dt><span class="throwsLabel">Throws:</span></dt>
  725. <dd><code>java.lang.NullPointerException</code> - if <code>calendar</code> is
  726. <code>null</code>.</dd>
  727. <dt><span class="seeLabel">See Also:</span></dt>
  728. <dd><a href="../../../../org/jfree/data/time/RegularTimePeriod.html#getFirstMillisecond-java.util.Calendar-"><code>RegularTimePeriod.getFirstMillisecond(Calendar)</code></a></dd>
  729. </dl>
  730. </li>
  731. </ul>
  732. <a name="toString--">
  733. <!-- -->
  734. </a>
  735. <ul class="blockList">
  736. <li class="blockList">
  737. <h4>toString</h4>
  738. <pre>public&nbsp;java.lang.String&nbsp;<a href="../../../../src-html/org/jfree/data/time/Week.html#line.434">toString</a>()</pre>
  739. <div class="block">Returns a string representing the week (e.g. "Week 9, 2002").
  740. TODO: look at internationalisation.</div>
  741. <dl>
  742. <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
  743. <dd><code><a href="../../../../org/jfree/data/time/RegularTimePeriod.html#toString--">toString</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/jfree/data/time/RegularTimePeriod.html" title="class in org.jfree.data.time">RegularTimePeriod</a></code></dd>
  744. <dt><span class="returnLabel">Returns:</span></dt>
  745. <dd>A string representing the week.</dd>
  746. </dl>
  747. </li>
  748. </ul>
  749. <a name="equals-java.lang.Object-">
  750. <!-- -->
  751. </a>
  752. <ul class="blockList">
  753. <li class="blockList">
  754. <h4>equals</h4>
  755. <pre>public&nbsp;boolean&nbsp;<a href="../../../../src-html/org/jfree/data/time/Week.html#line.449">equals</a>(java.lang.Object&nbsp;obj)</pre>
  756. <div class="block">Tests the equality of this Week object to an arbitrary object. Returns
  757. true if the target is a Week instance representing the same week as this
  758. object. In all other cases, returns false.</div>
  759. <dl>
  760. <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
  761. <dd><code>equals</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
  762. <dt><span class="paramLabel">Parameters:</span></dt>
  763. <dd><code>obj</code> - the object (<code>null</code> permitted).</dd>
  764. <dt><span class="returnLabel">Returns:</span></dt>
  765. <dd><code>true</code> if week and year of this and object are the
  766. same.</dd>
  767. </dl>
  768. </li>
  769. </ul>
  770. <a name="hashCode--">
  771. <!-- -->
  772. </a>
  773. <ul class="blockList">
  774. <li class="blockList">
  775. <h4>hashCode</h4>
  776. <pre>public&nbsp;int&nbsp;<a href="../../../../src-html/org/jfree/data/time/Week.html#line.478">hashCode</a>()</pre>
  777. <div class="block">Returns a hash code for this object instance. The approach described by
  778. Joshua Bloch in "Effective Java" has been used here:
  779. <p>
  780. <code>http://developer.java.sun.com/developer/Books/effectivejava
  781. /Chapter3.pdf</code></div>
  782. <dl>
  783. <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
  784. <dd><code>hashCode</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
  785. <dt><span class="returnLabel">Returns:</span></dt>
  786. <dd>A hash code.</dd>
  787. </dl>
  788. </li>
  789. </ul>
  790. <a name="compareTo-java.lang.Object-">
  791. <!-- -->
  792. </a>
  793. <ul class="blockList">
  794. <li class="blockList">
  795. <h4>compareTo</h4>
  796. <pre>public&nbsp;int&nbsp;<a href="../../../../src-html/org/jfree/data/time/Week.html#line.496">compareTo</a>(java.lang.Object&nbsp;o1)</pre>
  797. <div class="block">Returns an integer indicating the order of this Week object relative to
  798. the specified object:
  799. negative == before, zero == same, positive == after.</div>
  800. <dl>
  801. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  802. <dd><code>compareTo</code>&nbsp;in interface&nbsp;<code>java.lang.Comparable</code></dd>
  803. <dt><span class="paramLabel">Parameters:</span></dt>
  804. <dd><code>o1</code> - the object to compare.</dd>
  805. <dt><span class="returnLabel">Returns:</span></dt>
  806. <dd>negative == before, zero == same, positive == after.</dd>
  807. </dl>
  808. </li>
  809. </ul>
  810. <a name="parseWeek-java.lang.String-">
  811. <!-- -->
  812. </a>
  813. <ul class="blockListLast">
  814. <li class="blockList">
  815. <h4>parseWeek</h4>
  816. <pre>public static&nbsp;<a href="../../../../org/jfree/data/time/Week.html" title="class in org.jfree.data.time">Week</a>&nbsp;<a href="../../../../src-html/org/jfree/data/time/Week.html#line.539">parseWeek</a>(java.lang.String&nbsp;s)</pre>
  817. <div class="block">Parses the string argument as a week.
  818. <P>
  819. This method is required to accept the format "YYYY-Wnn". It will also
  820. accept "Wnn-YYYY". Anything else, at the moment, is a bonus.</div>
  821. <dl>
  822. <dt><span class="paramLabel">Parameters:</span></dt>
  823. <dd><code>s</code> - string to parse.</dd>
  824. <dt><span class="returnLabel">Returns:</span></dt>
  825. <dd><code>null</code> if the string is not parseable, the week
  826. otherwise.</dd>
  827. </dl>
  828. </li>
  829. </ul>
  830. </li>
  831. </ul>
  832. </li>
  833. </ul>
  834. </div>
  835. </div>
  836. <!-- ========= END OF CLASS DATA ========= -->
  837. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  838. <div class="bottomNav"><a name="navbar.bottom">
  839. <!-- -->
  840. </a>
  841. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  842. <a name="navbar.bottom.firstrow">
  843. <!-- -->
  844. </a>
  845. <ul class="navList" title="Navigation">
  846. <li><a href="../../../../overview-summary.html">Overview</a></li>
  847. <li><a href="package-summary.html">Package</a></li>
  848. <li class="navBarCell1Rev">Class</li>
  849. <li><a href="class-use/Week.html">Use</a></li>
  850. <li><a href="package-tree.html">Tree</a></li>
  851. <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
  852. <li><a href="../../../../index-files/index-1.html">Index</a></li>
  853. <li><a href="../../../../help-doc.html">Help</a></li>
  854. </ul>
  855. </div>
  856. <div class="subNav">
  857. <ul class="navList">
  858. <li><a href="../../../../org/jfree/data/time/TimeTableXYDataset.html" title="class in org.jfree.data.time"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  859. <li><a href="../../../../org/jfree/data/time/Year.html" title="class in org.jfree.data.time"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  860. </ul>
  861. <ul class="navList">
  862. <li><a href="../../../../index.html?org/jfree/data/time/Week.html" target="_top">Frames</a></li>
  863. <li><a href="Week.html" target="_top">No&nbsp;Frames</a></li>
  864. </ul>
  865. <ul class="navList" id="allclasses_navbar_bottom">
  866. <li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  867. </ul>
  868. <div>
  869. <script type="text/javascript"><!--
  870. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  871. if(window==top) {
  872. allClassesLink.style.display = "block";
  873. }
  874. else {
  875. allClassesLink.style.display = "none";
  876. }
  877. //-->
  878. </script>
  879. </div>
  880. <div>
  881. <ul class="subNavList">
  882. <li>Summary:&nbsp;</li>
  883. <li>Nested&nbsp;|&nbsp;</li>
  884. <li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
  885. <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
  886. <li><a href="#method.summary">Method</a></li>
  887. </ul>
  888. <ul class="subNavList">
  889. <li>Detail:&nbsp;</li>
  890. <li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
  891. <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
  892. <li><a href="#method.detail">Method</a></li>
  893. </ul>
  894. </div>
  895. <a name="skip.navbar.bottom">
  896. <!-- -->
  897. </a></div>
  898. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  899. </body>
  900. </html>