Class ComparisonDateTool.Comparison
- java.lang.Object
-
- org.apache.velocity.tools.generic.ComparisonDateTool.Comparison
-
- Enclosing class:
- ComparisonDateTool
public class ComparisonDateTool.Comparison extends java.lang.Object
-
-
Field Summary
Fields Modifier and Type Field Description private boolean
abbreviate
private java.util.Locale
locale
private int
maxUnitDepth
private long
milliseconds
private int
type
-
Constructor Summary
Constructors Constructor Description Comparison(long ms, int type, int depth, boolean abbr, java.util.Locale loc)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ComparisonDateTool.Comparison
abbr(boolean abbr)
Sets whether or not this comparison is to be rendered in abbreviated form or not.ComparisonDateTool.Comparison
depth(int depth)
Set the maximum number of units to render for this comparison.ComparisonDateTool.Comparison
getAbbr()
This is equivalent to callingabbr(boolean abbr)
withtrue
as the argument, thus setting this comparison to be rendered in abbreviated form.long
getDays()
Return the number of days between the dates being compared.ComparisonDateTool.Comparison
getDifference()
Sets this comparison to be rendered as aComparisonDateTool.difference(java.lang.Object, java.lang.Object)
.ComparisonDateTool.Comparison
getFull()
Sets thedepth(int depth)
to which this comparison is rendered to the maximum number of time units available to the tool.long
getHours()
Return the number of hours between the dates being compared.long
getMilliseconds()
Return the number of milliseconds between the dates being compared.long
getMinutes()
Return the number of minutes between the dates being compared.long
getMonths()
Return the approximate number of months between the dates being compared.ComparisonDateTool.Comparison
getRelative()
Sets this comparison to be rendered as if it where generated using theComparisonDateTool.whenIs(Object now, Object then)
method.long
getSeconds()
Return the number of seconds between the dates being compared.long
getWeeks()
Return the number of weeks between the dates being compared.long
getYears()
Return the approximate number of years between the dates being compared.ComparisonDateTool.Comparison
locale(java.util.Locale loc)
Sets the locale used to look up the textual portions of the rendering.java.lang.String
toString()
Renders this comparison to a String.
-
-
-
Method Detail
-
abbr
public ComparisonDateTool.Comparison abbr(boolean abbr)
Sets whether or not this comparison is to be rendered in abbreviated form or not. By default, it is not abbreviated.
-
depth
public ComparisonDateTool.Comparison depth(int depth)
Set the maximum number of units to render for this comparison. By default, this is set to 1 unit.
-
locale
public ComparisonDateTool.Comparison locale(java.util.Locale loc)
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.
-
getYears
public long getYears()
Return the approximate number of years between the dates being compared.
-
getMonths
public long getMonths()
Return the approximate number of months between the dates being compared.
-
getWeeks
public long getWeeks()
Return the number of weeks between the dates being compared.
-
getDays
public long getDays()
Return the number of days between the dates being compared.
-
getHours
public long getHours()
Return the number of hours between the dates being compared.
-
getMinutes
public long getMinutes()
Return the number of minutes between the dates being compared.
-
getSeconds
public long getSeconds()
Return the number of seconds between the dates being compared.
-
getMilliseconds
public long getMilliseconds()
Return the number of milliseconds between the dates being compared.
-
getFull
public ComparisonDateTool.Comparison getFull()
Sets thedepth(int depth)
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.
-
getDifference
public ComparisonDateTool.Comparison getDifference()
Sets this comparison to be rendered as aComparisonDateTool.difference(java.lang.Object, java.lang.Object)
. 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").
-
getRelative
public ComparisonDateTool.Comparison getRelative()
Sets this comparison to be rendered as if it where generated using theComparisonDateTool.whenIs(Object now, Object then)
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").
-
getAbbr
public ComparisonDateTool.Comparison getAbbr()
This is equivalent to callingabbr(boolean abbr)
withtrue
as the argument, thus setting this comparison to be rendered in abbreviated form.
-
toString
public java.lang.String toString()
Renders this comparison to a String.- Overrides:
toString
in classjava.lang.Object
-
-