org.jfree.chart.util

Class RelativeDateFormat


public class RelativeDateFormat
extends DateFormat

A formatter that formats dates to show the elapsed time relative to some base date.
Since:
1.0.3

Constructor Summary

RelativeDateFormat()
Creates a new instance.
RelativeDateFormat(Date time)
Creates a new instance.
RelativeDateFormat(long baseMillis)
Creates a new instance.

Method Summary

Object
clone()
Returns a clone of this instance.
boolean
equals(Object obj)
Tests this formatter for equality with an arbitrary object.
StringBuffer
format(Date date, StringBuffer toAppendTo, FieldPosition fieldPosition)
Formats the given date as the amount of elapsed time (relative to the base date specified in the constructor).
long
getBaseMillis()
Returns the base date/time used to calculate the elapsed time for display.
String
getDaySuffix()
Returns the string that is appended to the day count.
String
getHourSuffix()
Returns the string that is appended to the hour count.
String
getMinuteSuffix()
Returns the string that is appended to the minute count.
String
getSecondSuffix()
Returns the string that is appended to the second count.
boolean
getShowZeroDays()
Returns the flag that controls whether or not zero day counts are shown in the formatted output.
int
hashCode()
Returns a hash code for this instance.
static void
main(String[] args)
Some test code.
Date
parse(String source, ParsePosition pos)
Parses the given string (not implemented).
void
setBaseMillis(long baseMillis)
Sets the base date/time used to calculate the elapsed time for display.
void
setDaySuffix(String suffix)
Sets the string that is appended to the day count.
void
setHourSuffix(String suffix)
Sets the string that is appended to the hour count.
void
setMinuteSuffix(String suffix)
Sets the string that is appended to the minute count.
void
setSecondFormatter(NumberFormat formatter)
Sets the formatter for the seconds and milliseconds.
void
setSecondSuffix(String suffix)
Sets the string that is appended to the second count.
void
setShowZeroDays(boolean show)
Sets the flag that controls whether or not zero day counts are shown in the formatted output.

Constructor Details

RelativeDateFormat

public RelativeDateFormat()
Creates a new instance.

RelativeDateFormat

public RelativeDateFormat(Date time)
Creates a new instance.
Parameters:
time - the date/time (null not permitted).

RelativeDateFormat

public RelativeDateFormat(long baseMillis)
Creates a new instance.
Parameters:
baseMillis - the time zone (null not permitted).

Method Details

clone

public Object clone()
Returns a clone of this instance.
Returns:
A clone.

equals

public boolean equals(Object obj)
Tests this formatter for equality with an arbitrary object.
Parameters:
obj - the object (null permitted).
Returns:
A boolean.

format

public StringBuffer format(Date date,
                           StringBuffer toAppendTo,
                           FieldPosition fieldPosition)
Formats the given date as the amount of elapsed time (relative to the base date specified in the constructor).
Parameters:
date - the date.
toAppendTo - the string buffer.
fieldPosition - the field position.
Returns:
The formatted date.

getBaseMillis

public long getBaseMillis()
Returns the base date/time used to calculate the elapsed time for display.
Returns:
The base date/time in milliseconds since 1-Jan-1970.

getDaySuffix

public String getDaySuffix()
Returns the string that is appended to the day count.
Returns:
The string.

getHourSuffix

public String getHourSuffix()
Returns the string that is appended to the hour count.
Returns:
The string.

getMinuteSuffix

public String getMinuteSuffix()
Returns the string that is appended to the minute count.
Returns:
The string.

getSecondSuffix

public String getSecondSuffix()
Returns the string that is appended to the second count.
Returns:
The string.

getShowZeroDays

public boolean getShowZeroDays()
Returns the flag that controls whether or not zero day counts are shown in the formatted output.
Returns:
The flag.

hashCode

public int hashCode()
Returns a hash code for this instance.
Returns:
A hash code.

main

public static void main(String[] args)
Some test code.
Parameters:
args - ignored.

parse

public Date parse(String source,
                  ParsePosition pos)
Parses the given string (not implemented).
Parameters:
source - the date string.
pos - the parse position.
Returns:
null, as this method has not been implemented.

setBaseMillis

public void setBaseMillis(long baseMillis)
Sets the base date/time used to calculate the elapsed time for display. This should be specified in milliseconds using the same encoding as java.util.Date.
Parameters:
baseMillis - the base date/time in milliseconds.

setDaySuffix

public void setDaySuffix(String suffix)
Sets the string that is appended to the day count.
Parameters:
suffix - the suffix (null not permitted).

setHourSuffix

public void setHourSuffix(String suffix)
Sets the string that is appended to the hour count.
Parameters:
suffix - the suffix (null not permitted).

setMinuteSuffix

public void setMinuteSuffix(String suffix)
Sets the string that is appended to the minute count.
Parameters:
suffix - the suffix (null not permitted).

setSecondFormatter

public void setSecondFormatter(NumberFormat formatter)
Sets the formatter for the seconds and milliseconds.
Parameters:
formatter - the formatter (null not permitted).

setSecondSuffix

public void setSecondSuffix(String suffix)
Sets the string that is appended to the second count.
Parameters:
suffix - the suffix (null not permitted).

setShowZeroDays

public void setShowZeroDays(boolean show)
Sets the flag that controls whether or not zero day counts are shown in the formatted output.
Parameters:
show - the flag.