Top Fields Constructors Methods
com.ibm.icu.impl.duration

public Class BasicDurationFormat

extends DurationFormat
Class Inheritance
Imports
java.text.FieldPosition, java.util.Date, com.ibm.icu.text.DurationFormat, com.ibm.icu.util.ULocale

Deprecated

as a consequence of DurationFormat being deprecated. See corresponding docs for further information.

Author
srl

Field Summary

Modifier and TypeField and Description
pack-priv transient DurationFormatter
formatter

pack-priv transient PeriodFormatter
pformatter

pack-priv transient PeriodFormatterService
pfs

private static final long
serialVersionUID

Hides com.ibm.icu.text.DurationFormat.serialVersionUID.

Constructor Summary

AccessConstructor and Description
public
BasicDurationFormat()

public
BasicDurationFormat(ULocale locale)

Method Summary

Modifier and TypeMethod and Description
public StringBuffer
format(Object
the object to format. Should be either a Long, Date, or javax.xml.datatype.Duration object.
object, StringBuffer
the buffer to append to
toAppend, FieldPosition
the field position, may contain additional error messages.
pos)

Implements abstract com.ibm.icu.text.DurationFormat.format.

Format an arbitrary object.
public String

Returns:

The PeriodFormatter object formatted to the object passed.
formatDuration(Object
Object being passed.
obj)

JDK 1.5+ only

public String
formatDurationFrom(long
the duration in milliseconds
duration, long
the date from which to compute the duration
referenceDate)

Implements abstract com.ibm.icu.text.DurationFormat.formatDurationFrom.

Formats a duration expressed in milliseconds from a reference date.
public String
formatDurationFromNow(long
the duration in milliseconds
duration)

Implements abstract com.ibm.icu.text.DurationFormat.formatDurationFromNow.

Formats a duration expressed in milliseconds.
public String
formatDurationFromNowTo(Date
the ending date
targetDate)

Implements abstract com.ibm.icu.text.DurationFormat.formatDurationFromNowTo.

Formats the duration between now and a target date.
public static BasicDurationFormat
getInstance(ULocale locale)

Hides com.ibm.icu.text.DurationFormat.getInstance.

Deprecated as a consequence of BasicDurationFormat being deprecated.
Construct a duration format for the specified locale
Inherited from com.ibm.icu.text.DurationFormat:
parseObject

Field Detail

formatterback to summary
pack-priv transient DurationFormatter formatter
pformatterback to summary
pack-priv transient PeriodFormatter pformatter
pfsback to summary
pack-priv transient PeriodFormatterService pfs
serialVersionUIDback to summary
private static final long serialVersionUID

Hides com.ibm.icu.text.DurationFormat.serialVersionUID.

Constructor Detail

BasicDurationFormatback to summary
public BasicDurationFormat()
BasicDurationFormatback to summary
public BasicDurationFormat(ULocale locale)

Method Detail

formatback to summary
public StringBuffer format(Object object, StringBuffer toAppend, FieldPosition pos)

Implements abstract com.ibm.icu.text.DurationFormat.format.

Doc from com.ibm.icu.text.DurationFormat.format.

Format an arbitrary object. Defaults to a call to formatDurationFromNow() for either Long or Date objects.

Parameters
object:Object

the object to format. Should be either a Long, Date, or javax.xml.datatype.Duration object.

toAppend:StringBuffer

the buffer to append to

pos:FieldPosition

the field position, may contain additional error messages.

Returns:StringBuffer

the toAppend buffer

formatDurationback to summary
public String formatDuration(Object obj)

JDK 1.5+ only

Parameters
obj:Object

Object being passed.

Returns:String

The PeriodFormatter object formatted to the object passed.

See Also
http://java.sun.com/j2se/1.5.0/docs/api/javax/xml/datatype/Duration.html
formatDurationFromback to summary
public String formatDurationFrom(long duration, long referenceDate)

Implements abstract com.ibm.icu.text.DurationFormat.formatDurationFrom.

Doc from com.ibm.icu.text.DurationFormat.formatDurationFrom.

Formats a duration expressed in milliseconds from a reference date.

The reference date allows formatters to use actual durations of variable-length periods (like months) if they wish.

The duration is expressed as the number of milliseconds in the past (negative values) or future (positive values) with respect to a reference date (expressed as milliseconds in epoch).

Parameters
duration:long

the duration in milliseconds

referenceDate:long

the date from which to compute the duration

Returns:String

the formatted time

formatDurationFromNowback to summary
public String formatDurationFromNow(long duration)

Implements abstract com.ibm.icu.text.DurationFormat.formatDurationFromNow.

Doc from com.ibm.icu.text.DurationFormat.formatDurationFromNow.

Formats a duration expressed in milliseconds.

This is a convenience method that calls formatDurationFrom using the current system time as the reference date.

Parameters
duration:long

the duration in milliseconds

Returns:String

the formatted time

formatDurationFromNowToback to summary
public String formatDurationFromNowTo(Date targetDate)

Implements abstract com.ibm.icu.text.DurationFormat.formatDurationFromNowTo.

Doc from com.ibm.icu.text.DurationFormat.formatDurationFromNowTo.

Formats the duration between now and a target date.

This is a convenience method that calls formatDurationFrom(long, long) using now as the reference date, and the difference between now and targetDate.getTime() as the duration.

Parameters
targetDate:Date

the ending date

Returns:String

the formatted time

getInstanceback to summary
public static BasicDurationFormat getInstance(ULocale locale)

Hides com.ibm.icu.text.DurationFormat.getInstance.

Doc from com.ibm.icu.text.DurationFormat.getInstance.

Deprecated

as a consequence of BasicDurationFormat being deprecated. See corresponding docs for further information.

Construct a duration format for the specified locale