Google Git
Sign in
apache / velocity-site / 89c3a15cf30ab2c0dbdf8253ed5c2eb24d9b1e21 / . / tools / 3.0 / apidocs / org / apache / velocity / tools / generic / ComparisonDateTool.Comparison.html
blob: 587f28b8b90f65089ab92222a8fd6b4f1caa024a [file] [log] [blame]
<!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_181) on Wed Oct 10 00:41:12 CEST 2018 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ComparisonDateTool.Comparison (VelocityTools 3.0 API)</title>
<meta name="date" content="2018-10-10">
<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="ComparisonDateTool.Comparison (VelocityTools 3.0 API)";
}
}
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":10,"i13":10,"i14":10,"i15":10};
var tabs = {65535:["t0","All 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/ComparisonDateTool.Comparison.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-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/velocity/tools/generic/ComparisonDateTool.html" title="class in org.apache.velocity.tools.generic"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/velocity/tools/generic/ContextTool.html" title="class in org.apache.velocity.tools.generic"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/velocity/tools/generic/ComparisonDateTool.Comparison.html" target="_top">Frames</a></li>
<li><a href="ComparisonDateTool.Comparison.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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.velocity.tools.generic</div>
<h2 title="Class ComparisonDateTool.Comparison" class="title">Class ComparisonDateTool.Comparison</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>org.apache.velocity.tools.generic.ComparisonDateTool.Comparison</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>Enclosing class:</dt>
<dd><a href="../../../../../org/apache/velocity/tools/generic/ComparisonDateTool.html" title="class in org.apache.velocity.tools.generic">ComparisonDateTool</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">ComparisonDateTool.Comparison</span>
extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== 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">&nbsp;</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/apache/velocity/tools/generic/ComparisonDateTool.Comparison.html#Comparison-long-int-int-boolean-java.util.Locale-">Comparison</a></span>(long&nbsp;ms,
int&nbsp;type,
int&nbsp;depth,
boolean&nbsp;abbr,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Locale.html?is-external=true" title="class or interface in java.util">Locale</a>&nbsp;loc)</code>
<div class="block">Comparison object constructor</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">&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>
<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><a href="../../../../../org/apache/velocity/tools/generic/ComparisonDateTool.Comparison.html" title="class in org.apache.velocity.tools.generic">ComparisonDateTool.Comparison</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/velocity/tools/generic/ComparisonDateTool.Comparison.html#abbr-boolean-">abbr</a></span>(boolean&nbsp;abbr)</code>
<div class="block">Sets whether or not this comparison is to be rendered in
abbreviated form or not.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/velocity/tools/generic/ComparisonDateTool.Comparison.html" title="class in org.apache.velocity.tools.generic">ComparisonDateTool.Comparison</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/velocity/tools/generic/ComparisonDateTool.Comparison.html#depth-int-">depth</a></span>(int&nbsp;depth)</code>
<div class="block">Set the maximum number of units to render for this comparison.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/velocity/tools/generic/ComparisonDateTool.Comparison.html" title="class in org.apache.velocity.tools.generic">ComparisonDateTool.Comparison</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/velocity/tools/generic/ComparisonDateTool.Comparison.html#getAbbr--">getAbbr</a></span>()</code>
<div class="block">This is equivalent to calling <a href="../../../../../org/apache/velocity/tools/generic/ComparisonDateTool.Comparison.html#abbr-boolean-"><code>abbr(boolean abbr)</code></a> with
<code>true</code> as the argument, thus setting this comparison to be
rendered in abbreviated form.</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/apache/velocity/tools/generic/ComparisonDateTool.Comparison.html#getDays--">getDays</a></span>()</code>
<div class="block">Return the number of days between the dates being compared.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/velocity/tools/generic/ComparisonDateTool.Comparison.html" title="class in org.apache.velocity.tools.generic">ComparisonDateTool.Comparison</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/velocity/tools/generic/ComparisonDateTool.Comparison.html#getDifference--">getDifference</a></span>()</code>
<div class="block">Sets this comparison to be rendered as a
<a href="../../../../../org/apache/velocity/tools/generic/ComparisonDateTool.html#difference-java.lang.Object-java.lang.Object-"><code>ComparisonDateTool.difference(java.lang.Object, java.lang.Object)</code></a>.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/velocity/tools/generic/ComparisonDateTool.Comparison.html" title="class in org.apache.velocity.tools.generic">ComparisonDateTool.Comparison</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/velocity/tools/generic/ComparisonDateTool.Comparison.html#getFull--">getFull</a></span>()</code>
<div class="block">Sets the <a href="../../../../../org/apache/velocity/tools/generic/ComparisonDateTool.Comparison.html#depth-int-"><code>depth(int depth)</code></a> to which this comparison is rendered
to the maximum number of time units available to the tool.</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/apache/velocity/tools/generic/ComparisonDateTool.Comparison.html#getHours--">getHours</a></span>()</code>
<div class="block">Return the number of hours between the dates being compared.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/velocity/tools/generic/ComparisonDateTool.Comparison.html#getMilliseconds--">getMilliseconds</a></span>()</code>
<div class="block">Return the number of milliseconds between the dates being compared.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/velocity/tools/generic/ComparisonDateTool.Comparison.html#getMinutes--">getMinutes</a></span>()</code>
<div class="block">Return the number of minutes between the dates being compared.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/velocity/tools/generic/ComparisonDateTool.Comparison.html#getMonths--">getMonths</a></span>()</code>
<div class="block">Return the approximate number of months between the dates being compared.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/velocity/tools/generic/ComparisonDateTool.Comparison.html" title="class in org.apache.velocity.tools.generic">ComparisonDateTool.Comparison</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/velocity/tools/generic/ComparisonDateTool.Comparison.html#getRelative--">getRelative</a></span>()</code>
<div class="block">Sets this comparison to be rendered as if it where generated using
the <a href="../../../../../org/apache/velocity/tools/generic/ComparisonDateTool.html#whenIs-java.lang.Object-java.lang.Object-"><code>ComparisonDateTool.whenIs(Object now, Object then)</code></a> method.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/velocity/tools/generic/ComparisonDateTool.Comparison.html#getSeconds--">getSeconds</a></span>()</code>
<div class="block">Return the number of seconds between the dates being compared.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/velocity/tools/generic/ComparisonDateTool.Comparison.html#getWeeks--">getWeeks</a></span>()</code>
<div class="block">Return the number of weeks between the dates being compared.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/velocity/tools/generic/ComparisonDateTool.Comparison.html#getYears--">getYears</a></span>()</code>
<div class="block">Return the approximate number of years between the dates being compared.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/velocity/tools/generic/ComparisonDateTool.Comparison.html" title="class in org.apache.velocity.tools.generic">ComparisonDateTool.Comparison</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/velocity/tools/generic/ComparisonDateTool.Comparison.html#locale-java.util.Locale-">locale</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Locale.html?is-external=true" title="class or interface in java.util">Locale</a>&nbsp;loc)</code>
<div class="block">Sets the locale used to look up the textual portions of the
rendering.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/velocity/tools/generic/ComparisonDateTool.Comparison.html#toString--">toString</a></span>()</code>
<div class="block">Renders this comparison to a String.</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&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="Comparison-long-int-int-boolean-java.util.Locale-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Comparison</h4>
<pre>public&nbsp;Comparison(long&nbsp;ms,
int&nbsp;type,
int&nbsp;depth,
boolean&nbsp;abbr,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Locale.html?is-external=true" title="class or interface in java.util">Locale</a>&nbsp;loc)</pre>
<div class="block">Comparison object constructor</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>ms</code> - milliseconds</dd>
<dd><code>type</code> - comparison type</dd>
<dd><code>depth</code> - units depth</dd>
<dd><code>abbr</code> - whether to abbreviate units</dd>
<dd><code>loc</code> - locale to use</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="abbr-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>abbr</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/velocity/tools/generic/ComparisonDateTool.Comparison.html" title="class in org.apache.velocity.tools.generic">ComparisonDateTool.Comparison</a>&nbsp;abbr(boolean&nbsp;abbr)</pre>
<div class="block">Sets whether or not this comparison is to be rendered in
abbreviated form or not. By default, it is not abbreviated.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>abbr</code> - flag value</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>new Comparison object</dd>
</dl>
</li>
</ul>
<a name="depth-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>depth</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/velocity/tools/generic/ComparisonDateTool.Comparison.html" title="class in org.apache.velocity.tools.generic">ComparisonDateTool.Comparison</a>&nbsp;depth(int&nbsp;depth)</pre>
<div class="block">Set the maximum number of units to render for this comparison.
By default, this is set to 1 unit.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>depth</code> - max units depth</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>new Comparison object</dd>
</dl>
</li>
</ul>
<a name="locale-java.util.Locale-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>locale</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/velocity/tools/generic/ComparisonDateTool.Comparison.html" title="class in org.apache.velocity.tools.generic">ComparisonDateTool.Comparison</a>&nbsp;locale(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Locale.html?is-external=true" title="class or interface in java.util">Locale</a>&nbsp;loc)</pre>
<div class="block">Sets the locale used to look up the textual portions of the
rendering. This defaults to the Locale configured for this tool,
if any. If no locale was configured, this defaults to the system
default.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>loc</code> - locale to use</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>new Comparison object</dd>
</dl>
</li>
</ul>
<a name="getYears--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getYears</h4>
<pre>public&nbsp;long&nbsp;getYears()</pre>
<div class="block">Return the approximate number of years between the dates being compared.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>years</dd>
</dl>
</li>
</ul>
<a name="getMonths--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMonths</h4>
<pre>public&nbsp;long&nbsp;getMonths()</pre>
<div class="block">Return the approximate number of months between the dates being compared.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>months</dd>
</dl>
</li>
</ul>
<a name="getWeeks--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getWeeks</h4>
<pre>public&nbsp;long&nbsp;getWeeks()</pre>
<div class="block">Return the number of weeks between the dates being compared.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>weeks</dd>
</dl>
</li>
</ul>
<a name="getDays--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDays</h4>
<pre>public&nbsp;long&nbsp;getDays()</pre>
<div class="block">Return the number of days between the dates being compared.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>days</dd>
</dl>
</li>
</ul>
<a name="getHours--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getHours</h4>
<pre>public&nbsp;long&nbsp;getHours()</pre>
<div class="block">Return the number of hours between the dates being compared.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>hours</dd>
</dl>
</li>
</ul>
<a name="getMinutes--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMinutes</h4>
<pre>public&nbsp;long&nbsp;getMinutes()</pre>
<div class="block">Return the number of minutes between the dates being compared.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>minutes</dd>
</dl>
</li>
</ul>
<a name="getSeconds--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSeconds</h4>
<pre>public&nbsp;long&nbsp;getSeconds()</pre>
<div class="block">Return the number of seconds between the dates being compared.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>seconds</dd>
</dl>
</li>
</ul>
<a name="getMilliseconds--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMilliseconds</h4>
<pre>public&nbsp;long&nbsp;getMilliseconds()</pre>
<div class="block">Return the number of milliseconds between the dates being compared.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>milliseconds</dd>
</dl>
</li>
</ul>
<a name="getFull--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFull</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/velocity/tools/generic/ComparisonDateTool.Comparison.html" title="class in org.apache.velocity.tools.generic">ComparisonDateTool.Comparison</a>&nbsp;getFull()</pre>
<div class="block">Sets the <a href="../../../../../org/apache/velocity/tools/generic/ComparisonDateTool.Comparison.html#depth-int-"><code>depth(int depth)</code></a> to which this comparison is rendered
to the maximum number of time units available to the tool. By default,
there are 8 units available, but the tool may be configured to "skip"
any of the standard units, thus shortening the maximum depth.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>new Comparison object</dd>
</dl>
</li>
</ul>
<a name="getDifference--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDifference</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/velocity/tools/generic/ComparisonDateTool.Comparison.html" title="class in org.apache.velocity.tools.generic">ComparisonDateTool.Comparison</a>&nbsp;getDifference()</pre>
<div class="block">Sets this comparison to be rendered as a
<a href="../../../../../org/apache/velocity/tools/generic/ComparisonDateTool.html#difference-java.lang.Object-java.lang.Object-"><code>ComparisonDateTool.difference(java.lang.Object, java.lang.Object)</code></a>. This effectively means that
the comparison will render as a period of time, without any suffix
to describe the relative position of the dates being compared (e.g. "later"
or "ago").</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>new Comparison object</dd>
</dl>
</li>
</ul>
<a name="getRelative--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRelative</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/velocity/tools/generic/ComparisonDateTool.Comparison.html" title="class in org.apache.velocity.tools.generic">ComparisonDateTool.Comparison</a>&nbsp;getRelative()</pre>
<div class="block">Sets this comparison to be rendered as if it where generated using
the <a href="../../../../../org/apache/velocity/tools/generic/ComparisonDateTool.html#whenIs-java.lang.Object-java.lang.Object-"><code>ComparisonDateTool.whenIs(Object now, Object then)</code></a> method.
This effectively means that the comparison will render with a suffix
to describe the relative position of the dates being compared (e.g. "later"
or "ago").</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>new Comparison object</dd>
</dl>
</li>
</ul>
<a name="getAbbr--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAbbr</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/velocity/tools/generic/ComparisonDateTool.Comparison.html" title="class in org.apache.velocity.tools.generic">ComparisonDateTool.Comparison</a>&nbsp;getAbbr()</pre>
<div class="block">This is equivalent to calling <a href="../../../../../org/apache/velocity/tools/generic/ComparisonDateTool.Comparison.html#abbr-boolean-"><code>abbr(boolean abbr)</code></a> with
<code>true</code> as the argument, thus setting this comparison to be
rendered in abbreviated form.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>new Comparison object</dd>
</dl>
</li>
</ul>
<a name="toString--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>toString</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;toString()</pre>
<div class="block">Renders this comparison to a String.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a></code>&nbsp;in class&nbsp;<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>string representation</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/ComparisonDateTool.Comparison.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-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/velocity/tools/generic/ComparisonDateTool.html" title="class in org.apache.velocity.tools.generic"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/velocity/tools/generic/ContextTool.html" title="class in org.apache.velocity.tools.generic"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/velocity/tools/generic/ComparisonDateTool.Comparison.html" target="_top">Frames</a></li>
<li><a href="ComparisonDateTool.Comparison.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2002&#x2013;2018 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>