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
Objectclone()
Returns a clone of this instance.
booleanequals(Object obj)
Tests this formatter for equality with an arbitrary object.
StringBufferformat(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).
longgetBaseMillis()
Returns the base date/time used to calculate the elapsed time for display.
StringgetDaySuffix()
Returns the string that is appended to the day count.
StringgetHourSuffix()
Returns the string that is appended to the hour count.
StringgetMinuteSuffix()
Returns the string that is appended to the minute count.
StringgetPositivePrefix()
Returns the string that is prepended to the format if the relative time is positive.
StringgetSecondSuffix()
Returns the string that is appended to the second count.
booleangetShowZeroDays()
Returns the flag that controls whether or not zero day counts are shown in the formatted output.
booleangetShowZeroHours()
Returns the flag that controls whether or not zero hour counts are shown in the formatted output.
inthashCode()
Returns a hash code for this instance.
static voidmain(String[] args)
Some test code.
Dateparse(String source, ParsePosition pos)
Parses the given string (not implemented).
voidsetBaseMillis(long baseMillis)
Sets the base date/time used to calculate the elapsed time for display.
voidsetDaySuffix(String suffix)
Sets the string that is appended to the day count.
voidsetHourSuffix(String suffix)
Sets the string that is appended to the hour count.
voidsetMinuteSuffix(String suffix)
Sets the string that is appended to the minute count.
voidsetPositivePrefix(String prefix)
Sets the string that is prepended to the format if the relative time is positive.
voidsetSecondFormatter(NumberFormat formatter)
Sets the formatter for the seconds and milliseconds.
voidsetSecondSuffix(String suffix)
Sets the string that is appended to the second count.
voidsetShowZeroDays(boolean show)
Sets the flag that controls whether or not zero day counts are shown in the formatted output.
voidsetShowZeroHours(boolean show)
Sets the flag that controls whether or not zero hour counts are shown in the formatted output.

Constructor Detail

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 Detail

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.

See Also: RelativeDateFormat

getDaySuffix

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

Returns: The string.

See Also: setDaySuffix

getHourSuffix

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

Returns: The string.

See Also: setHourSuffix

getMinuteSuffix

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

Returns: The string.

See Also: setMinuteSuffix

getPositivePrefix

public String getPositivePrefix()
Returns the string that is prepended to the format if the relative time is positive.

Returns: The string (never null).

Since: 1.0.10

See Also:

getSecondSuffix

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

Returns: The string.

See Also: setSecondSuffix

getShowZeroDays

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

Returns: The flag.

See Also: RelativeDateFormat

getShowZeroHours

public boolean getShowZeroHours()
Returns the flag that controls whether or not zero hour counts are shown in the formatted output.

Returns: The flag.

Since: 1.0.10

See Also:

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.

See Also: getBaseMillis

setDaySuffix

public void setDaySuffix(String suffix)
Sets the string that is appended to the day count.

Parameters: suffix the suffix (null not permitted).

See Also: getDaySuffix

setHourSuffix

public void setHourSuffix(String suffix)
Sets the string that is appended to the hour count.

Parameters: suffix the suffix (null not permitted).

See Also: getHourSuffix

setMinuteSuffix

public void setMinuteSuffix(String suffix)
Sets the string that is appended to the minute count.

Parameters: suffix the suffix (null not permitted).

See Also: getMinuteSuffix

setPositivePrefix

public void setPositivePrefix(String prefix)
Sets the string that is prepended to the format if the relative time is positive.

Parameters: prefix the prefix (null not permitted).

Since: 1.0.10

See Also:

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).

See Also: getSecondSuffix

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.

See Also: getShowZeroDays

setShowZeroHours

public void setShowZeroHours(boolean show)
Sets the flag that controls whether or not zero hour counts are shown in the formatted output.

Parameters: show the flag.

Since: 1.0.10

See Also: