????
Your IP : 216.73.216.152
<!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 (version 1.7.0_03) on Tue May 22 06:24:55 CEST 2012 -->
<title>DateUtils (Apache Ant API)</title>
<meta name="date" content="2012-05-22">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="DateUtils (Apache Ant API)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><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="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.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/apache/tools/ant/util/ContainerMapper.html" title="class in org.apache.tools.ant.util"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/tools/ant/util/DeweyDecimal.html" title="class in org.apache.tools.ant.util"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/tools/ant/util/DateUtils.html" target="_top">Frames</a></li>
<li><a href="DateUtils.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>Constr | </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>Constr | </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.apache.tools.ant.util</div>
<h2 title="Class DateUtils" class="title">Class DateUtils</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.tools.ant.util.DateUtils</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public final class <span class="strong">DateUtils</span>
extends java.lang.Object</pre>
<div class="block">Helper methods to deal with date/time formatting with a specific
defined format (<a href="http://www.w3.org/TR/NOTE-datetime">ISO8601</a>)
or a plurialization correct elapsed time in minutes and seconds.</div>
<dl><dt><span class="strong">Since:</span></dt>
<dd>Ant 1.5</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="overviewSummary" 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 java.text.DateFormat</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/tools/ant/util/DateUtils.html#DATE_HEADER_FORMAT">DATE_HEADER_FORMAT</a></strong></code>
<div class="block"><strong>Deprecated.</strong>
<div class="block"><i>DateFormat is not thread safe, and we cannot guarantee that
some other code is using the format in parallel.
Deprecated since ant 1.8</i></div>
</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/tools/ant/util/DateUtils.html#ISO8601_DATE_PATTERN">ISO8601_DATE_PATTERN</a></strong></code>
<div class="block">ISO8601-like pattern for date.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/tools/ant/util/DateUtils.html#ISO8601_DATETIME_PATTERN">ISO8601_DATETIME_PATTERN</a></strong></code>
<div class="block">ISO8601-like pattern for date-time.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/tools/ant/util/DateUtils.html#ISO8601_TIME_PATTERN">ISO8601_TIME_PATTERN</a></strong></code>
<div class="block">ISO8601-like pattern for time.</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="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/tools/ant/util/DateUtils.html#format(java.util.Date, java.lang.String)">format</a></strong>(java.util.Date date,
java.lang.String pattern)</code>
<div class="block">Format a date/time into a specific pattern.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/tools/ant/util/DateUtils.html#format(long, java.lang.String)">format</a></strong>(long date,
java.lang.String pattern)</code>
<div class="block">Format a date/time into a specific pattern.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/tools/ant/util/DateUtils.html#formatElapsedTime(long)">formatElapsedTime</a></strong>(long millis)</code>
<div class="block">Format an elapsed time into a plurialization correct string.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/tools/ant/util/DateUtils.html#getDateForHeader()">getDateForHeader</a></strong>()</code>
<div class="block">Returns the current Date in a format suitable for a SMTP date
header.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/tools/ant/util/DateUtils.html#getPhaseOfMoon(java.util.Calendar)">getPhaseOfMoon</a></strong>(java.util.Calendar cal)</code>
<div class="block">Calculate the phase of the moon for a given date.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.util.Date</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/tools/ant/util/DateUtils.html#parseDateFromHeader(java.lang.String)">parseDateFromHeader</a></strong>(java.lang.String datestr)</code>
<div class="block">Parses the string in a format suitable for a SMTP date header.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.util.Date</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/tools/ant/util/DateUtils.html#parseIso8601Date(java.lang.String)">parseIso8601Date</a></strong>(java.lang.String datestr)</code>
<div class="block">Parse a string as a date using the ISO8601_DATE format which is
<code>yyyy-MM-dd</code></div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.util.Date</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/tools/ant/util/DateUtils.html#parseIso8601DateTime(java.lang.String)">parseIso8601DateTime</a></strong>(java.lang.String datestr)</code>
<div class="block">Parse a string as a datetime using the ISO8601_DATETIME format which is
<code>yyyy-MM-dd'T'HH:mm:ss</code></div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.util.Date</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/tools/ant/util/DateUtils.html#parseIso8601DateTimeOrDate(java.lang.String)">parseIso8601DateTimeOrDate</a></strong>(java.lang.String datestr)</code>
<div class="block">Parse a string as a date using the either the ISO8601_DATETIME
or ISO8601_DATE formats.</div>
</td>
</tr>
</table>
<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, equals, finalize, getClass, hashCode, notify, notifyAll, toString, 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="ISO8601_DATETIME_PATTERN">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ISO8601_DATETIME_PATTERN</h4>
<pre>public static final java.lang.String ISO8601_DATETIME_PATTERN</pre>
<div class="block">ISO8601-like pattern for date-time. It does not support timezone.
<tt>yyyy-MM-ddTHH:mm:ss</tt></div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.tools.ant.util.DateUtils.ISO8601_DATETIME_PATTERN">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="ISO8601_DATE_PATTERN">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ISO8601_DATE_PATTERN</h4>
<pre>public static final java.lang.String ISO8601_DATE_PATTERN</pre>
<div class="block">ISO8601-like pattern for date. <tt>yyyy-MM-dd</tt></div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.tools.ant.util.DateUtils.ISO8601_DATE_PATTERN">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="ISO8601_TIME_PATTERN">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ISO8601_TIME_PATTERN</h4>
<pre>public static final java.lang.String ISO8601_TIME_PATTERN</pre>
<div class="block">ISO8601-like pattern for time. <tt>HH:mm:ss</tt></div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.tools.ant.util.DateUtils.ISO8601_TIME_PATTERN">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="DATE_HEADER_FORMAT">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>DATE_HEADER_FORMAT</h4>
<pre>public static final java.text.DateFormat DATE_HEADER_FORMAT</pre>
<div class="block"><span class="strong">Deprecated.</span> <i>DateFormat is not thread safe, and we cannot guarantee that
some other code is using the format in parallel.
Deprecated since ant 1.8</i></div>
<div class="block">Format used for SMTP (and probably other) Date headers.</div>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="format(long, java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>format</h4>
<pre>public static java.lang.String format(long date,
java.lang.String pattern)</pre>
<div class="block">Format a date/time into a specific pattern.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>date</code> - the date to format expressed in milliseconds.</dd><dd><code>pattern</code> - the pattern to use to format the date.</dd>
<dt><span class="strong">Returns:</span></dt><dd>the formatted date.</dd></dl>
</li>
</ul>
<a name="format(java.util.Date, java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>format</h4>
<pre>public static java.lang.String format(java.util.Date date,
java.lang.String pattern)</pre>
<div class="block">Format a date/time into a specific pattern.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>date</code> - the date to format expressed in milliseconds.</dd><dd><code>pattern</code> - the pattern to use to format the date.</dd>
<dt><span class="strong">Returns:</span></dt><dd>the formatted date.</dd></dl>
</li>
</ul>
<a name="formatElapsedTime(long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>formatElapsedTime</h4>
<pre>public static java.lang.String formatElapsedTime(long millis)</pre>
<div class="block">Format an elapsed time into a plurialization correct string.
It is limited only to report elapsed time in minutes and
seconds and has the following behavior.
<ul>
<li>minutes are not displayed when 0. (ie: "45 seconds")</li>
<li>seconds are always displayed in plural form (ie "0 seconds" or
"10 seconds") except for 1 (ie "1 second")</li>
</ul></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>millis</code> - the elapsed time to report in milliseconds.</dd>
<dt><span class="strong">Returns:</span></dt><dd>the formatted text in minutes/seconds.</dd></dl>
</li>
</ul>
<a name="getPhaseOfMoon(java.util.Calendar)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPhaseOfMoon</h4>
<pre>public static int getPhaseOfMoon(java.util.Calendar cal)</pre>
<div class="block">Calculate the phase of the moon for a given date.
<p>Code heavily influenced by hacklib.c in <a
href="http://www.nethack.org/">Nethack</a></p>
<p>The Algorithm:
<pre>
moon period = 29.53058 days ~= 30, year = 365.2422 days
days moon phase advances on first day of year compared to preceding year
= 365.2422 - 12*29.53058 ~= 11
years in Metonic cycle (time until same phases fall on the same days of
the month) = 18.6 ~= 19
moon phase on first day of year (epact) ~= (11*(year%19) + 18) % 30
(18 as initial condition for 1900)
current phase in days = first day phase + days elapsed in year
6 moons ~= 177 days
177 ~= 8 reported phases * 22
+ 11/22 for rounding
</pre></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>cal</code> - the calander.</dd>
<dt><span class="strong">Returns:</span></dt><dd>The phase of the moon as a number between 0 and 7 with
0 meaning new moon and 4 meaning full moon.</dd><dt><span class="strong">Since:</span></dt>
<dd>1.2, Ant 1.5</dd></dl>
</li>
</ul>
<a name="getDateForHeader()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDateForHeader</h4>
<pre>public static java.lang.String getDateForHeader()</pre>
<div class="block">Returns the current Date in a format suitable for a SMTP date
header.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the current date.</dd><dt><span class="strong">Since:</span></dt>
<dd>Ant 1.5.2</dd></dl>
</li>
</ul>
<a name="parseDateFromHeader(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>parseDateFromHeader</h4>
<pre>public static java.util.Date parseDateFromHeader(java.lang.String datestr)
throws java.text.ParseException</pre>
<div class="block">Parses the string in a format suitable for a SMTP date header.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>datestr</code> - string to be parsed</dd>
<dt><span class="strong">Returns:</span></dt><dd>a java.util.Date object as parsed by the format.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.text.ParseException</code> - if the supplied string cannot be parsed by
this pattern.</dd><dt><span class="strong">Since:</span></dt>
<dd>Ant 1.8.0</dd></dl>
</li>
</ul>
<a name="parseIso8601DateTime(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>parseIso8601DateTime</h4>
<pre>public static java.util.Date parseIso8601DateTime(java.lang.String datestr)
throws java.text.ParseException</pre>
<div class="block">Parse a string as a datetime using the ISO8601_DATETIME format which is
<code>yyyy-MM-dd'T'HH:mm:ss</code></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>datestr</code> - string to be parsed</dd>
<dt><span class="strong">Returns:</span></dt><dd>a java.util.Date object as parsed by the format.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.text.ParseException</code> - if the supplied string cannot be parsed by
this pattern.</dd><dt><span class="strong">Since:</span></dt>
<dd>Ant 1.6</dd></dl>
</li>
</ul>
<a name="parseIso8601Date(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>parseIso8601Date</h4>
<pre>public static java.util.Date parseIso8601Date(java.lang.String datestr)
throws java.text.ParseException</pre>
<div class="block">Parse a string as a date using the ISO8601_DATE format which is
<code>yyyy-MM-dd</code></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>datestr</code> - string to be parsed</dd>
<dt><span class="strong">Returns:</span></dt><dd>a java.util.Date object as parsed by the format.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.text.ParseException</code> - if the supplied string cannot be parsed by
this pattern.</dd><dt><span class="strong">Since:</span></dt>
<dd>Ant 1.6</dd></dl>
</li>
</ul>
<a name="parseIso8601DateTimeOrDate(java.lang.String)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>parseIso8601DateTimeOrDate</h4>
<pre>public static java.util.Date parseIso8601DateTimeOrDate(java.lang.String datestr)
throws java.text.ParseException</pre>
<div class="block">Parse a string as a date using the either the ISO8601_DATETIME
or ISO8601_DATE formats.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>datestr</code> - string to be parsed</dd>
<dt><span class="strong">Returns:</span></dt><dd>a java.util.Date object as parsed by the formats.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.text.ParseException</code> - if the supplied string cannot be parsed by
either of these patterns.</dd><dt><span class="strong">Since:</span></dt>
<dd>Ant 1.6</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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.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/apache/tools/ant/util/ContainerMapper.html" title="class in org.apache.tools.ant.util"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/tools/ant/util/DeweyDecimal.html" title="class in org.apache.tools.ant.util"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/tools/ant/util/DateUtils.html" target="_top">Frames</a></li>
<li><a href="DateUtils.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>Constr | </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>Constr | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>