RelativeDateFormat

java.lang.Object
- java.text.Format
- - java.text.DateFormat
  - - org.jfree.chart.util.RelativeDateFormat

All Implemented Interfaces:

Serializable, Cloneable
```
public class RelativeDateFormat
extends DateFormat
```
A formatter that formats dates to show the elapsed time relative to some base date.

Since:

1.0.3

See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from class java.text.DateFormat
  DateFormat.Field

Field Summary
- Fields inherited from class java.text.DateFormat
  AM_PM_FIELD, DATE_FIELD, DAY_OF_WEEK_FIELD, DAY_OF_WEEK_IN_MONTH_FIELD, DAY_OF_YEAR_FIELD, DEFAULT, ERA_FIELD, FULL, HOUR_OF_DAY0_FIELD, HOUR_OF_DAY1_FIELD, HOUR0_FIELD, HOUR1_FIELD, LONG, MEDIUM, MILLISECOND_FIELD, MINUTE_FIELD, MONTH_FIELD, SECOND_FIELD, SHORT, TIMEZONE_FIELD, WEEK_OF_MONTH_FIELD, WEEK_OF_YEAR_FIELD, YEAR_FIELD

Constructor Summary

Constructors
Constructor and Description
`RelativeDateFormat()` Creates a new instance with base milliseconds set to zero.
`RelativeDateFormat(Date time)` Creates a new instance.
`RelativeDateFormat(long baseMillis)` Creates a new instance.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`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`	`getPositivePrefix()` Returns the string that is prepended to the format if the relative time is positive.
`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.
`boolean`	`getShowZeroHours()` Returns the flag that controls whether or not zero hour counts are shown in the formatted output.
`int`	`hashCode()` Returns a hash code for this instance.
`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`	`setDayFormatter(NumberFormat formatter)` Sets the formatter for the days.
`void`	`setDaySuffix(String suffix)` Sets the string that is appended to the day count.
`void`	`setHourFormatter(NumberFormat formatter)` Sets the formatter for the hours.
`void`	`setHourSuffix(String suffix)` Sets the string that is appended to the hour count.
`void`	`setMinuteFormatter(NumberFormat formatter)` Sets the formatter for the minutes.
`void`	`setMinuteSuffix(String suffix)` Sets the string that is appended to the minute count.
`void`	`setPositivePrefix(String prefix)` Sets the string that is prepended to the format if the relative time is positive.
`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.
`void`	`setShowZeroHours(boolean show)` Sets the flag that controls whether or not zero hour counts are shown in the formatted output.

Methods inherited from class java.text.DateFormat
format, format, getAvailableLocales, getCalendar, getDateInstance, getDateInstance, getDateInstance, getDateTimeInstance, getDateTimeInstance, getDateTimeInstance, getInstance, getNumberFormat, getTimeInstance, getTimeInstance, getTimeInstance, getTimeZone, isLenient, parse, parseObject, setCalendar, setLenient, setNumberFormat, setTimeZone

Methods inherited from class java.text.Format
format, formatToCharacterIterator, parseObject

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - RelativeDateFormat
```
public RelativeDateFormat()
```
    Creates a new instance with base milliseconds set to zero.
  - 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
  - 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:
    
    setBaseMillis(long)
  - 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()
  - 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:
    
    setShowZeroDays(boolean)
  - 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()
  - 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:
    
    setShowZeroHours(boolean)
  - 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:
    
    getShowZeroHours()
  - 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:
    
    setPositivePrefix(String)
  - 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:
    
    getPositivePrefix()
  - setDayFormatter
```
public void setDayFormatter(NumberFormat formatter)
```
    Sets the formatter for the days.
    
    Parameters:
    
    formatter - the formatter (null not permitted).
    
    Since:
    
    1.0.11
  - getDaySuffix
```
public String getDaySuffix()
```
    Returns the string that is appended to the day count.
    
    Returns:
    
    The string.
    
    See Also:
    
    setDaySuffix(String)
  - 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()
  - setHourFormatter
```
public void setHourFormatter(NumberFormat formatter)
```
    Sets the formatter for the hours.
    
    Parameters:
    
    formatter - the formatter (null not permitted).
    
    Since:
    
    1.0.11
  - getHourSuffix
```
public String getHourSuffix()
```
    Returns the string that is appended to the hour count.
    
    Returns:
    
    The string.
    
    See Also:
    
    setHourSuffix(String)
  - 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()
  - setMinuteFormatter
```
public void setMinuteFormatter(NumberFormat formatter)
```
    Sets the formatter for the minutes.
    
    Parameters:
    
    formatter - the formatter (null not permitted).
    
    Since:
    
    1.0.11
  - getMinuteSuffix
```
public String getMinuteSuffix()
```
    Returns the string that is appended to the minute count.
    
    Returns:
    
    The string.
    
    See Also:
    
    setMinuteSuffix(String)
  - 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()
  - getSecondSuffix
```
public String getSecondSuffix()
```
    Returns the string that is appended to the second count.
    
    Returns:
    
    The string.
    
    See Also:
    
    setSecondSuffix(String)
  - 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()
  - setSecondFormatter
```
public void setSecondFormatter(NumberFormat formatter)
```
    Sets the formatter for the seconds and milliseconds.
    
    Parameters:
    
    formatter - the formatter (null not permitted).
  - 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).
    
    Specified by:
    
    format in class DateFormat
    
    Parameters:
    
    date - the date.
    
    toAppendTo - the string buffer.
    
    fieldPosition - the field position.
    
    Returns:
    
    The formatted date.
  - parse
```
public Date parse(String source,
                  ParsePosition pos)
```
    Parses the given string (not implemented).
    
    Specified by:
    
    parse in class DateFormat
    
    Parameters:
    
    source - the date string.
    
    pos - the parse position.
    
    Returns:
    
    null, as this method has not been implemented.
  - equals
```
public boolean equals(Object obj)
```
    Tests this formatter for equality with an arbitrary object.
    
    Overrides:
    
    equals in class DateFormat
    
    Parameters:
    
    obj - the object (null permitted).
    
    Returns:
    
    A boolean.
  - hashCode
```
public int hashCode()
```
    Returns a hash code for this instance.
    
    Overrides:
    
    hashCode in class DateFormat
    
    Returns:
    
    A hash code.
  - clone
```
public Object clone()
```
    Returns a clone of this instance.
    
    Overrides:
    
    clone in class DateFormat
    
    Returns:
    
    A clone.

Class RelativeDateFormat

Nested Class Summary

Nested classes/interfaces inherited from class java.text.DateFormat

Field Summary

Fields inherited from class java.text.DateFormat

Constructor Summary

Method Summary

Methods inherited from class java.text.DateFormat

Methods inherited from class java.text.Format

Methods inherited from class java.lang.Object

Constructor Detail

RelativeDateFormat

RelativeDateFormat

RelativeDateFormat

Method Detail

getBaseMillis

setBaseMillis

getShowZeroDays

setShowZeroDays

getShowZeroHours

setShowZeroHours

getPositivePrefix

setPositivePrefix

setDayFormatter

getDaySuffix

setDaySuffix

setHourFormatter

getHourSuffix

setHourSuffix

setMinuteFormatter

getMinuteSuffix

setMinuteSuffix

getSecondSuffix

setSecondSuffix

setSecondFormatter

format

parse

equals

hashCode

clone