123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903 |
- <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
- <!-- NewPage -->
- <html lang="en">
- <head>
- <!-- Generated by javadoc (1.8.0_05) on Thu Jul 31 14:50:43 CEST 2014 -->
- <title>Week (JFreeChart Class Library (version 1.0.19-fx))</title>
- <meta name="date" content="2014-07-31">
- <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
- <script type="text/javascript" src="../../../../script.js"></script>
- </head>
- <body>
- <script type="text/javascript"><!--
- try {
- if (location.href.indexOf('is-external=true') == -1) {
- parent.document.title="Week (JFreeChart Class Library (version 1.0.19-fx))";
- }
- }
- catch(err) {
- }
- //-->
- 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};
- var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
- var altColor = "altColor";
- var rowColor = "rowColor";
- var tableTab = "tableTab";
- var activeTableTab = "activeTableTab";
- </script>
- <noscript>
- <div>JavaScript is disabled on your browser.</div>
- </noscript>
- <!-- ========= START OF TOP NAVBAR ======= -->
- <div class="topNav"><a name="navbar.top">
- <!-- -->
- </a>
- <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
- <a name="navbar.top.firstrow">
- <!-- -->
- </a>
- <ul class="navList" title="Navigation">
- <li><a href="../../../../overview-summary.html">Overview</a></li>
- <li><a href="package-summary.html">Package</a></li>
- <li class="navBarCell1Rev">Class</li>
- <li><a href="class-use/Week.html">Use</a></li>
- <li><a href="package-tree.html">Tree</a></li>
- <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
- <li><a href="../../../../index-files/index-1.html">Index</a></li>
- <li><a href="../../../../help-doc.html">Help</a></li>
- </ul>
- </div>
- <div class="subNav">
- <ul class="navList">
- <li><a href="../../../../org/jfree/data/time/TimeTableXYDataset.html" title="class in org.jfree.data.time"><span class="typeNameLink">Prev Class</span></a></li>
- <li><a href="../../../../org/jfree/data/time/Year.html" title="class in org.jfree.data.time"><span class="typeNameLink">Next Class</span></a></li>
- </ul>
- <ul class="navList">
- <li><a href="../../../../index.html?org/jfree/data/time/Week.html" target="_top">Frames</a></li>
- <li><a href="Week.html" target="_top">No Frames</a></li>
- </ul>
- <ul class="navList" id="allclasses_navbar_top">
- <li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
- </ul>
- <div>
- <script type="text/javascript"><!--
- allClassesLink = document.getElementById("allclasses_navbar_top");
- if(window==top) {
- allClassesLink.style.display = "block";
- }
- else {
- allClassesLink.style.display = "none";
- }
- //-->
- </script>
- </div>
- <div>
- <ul class="subNavList">
- <li>Summary: </li>
- <li>Nested | </li>
- <li><a href="#field.summary">Field</a> | </li>
- <li><a href="#constructor.summary">Constr</a> | </li>
- <li><a href="#method.summary">Method</a></li>
- </ul>
- <ul class="subNavList">
- <li>Detail: </li>
- <li><a href="#field.detail">Field</a> | </li>
- <li><a href="#constructor.detail">Constr</a> | </li>
- <li><a href="#method.detail">Method</a></li>
- </ul>
- </div>
- <a name="skip.navbar.top">
- <!-- -->
- </a></div>
- <!-- ========= END OF TOP NAVBAR ========= -->
- <!-- ======== START OF CLASS DATA ======== -->
- <div class="header">
- <div class="subTitle">org.jfree.data.time</div>
- <h2 title="Class Week" class="title">Class Week</h2>
- </div>
- <div class="contentContainer">
- <ul class="inheritance">
- <li>java.lang.Object</li>
- <li>
- <ul class="inheritance">
- <li><a href="../../../../org/jfree/data/time/RegularTimePeriod.html" title="class in org.jfree.data.time">org.jfree.data.time.RegularTimePeriod</a></li>
- <li>
- <ul class="inheritance">
- <li>org.jfree.data.time.Week</li>
- </ul>
- </li>
- </ul>
- </li>
- </ul>
- <div class="description">
- <ul class="blockList">
- <li class="blockList">
- <dl>
- <dt>All Implemented Interfaces:</dt>
- <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>
- </dl>
- <hr>
- <br>
- <pre>public class <a href="../../../../src-html/org/jfree/data/time/Week.html#line.94">Week</a>
- extends <a href="../../../../org/jfree/data/time/RegularTimePeriod.html" title="class in org.jfree.data.time">RegularTimePeriod</a>
- implements java.io.Serializable</pre>
- <div class="block">A calendar week. All years are considered to have 53 weeks, numbered from 1
- to 53, although in many cases the 53rd week is empty. Most of the time, the
- 1st week of the year *begins* in the previous calendar year, but it always
- finishes in the current year (this behaviour matches the workings of the
- <code>GregorianCalendar</code> class).
- <P>
- This class is immutable, which is a requirement for all
- <a href="../../../../org/jfree/data/time/RegularTimePeriod.html" title="class in org.jfree.data.time"><code>RegularTimePeriod</code></a> subclasses.</div>
- <dl>
- <dt><span class="seeLabel">See Also:</span></dt>
- <dd><a href="../../../../serialized-form.html#org.jfree.data.time.Week">Serialized Form</a></dd>
- </dl>
- </li>
- </ul>
- </div>
- <div class="summary">
- <ul class="blockList">
- <li class="blockList">
- <!-- =========== FIELD SUMMARY =========== -->
- <ul class="blockList">
- <li class="blockList"><a name="field.summary">
- <!-- -->
- </a>
- <h3>Field Summary</h3>
- <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
- <caption><span>Fields</span><span class="tabEnd"> </span></caption>
- <tr>
- <th class="colFirst" scope="col">Modifier and Type</th>
- <th class="colLast" scope="col">Field and Description</th>
- </tr>
- <tr class="altColor">
- <td class="colFirst"><code>static int</code></td>
- <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>
- <div class="block">Constant for the first week in the year.</div>
- </td>
- </tr>
- <tr class="rowColor">
- <td class="colFirst"><code>static int</code></td>
- <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>
- <div class="block">Constant for the last week in the year.</div>
- </td>
- </tr>
- </table>
- <ul class="blockList">
- <li class="blockList"><a name="fields.inherited.from.class.org.jfree.data.time.RegularTimePeriod">
- <!-- -->
- </a>
- <h3>Fields inherited from class org.jfree.data.time.<a href="../../../../org/jfree/data/time/RegularTimePeriod.html" title="class in org.jfree.data.time">RegularTimePeriod</a></h3>
- <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>
- </ul>
- <ul class="blockList">
- <li class="blockList"><a name="fields.inherited.from.class.org.jfree.date.MonthConstants">
- <!-- -->
- </a>
- <h3>Fields inherited from interface org.jfree.date.MonthConstants</h3>
- <code>APRIL, AUGUST, DECEMBER, FEBRUARY, JANUARY, JULY, JUNE, MARCH, MAY, NOVEMBER, OCTOBER, SEPTEMBER</code></li>
- </ul>
- </li>
- </ul>
- <!-- ======== CONSTRUCTOR SUMMARY ======== -->
- <ul class="blockList">
- <li class="blockList"><a name="constructor.summary">
- <!-- -->
- </a>
- <h3>Constructor Summary</h3>
- <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
- <caption><span>Constructors</span><span class="tabEnd"> </span></caption>
- <tr>
- <th class="colOne" scope="col">Constructor and Description</th>
- </tr>
- <tr class="altColor">
- <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/time/Week.html#Week--">Week</a></span>()</code>
- <div class="block">Creates a new time period for the week in which the current system
- date/time falls.</div>
- </td>
- </tr>
- <tr class="rowColor">
- <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 time)</code>
- <div class="block">Creates a time period for the week in which the specified date/time
- falls, using the default time zone and locale (the locale can affect the
- day-of-the-week that marks the beginning of the week, as well as the
- minimal number of days in the first week of the year).</div>
- </td>
- </tr>
- <tr class="altColor">
- <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 time,
- java.util.TimeZone zone)</code>
- <div class="block"><span class="deprecatedLabel">Deprecated.</span>
- <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>
- </div>
- </td>
- </tr>
- <tr class="rowColor">
- <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 time,
- java.util.TimeZone zone,
- java.util.Locale locale)</code>
- <div class="block">Creates a time period for the week in which the specified date/time
- falls, calculated relative to the specified time zone.</div>
- </td>
- </tr>
- <tr class="altColor">
- <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/time/Week.html#Week-int-int-">Week</a></span>(int week,
- int year)</code>
- <div class="block">Creates a time period representing the week in the specified year.</div>
- </td>
- </tr>
- <tr class="rowColor">
- <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 week,
- <a href="../../../../org/jfree/data/time/Year.html" title="class in org.jfree.data.time">Year</a> year)</code>
- <div class="block">Creates a time period representing the week in the specified year.</div>
- </td>
- </tr>
- </table>
- </li>
- </ul>
- <!-- ========== METHOD SUMMARY =========== -->
- <ul class="blockList">
- <li class="blockList"><a name="method.summary">
- <!-- -->
- </a>
- <h3>Method Summary</h3>
- <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
- <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption>
- <tr>
- <th class="colFirst" scope="col">Modifier and Type</th>
- <th class="colLast" scope="col">Method and Description</th>
- </tr>
- <tr id="i0" class="altColor">
- <td class="colFirst"><code>int</code></td>
- <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 o1)</code>
- <div class="block">Returns an integer indicating the order of this Week object relative to
- the specified object:
- negative == before, zero == same, positive == after.</div>
- </td>
- </tr>
- <tr id="i1" class="rowColor">
- <td class="colFirst"><code>boolean</code></td>
- <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 obj)</code>
- <div class="block">Tests the equality of this Week object to an arbitrary object.</div>
- </td>
- </tr>
- <tr id="i2" class="altColor">
- <td class="colFirst"><code>long</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/time/Week.html#getFirstMillisecond--">getFirstMillisecond</a></span>()</code>
- <div class="block">Returns the first millisecond of the week.</div>
- </td>
- </tr>
- <tr id="i3" class="rowColor">
- <td class="colFirst"><code>long</code></td>
- <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 calendar)</code>
- <div class="block">Returns the first millisecond of the week, evaluated using the supplied
- calendar (which determines the time zone).</div>
- </td>
- </tr>
- <tr id="i4" class="altColor">
- <td class="colFirst"><code>long</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/time/Week.html#getLastMillisecond--">getLastMillisecond</a></span>()</code>
- <div class="block">Returns the last millisecond of the week.</div>
- </td>
- </tr>
- <tr id="i5" class="rowColor">
- <td class="colFirst"><code>long</code></td>
- <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 calendar)</code>
- <div class="block">Returns the last millisecond of the week, evaluated using the supplied
- calendar (which determines the time zone).</div>
- </td>
- </tr>
- <tr id="i6" class="altColor">
- <td class="colFirst"><code>long</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/time/Week.html#getSerialIndex--">getSerialIndex</a></span>()</code>
- <div class="block">Returns a serial index number for the week.</div>
- </td>
- </tr>
- <tr id="i7" class="rowColor">
- <td class="colFirst"><code>int</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/time/Week.html#getWeek--">getWeek</a></span>()</code>
- <div class="block">Returns the week.</div>
- </td>
- </tr>
- <tr id="i8" class="altColor">
- <td class="colFirst"><code><a href="../../../../org/jfree/data/time/Year.html" title="class in org.jfree.data.time">Year</a></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/time/Week.html#getYear--">getYear</a></span>()</code>
- <div class="block">Returns the year in which the week falls.</div>
- </td>
- </tr>
- <tr id="i9" class="rowColor">
- <td class="colFirst"><code>int</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/time/Week.html#getYearValue--">getYearValue</a></span>()</code>
- <div class="block">Returns the year in which the week falls, as an integer value.</div>
- </td>
- </tr>
- <tr id="i10" class="altColor">
- <td class="colFirst"><code>int</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/time/Week.html#hashCode--">hashCode</a></span>()</code>
- <div class="block">Returns a hash code for this object instance.</div>
- </td>
- </tr>
- <tr id="i11" class="rowColor">
- <td class="colFirst"><code><a href="../../../../org/jfree/data/time/RegularTimePeriod.html" title="class in org.jfree.data.time">RegularTimePeriod</a></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/time/Week.html#next--">next</a></span>()</code>
- <div class="block">Returns the week following this one.</div>
- </td>
- </tr>
- <tr id="i12" class="altColor">
- <td class="colFirst"><code>static <a href="../../../../org/jfree/data/time/Week.html" title="class in org.jfree.data.time">Week</a></code></td>
- <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 s)</code>
- <div class="block">Parses the string argument as a week.</div>
- </td>
- </tr>
- <tr id="i13" class="rowColor">
- <td class="colFirst"><code>void</code></td>
- <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 calendar)</code>
- <div class="block">Recalculates the start date/time and end date/time for this time period
- relative to the supplied calendar (which incorporates a time zone).</div>
- </td>
- </tr>
- <tr id="i14" class="altColor">
- <td class="colFirst"><code><a href="../../../../org/jfree/data/time/RegularTimePeriod.html" title="class in org.jfree.data.time">RegularTimePeriod</a></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/time/Week.html#previous--">previous</a></span>()</code>
- <div class="block">Returns the week preceding this one.</div>
- </td>
- </tr>
- <tr id="i15" class="rowColor">
- <td class="colFirst"><code>java.lang.String</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/time/Week.html#toString--">toString</a></span>()</code>
- <div class="block">Returns a string representing the week (e.g.</div>
- </td>
- </tr>
- </table>
- <ul class="blockList">
- <li class="blockList"><a name="methods.inherited.from.class.org.jfree.data.time.RegularTimePeriod">
- <!-- -->
- </a>
- <h3>Methods inherited from class org.jfree.data.time.<a href="../../../../org/jfree/data/time/RegularTimePeriod.html" title="class in org.jfree.data.time">RegularTimePeriod</a></h3>
- <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>
- </ul>
- <ul class="blockList">
- <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
- <!-- -->
- </a>
- <h3>Methods inherited from class java.lang.Object</h3>
- <code>clone, finalize, getClass, notify, notifyAll, wait, wait, wait</code></li>
- </ul>
- </li>
- </ul>
- </li>
- </ul>
- </div>
- <div class="details">
- <ul class="blockList">
- <li class="blockList">
- <!-- ============ FIELD DETAIL =========== -->
- <ul class="blockList">
- <li class="blockList"><a name="field.detail">
- <!-- -->
- </a>
- <h3>Field Detail</h3>
- <a name="FIRST_WEEK_IN_YEAR">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>FIRST_WEEK_IN_YEAR</h4>
- <pre>public static final int <a href="../../../../src-html/org/jfree/data/time/Week.html#line.100">FIRST_WEEK_IN_YEAR</a></pre>
- <div class="block">Constant for the first week in the year.</div>
- <dl>
- <dt><span class="seeLabel">See Also:</span></dt>
- <dd><a href="../../../../constant-values.html#org.jfree.data.time.Week.FIRST_WEEK_IN_YEAR">Constant Field Values</a></dd>
- </dl>
- </li>
- </ul>
- <a name="LAST_WEEK_IN_YEAR">
- <!-- -->
- </a>
- <ul class="blockListLast">
- <li class="blockList">
- <h4>LAST_WEEK_IN_YEAR</h4>
- <pre>public static final int <a href="../../../../src-html/org/jfree/data/time/Week.html#line.103">LAST_WEEK_IN_YEAR</a></pre>
- <div class="block">Constant for the last week in the year.</div>
- <dl>
- <dt><span class="seeLabel">See Also:</span></dt>
- <dd><a href="../../../../constant-values.html#org.jfree.data.time.Week.LAST_WEEK_IN_YEAR">Constant Field Values</a></dd>
- </dl>
- </li>
- </ul>
- </li>
- </ul>
- <!-- ========= CONSTRUCTOR DETAIL ======== -->
- <ul class="blockList">
- <li class="blockList"><a name="constructor.detail">
- <!-- -->
- </a>
- <h3>Constructor Detail</h3>
- <a name="Week--">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>Week</h4>
- <pre>public <a href="../../../../src-html/org/jfree/data/time/Week.html#line.121">Week</a>()</pre>
- <div class="block">Creates a new time period for the week in which the current system
- date/time falls.</div>
- </li>
- </ul>
- <a name="Week-int-int-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>Week</h4>
- <pre>public <a href="../../../../src-html/org/jfree/data/time/Week.html#line.131">Week</a>(int week,
- int year)</pre>
- <div class="block">Creates a time period representing the week in the specified year.</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>week</code> - the week (1 to 53).</dd>
- <dd><code>year</code> - the year (1900 to 9999).</dd>
- </dl>
- </li>
- </ul>
- <a name="Week-int-org.jfree.data.time.Year-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>Week</h4>
- <pre>public <a href="../../../../src-html/org/jfree/data/time/Week.html#line.147">Week</a>(int week,
- <a href="../../../../org/jfree/data/time/Year.html" title="class in org.jfree.data.time">Year</a> year)</pre>
- <div class="block">Creates a time period representing the week in the specified year.</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>week</code> - the week (1 to 53).</dd>
- <dd><code>year</code> - the year (1900 to 9999).</dd>
- </dl>
- </li>
- </ul>
- <a name="Week-java.util.Date-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>Week</h4>
- <pre>public <a href="../../../../src-html/org/jfree/data/time/Week.html#line.167">Week</a>(java.util.Date time)</pre>
- <div class="block">Creates a time period for the week in which the specified date/time
- falls, using the default time zone and locale (the locale can affect the
- day-of-the-week that marks the beginning of the week, as well as the
- minimal number of days in the first week of the year).</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>time</code> - the time (<code>null</code> not permitted).</dd>
- <dt><span class="seeLabel">See Also:</span></dt>
- <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>
- </dl>
- </li>
- </ul>
- <a name="Week-java.util.Date-java.util.TimeZone-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>Week</h4>
- <pre>public <a href="../../../../src-html/org/jfree/data/time/Week.html#line.181">Week</a>(java.util.Date time,
- java.util.TimeZone zone)</pre>
- <div class="block"><span class="deprecatedLabel">Deprecated.</span> <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>
- <div class="block">Creates a time period for the week in which the specified date/time
- falls, calculated relative to the specified time zone.</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>time</code> - the date/time (<code>null</code> not permitted).</dd>
- <dd><code>zone</code> - the time zone (<code>null</code> not permitted).</dd>
- </dl>
- </li>
- </ul>
- <a name="Week-java.util.Date-java.util.TimeZone-java.util.Locale-">
- <!-- -->
- </a>
- <ul class="blockListLast">
- <li class="blockList">
- <h4>Week</h4>
- <pre>public <a href="../../../../src-html/org/jfree/data/time/Week.html#line.196">Week</a>(java.util.Date time,
- java.util.TimeZone zone,
- java.util.Locale locale)</pre>
- <div class="block">Creates a time period for the week in which the specified date/time
- falls, calculated relative to the specified time zone.</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>time</code> - the date/time (<code>null</code> not permitted).</dd>
- <dd><code>zone</code> - the time zone (<code>null</code> not permitted).</dd>
- <dd><code>locale</code> - the locale (<code>null</code> not permitted).</dd>
- <dt><span class="simpleTagLabel">Since:</span></dt>
- <dd>1.0.7</dd>
- </dl>
- </li>
- </ul>
- </li>
- </ul>
- <!-- ============ METHOD DETAIL ========== -->
- <ul class="blockList">
- <li class="blockList"><a name="method.detail">
- <!-- -->
- </a>
- <h3>Method Detail</h3>
- <a name="getYear--">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getYear</h4>
- <pre>public <a href="../../../../org/jfree/data/time/Year.html" title="class in org.jfree.data.time">Year</a> <a href="../../../../src-html/org/jfree/data/time/Week.html#line.231">getYear</a>()</pre>
- <div class="block">Returns the year in which the week falls.</div>
- <dl>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>The year (never <code>null</code>).</dd>
- </dl>
- </li>
- </ul>
- <a name="getYearValue--">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getYearValue</h4>
- <pre>public int <a href="../../../../src-html/org/jfree/data/time/Week.html#line.240">getYearValue</a>()</pre>
- <div class="block">Returns the year in which the week falls, as an integer value.</div>
- <dl>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>The year.</dd>
- </dl>
- </li>
- </ul>
- <a name="getWeek--">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getWeek</h4>
- <pre>public int <a href="../../../../src-html/org/jfree/data/time/Week.html#line.249">getWeek</a>()</pre>
- <div class="block">Returns the week.</div>
- <dl>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>The week.</dd>
- </dl>
- </li>
- </ul>
- <a name="getFirstMillisecond--">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getFirstMillisecond</h4>
- <pre>public long <a href="../../../../src-html/org/jfree/data/time/Week.html#line.264">getFirstMillisecond</a>()</pre>
- <div class="block">Returns the first millisecond of the week. This will be determined
- relative to the time zone specified in the constructor, or in the
- calendar instance passed in the most recent call to the
- <a href="../../../../org/jfree/data/time/Week.html#peg-java.util.Calendar-"><code>peg(Calendar)</code></a> method.</div>
- <dl>
- <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
- <dd><code><a href="../../../../org/jfree/data/time/RegularTimePeriod.html#getFirstMillisecond--">getFirstMillisecond</a></code> in class <code><a href="../../../../org/jfree/data/time/RegularTimePeriod.html" title="class in org.jfree.data.time">RegularTimePeriod</a></code></dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>The first millisecond of the week.</dd>
- <dt><span class="seeLabel">See Also:</span></dt>
- <dd><a href="../../../../org/jfree/data/time/Week.html#getLastMillisecond--"><code>getLastMillisecond()</code></a></dd>
- </dl>
- </li>
- </ul>
- <a name="getLastMillisecond--">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getLastMillisecond</h4>
- <pre>public long <a href="../../../../src-html/org/jfree/data/time/Week.html#line.279">getLastMillisecond</a>()</pre>
- <div class="block">Returns the last millisecond of the week. This will be
- determined relative to the time zone specified in the constructor, or
- in the calendar instance passed in the most recent call to the
- <a href="../../../../org/jfree/data/time/Week.html#peg-java.util.Calendar-"><code>peg(Calendar)</code></a> method.</div>
- <dl>
- <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
- <dd><code><a href="../../../../org/jfree/data/time/RegularTimePeriod.html#getLastMillisecond--">getLastMillisecond</a></code> in class <code><a href="../../../../org/jfree/data/time/RegularTimePeriod.html" title="class in org.jfree.data.time">RegularTimePeriod</a></code></dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>The last millisecond of the week.</dd>
- <dt><span class="seeLabel">See Also:</span></dt>
- <dd><a href="../../../../org/jfree/data/time/Week.html#getFirstMillisecond--"><code>getFirstMillisecond()</code></a></dd>
- </dl>
- </li>
- </ul>
- <a name="peg-java.util.Calendar-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>peg</h4>
- <pre>public void <a href="../../../../src-html/org/jfree/data/time/Week.html#line.292">peg</a>(java.util.Calendar calendar)</pre>
- <div class="block">Recalculates the start date/time and end date/time for this time period
- relative to the supplied calendar (which incorporates a time zone).</div>
- <dl>
- <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
- <dd><code><a href="../../../../org/jfree/data/time/RegularTimePeriod.html#peg-java.util.Calendar-">peg</a></code> in class <code><a href="../../../../org/jfree/data/time/RegularTimePeriod.html" title="class in org.jfree.data.time">RegularTimePeriod</a></code></dd>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>calendar</code> - the calendar (<code>null</code> not permitted).</dd>
- <dt><span class="simpleTagLabel">Since:</span></dt>
- <dd>1.0.3</dd>
- </dl>
- </li>
- </ul>
- <a name="previous--">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>previous</h4>
- <pre>public <a href="../../../../org/jfree/data/time/RegularTimePeriod.html" title="class in org.jfree.data.time">RegularTimePeriod</a> <a href="../../../../src-html/org/jfree/data/time/Week.html#line.306">previous</a>()</pre>
- <div class="block">Returns the week preceding this one. This method will return
- <code>null</code> for some lower limit on the range of weeks (currently
- week 1, 1900). For week 1 of any year, the previous week is always week
- 53, but week 53 may not contain any days (you should check for this).</div>
- <dl>
- <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
- <dd><code><a href="../../../../org/jfree/data/time/RegularTimePeriod.html#previous--">previous</a></code> in class <code><a href="../../../../org/jfree/data/time/RegularTimePeriod.html" title="class in org.jfree.data.time">RegularTimePeriod</a></code></dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>The preceding week (possibly <code>null</code>).</dd>
- </dl>
- </li>
- </ul>
- <a name="next--">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>next</h4>
- <pre>public <a href="../../../../org/jfree/data/time/RegularTimePeriod.html" title="class in org.jfree.data.time">RegularTimePeriod</a> <a href="../../../../src-html/org/jfree/data/time/Week.html#line.339">next</a>()</pre>
- <div class="block">Returns the week following this one. This method will return
- <code>null</code> for some upper limit on the range of weeks (currently
- week 53, 9999). For week 52 of any year, the following week is always
- week 53, but week 53 may not contain any days (you should check for
- this).</div>
- <dl>
- <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
- <dd><code><a href="../../../../org/jfree/data/time/RegularTimePeriod.html#next--">next</a></code> in class <code><a href="../../../../org/jfree/data/time/RegularTimePeriod.html" title="class in org.jfree.data.time">RegularTimePeriod</a></code></dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>The following week (possibly <code>null</code>).</dd>
- </dl>
- </li>
- </ul>
- <a name="getSerialIndex--">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getSerialIndex</h4>
- <pre>public long <a href="../../../../src-html/org/jfree/data/time/Week.html#line.372">getSerialIndex</a>()</pre>
- <div class="block">Returns a serial index number for the week.</div>
- <dl>
- <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
- <dd><code><a href="../../../../org/jfree/data/time/RegularTimePeriod.html#getSerialIndex--">getSerialIndex</a></code> in class <code><a href="../../../../org/jfree/data/time/RegularTimePeriod.html" title="class in org.jfree.data.time">RegularTimePeriod</a></code></dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>The serial index number.</dd>
- </dl>
- </li>
- </ul>
- <a name="getFirstMillisecond-java.util.Calendar-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getFirstMillisecond</h4>
- <pre>public long <a href="../../../../src-html/org/jfree/data/time/Week.html#line.388">getFirstMillisecond</a>(java.util.Calendar calendar)</pre>
- <div class="block">Returns the first millisecond of the week, evaluated using the supplied
- calendar (which determines the time zone).</div>
- <dl>
- <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
- <dd><code><a href="../../../../org/jfree/data/time/RegularTimePeriod.html#getFirstMillisecond-java.util.Calendar-">getFirstMillisecond</a></code> in class <code><a href="../../../../org/jfree/data/time/RegularTimePeriod.html" title="class in org.jfree.data.time">RegularTimePeriod</a></code></dd>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>calendar</code> - the calendar (<code>null</code> not permitted).</dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>The first millisecond of the week.</dd>
- <dt><span class="throwsLabel">Throws:</span></dt>
- <dd><code>java.lang.NullPointerException</code> - if <code>calendar</code> is
- <code>null</code>.</dd>
- <dt><span class="seeLabel">See Also:</span></dt>
- <dd><a href="../../../../org/jfree/data/time/RegularTimePeriod.html#getLastMillisecond-java.util.Calendar-"><code>RegularTimePeriod.getLastMillisecond(Calendar)</code></a></dd>
- </dl>
- </li>
- </ul>
- <a name="getLastMillisecond-java.util.Calendar-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getLastMillisecond</h4>
- <pre>public long <a href="../../../../src-html/org/jfree/data/time/Week.html#line.413">getLastMillisecond</a>(java.util.Calendar calendar)</pre>
- <div class="block">Returns the last millisecond of the week, evaluated using the supplied
- calendar (which determines the time zone).</div>
- <dl>
- <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
- <dd><code><a href="../../../../org/jfree/data/time/RegularTimePeriod.html#getLastMillisecond-java.util.Calendar-">getLastMillisecond</a></code> in class <code><a href="../../../../org/jfree/data/time/RegularTimePeriod.html" title="class in org.jfree.data.time">RegularTimePeriod</a></code></dd>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>calendar</code> - the calendar (<code>null</code> not permitted).</dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>The last millisecond of the week.</dd>
- <dt><span class="throwsLabel">Throws:</span></dt>
- <dd><code>java.lang.NullPointerException</code> - if <code>calendar</code> is
- <code>null</code>.</dd>
- <dt><span class="seeLabel">See Also:</span></dt>
- <dd><a href="../../../../org/jfree/data/time/RegularTimePeriod.html#getFirstMillisecond-java.util.Calendar-"><code>RegularTimePeriod.getFirstMillisecond(Calendar)</code></a></dd>
- </dl>
- </li>
- </ul>
- <a name="toString--">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>toString</h4>
- <pre>public java.lang.String <a href="../../../../src-html/org/jfree/data/time/Week.html#line.434">toString</a>()</pre>
- <div class="block">Returns a string representing the week (e.g. "Week 9, 2002").
- TODO: look at internationalisation.</div>
- <dl>
- <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
- <dd><code><a href="../../../../org/jfree/data/time/RegularTimePeriod.html#toString--">toString</a></code> in class <code><a href="../../../../org/jfree/data/time/RegularTimePeriod.html" title="class in org.jfree.data.time">RegularTimePeriod</a></code></dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>A string representing the week.</dd>
- </dl>
- </li>
- </ul>
- <a name="equals-java.lang.Object-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>equals</h4>
- <pre>public boolean <a href="../../../../src-html/org/jfree/data/time/Week.html#line.449">equals</a>(java.lang.Object obj)</pre>
- <div class="block">Tests the equality of this Week object to an arbitrary object. Returns
- true if the target is a Week instance representing the same week as this
- object. In all other cases, returns false.</div>
- <dl>
- <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
- <dd><code>equals</code> in class <code>java.lang.Object</code></dd>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>obj</code> - the object (<code>null</code> permitted).</dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd><code>true</code> if week and year of this and object are the
- same.</dd>
- </dl>
- </li>
- </ul>
- <a name="hashCode--">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>hashCode</h4>
- <pre>public int <a href="../../../../src-html/org/jfree/data/time/Week.html#line.478">hashCode</a>()</pre>
- <div class="block">Returns a hash code for this object instance. The approach described by
- Joshua Bloch in "Effective Java" has been used here:
- <p>
- <code>http://developer.java.sun.com/developer/Books/effectivejava
- /Chapter3.pdf</code></div>
- <dl>
- <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
- <dd><code>hashCode</code> in class <code>java.lang.Object</code></dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>A hash code.</dd>
- </dl>
- </li>
- </ul>
- <a name="compareTo-java.lang.Object-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>compareTo</h4>
- <pre>public int <a href="../../../../src-html/org/jfree/data/time/Week.html#line.496">compareTo</a>(java.lang.Object o1)</pre>
- <div class="block">Returns an integer indicating the order of this Week object relative to
- the specified object:
- negative == before, zero == same, positive == after.</div>
- <dl>
- <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
- <dd><code>compareTo</code> in interface <code>java.lang.Comparable</code></dd>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>o1</code> - the object to compare.</dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>negative == before, zero == same, positive == after.</dd>
- </dl>
- </li>
- </ul>
- <a name="parseWeek-java.lang.String-">
- <!-- -->
- </a>
- <ul class="blockListLast">
- <li class="blockList">
- <h4>parseWeek</h4>
- <pre>public static <a href="../../../../org/jfree/data/time/Week.html" title="class in org.jfree.data.time">Week</a> <a href="../../../../src-html/org/jfree/data/time/Week.html#line.539">parseWeek</a>(java.lang.String s)</pre>
- <div class="block">Parses the string argument as a week.
- <P>
- This method is required to accept the format "YYYY-Wnn". It will also
- accept "Wnn-YYYY". Anything else, at the moment, is a bonus.</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>s</code> - string to parse.</dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd><code>null</code> if the string is not parseable, the week
- otherwise.</dd>
- </dl>
- </li>
- </ul>
- </li>
- </ul>
- </li>
- </ul>
- </div>
- </div>
- <!-- ========= END OF CLASS DATA ========= -->
- <!-- ======= START OF BOTTOM NAVBAR ====== -->
- <div class="bottomNav"><a name="navbar.bottom">
- <!-- -->
- </a>
- <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
- <a name="navbar.bottom.firstrow">
- <!-- -->
- </a>
- <ul class="navList" title="Navigation">
- <li><a href="../../../../overview-summary.html">Overview</a></li>
- <li><a href="package-summary.html">Package</a></li>
- <li class="navBarCell1Rev">Class</li>
- <li><a href="class-use/Week.html">Use</a></li>
- <li><a href="package-tree.html">Tree</a></li>
- <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
- <li><a href="../../../../index-files/index-1.html">Index</a></li>
- <li><a href="../../../../help-doc.html">Help</a></li>
- </ul>
- </div>
- <div class="subNav">
- <ul class="navList">
- <li><a href="../../../../org/jfree/data/time/TimeTableXYDataset.html" title="class in org.jfree.data.time"><span class="typeNameLink">Prev Class</span></a></li>
- <li><a href="../../../../org/jfree/data/time/Year.html" title="class in org.jfree.data.time"><span class="typeNameLink">Next Class</span></a></li>
- </ul>
- <ul class="navList">
- <li><a href="../../../../index.html?org/jfree/data/time/Week.html" target="_top">Frames</a></li>
- <li><a href="Week.html" target="_top">No Frames</a></li>
- </ul>
- <ul class="navList" id="allclasses_navbar_bottom">
- <li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
- </ul>
- <div>
- <script type="text/javascript"><!--
- allClassesLink = document.getElementById("allclasses_navbar_bottom");
- if(window==top) {
- allClassesLink.style.display = "block";
- }
- else {
- allClassesLink.style.display = "none";
- }
- //-->
- </script>
- </div>
- <div>
- <ul class="subNavList">
- <li>Summary: </li>
- <li>Nested | </li>
- <li><a href="#field.summary">Field</a> | </li>
- <li><a href="#constructor.summary">Constr</a> | </li>
- <li><a href="#method.summary">Method</a></li>
- </ul>
- <ul class="subNavList">
- <li>Detail: </li>
- <li><a href="#field.detail">Field</a> | </li>
- <li><a href="#constructor.detail">Constr</a> | </li>
- <li><a href="#method.detail">Method</a></li>
- </ul>
- </div>
- <a name="skip.navbar.bottom">
- <!-- -->
- </a></div>
- <!-- ======== END OF BOTTOM NAVBAR ======= -->
- </body>
- </html>
|