International Components for Unicode for Java (icu4j) 74.2 · com.ibm.icu.impl.duration.BasicDurationFormatter

Modifier and Type	Field and Description
private PeriodBuilder	builder
private DateFormatter	fallback
private long	fallbackLimit
private PeriodFormatter	formatter
private String	localeName
private TimeZone	timeZone

Access	Constructor and Description
public	BasicDurationFormatter(PeriodFormatter formatter, PeriodBuilder builder, DateFormatter fallback, long fallbackLimit) Creates a basic duration formatter with the given formatter, builder, and fallback.
protected	BasicDurationFormatter(PeriodFormatter formatter, PeriodBuilder builder, DateFormatter fallback, long fallbackLimit, String localeName, TimeZone timeZone)

Method Summary

Modifier and Type	Method and Description
protected Period	doBuild(long duration, long referenceDate)
protected String	doFallback(long duration, long referenceDate)
protected String	doFormat(Period period)
public String	formatDurationFrom(long the duration in milliseconds duration, long the date from which to compute the duration referenceDate) Implements com.ibm.icu.impl.duration.DurationFormatter.formatDurationFrom. Formats a duration expressed in milliseconds from a reference date.
public String	formatDurationFromNow(long the duration in milliseconds duration) Implements com.ibm.icu.impl.duration.DurationFormatter.formatDurationFromNow. Formats a duration expressed in milliseconds.
public String	formatDurationFromNowTo(Date the ending date targetDate) Implements com.ibm.icu.impl.duration.DurationFormatter.formatDurationFromNowTo. Formats the duration between now and a target date.
public DurationFormatter	withLocale(String the name of the new locale locName) Implements com.ibm.icu.impl.duration.DurationFormatter.withLocale. Returns a new DurationFormatter that's the same as this one but formats for a new locale.
public DurationFormatter	withTimeZone(TimeZone the time zone in which to compute durations. tz) Implements com.ibm.icu.impl.duration.DurationFormatter.withTimeZone. Returns a new DurationFormatter that's the same as this one but uses a different time zone.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

builder	back to summary
private PeriodBuilder builder

fallback	back to summary
private DateFormatter fallback

fallbackLimit	back to summary
private long fallbackLimit

formatter	back to summary
private PeriodFormatter formatter

localeName	back to summary
private String localeName

timeZone	back to summary
private TimeZone timeZone

BasicDurationFormatter	back to summary
public BasicDurationFormatter(PeriodFormatter formatter, PeriodBuilder builder, DateFormatter fallback, long fallbackLimit) Creates a basic duration formatter with the given formatter, builder, and fallback. It's up to the caller to ensure that the locales and timezones of these are in sync.

BasicDurationFormatter	back to summary
protected BasicDurationFormatter(PeriodFormatter formatter, PeriodBuilder builder, DateFormatter fallback, long fallbackLimit, String localeName, TimeZone timeZone)

Method Detail

doBuild	back to summary
protected Period doBuild(long duration, long referenceDate)

doFallback	back to summary
protected String doFallback(long duration, long referenceDate)

doFormat	back to summary
protected String doFormat(Period period)

formatDurationFrom	back to summary
public String formatDurationFrom(long duration, long referenceDate) Implements com.ibm.icu.impl.duration.DurationFormatter.formatDurationFrom. Doc from com.ibm.icu.impl.duration.DurationFormatter.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 Annotations @Override

formatDurationFrom

back to summary

public String formatDurationFrom(long duration, long referenceDate)

Implements com.ibm.icu.impl.duration.DurationFormatter.formatDurationFrom.

Doc from com.ibm.icu.impl.duration.DurationFormatter.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

Annotations

@Override

formatDurationFromNow	back to summary
public String formatDurationFromNow(long duration) Implements com.ibm.icu.impl.duration.DurationFormatter.formatDurationFromNow. Doc from com.ibm.icu.impl.duration.DurationFormatter.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 Annotations @Override

formatDurationFromNow

back to summary

public String formatDurationFromNow(long duration)

Implements com.ibm.icu.impl.duration.DurationFormatter.formatDurationFromNow.

Doc from com.ibm.icu.impl.duration.DurationFormatter.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

Annotations

@Override

formatDurationFromNowTo back to summary

formatDurationFromNowTo	back to summary
public String formatDurationFromNowTo(Date targetDate) Implements com.ibm.icu.impl.duration.DurationFormatter.formatDurationFromNowTo. Doc from com.ibm.icu.impl.duration.DurationFormatter.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 Annotations @Override

public String formatDurationFromNowTo(Date targetDate)

Implements com.ibm.icu.impl.duration.DurationFormatter.formatDurationFromNowTo.

Doc from com.ibm.icu.impl.duration.DurationFormatter.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

Annotations

@Override

withLocale	back to summary
public DurationFormatter withLocale(String locName) Implements com.ibm.icu.impl.duration.DurationFormatter.withLocale. Doc from com.ibm.icu.impl.duration.DurationFormatter.withLocale. Returns a new DurationFormatter that's the same as this one but formats for a new locale. Parameters locName:String the name of the new locale Returns:DurationFormatter a new formatter for the given locale Annotations @Override

withLocale

back to summary

public DurationFormatter withLocale(String locName)

Implements com.ibm.icu.impl.duration.DurationFormatter.withLocale.

Doc from com.ibm.icu.impl.duration.DurationFormatter.withLocale.

Returns a new DurationFormatter that's the same as this one but formats for a new locale.

Parameters

locName:String: the name of the new locale

Returns:DurationFormatter

a new formatter for the given locale

Annotations

@Override

withTimeZone	back to summary
public DurationFormatter withTimeZone(TimeZone tz) Implements com.ibm.icu.impl.duration.DurationFormatter.withTimeZone. Doc from com.ibm.icu.impl.duration.DurationFormatter.withTimeZone. Returns a new DurationFormatter that's the same as this one but uses a different time zone. Parameters tz:TimeZone the time zone in which to compute durations. Returns:DurationFormatter a new formatter for the given locale Annotations @Override

withTimeZone

back to summary

public DurationFormatter withTimeZone(TimeZone tz)

Implements com.ibm.icu.impl.duration.DurationFormatter.withTimeZone.

Doc from com.ibm.icu.impl.duration.DurationFormatter.withTimeZone.

Returns a new DurationFormatter that's the same as this one but uses a different time zone.

Parameters

tz:TimeZone: the time zone in which to compute durations.

Returns:DurationFormatter

a new formatter for the given locale

Annotations

@Override

pack-priv Class BasicDurationFormatter

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail