Package com.ibm.icu.impl.duration
Interface PeriodBuilder
- All Known Implementing Classes:
FixedUnitBuilder
,MultiUnitBuilder
,OneOrTwoUnitBuilder
,PeriodBuilderImpl
,SingleUnitBuilder
public interface PeriodBuilder
Constructs a Period given a base time and a duration in milliseconds.
PeriodBuilder may be used alone or be set on a DurationFormatter to customize how that formatter constructs a Period for formatting.
None of the operations on PeriodBuilder change the current builder.
-
Method Summary
Modifier and TypeMethodDescriptioncreate
(long duration) Create a period of the given duration using the current system time as the reference time.createWithReferenceDate
(long duration, long referenceDate) Create a period of the given duration using the provided reference date.withLocale
(String localeName) Returns a new PeriodBuilder that uses the provided locale to determine what periods are available for use.withTimeZone
(TimeZone tz) Returns a new PeriodBuilder that computes periods starting at dates in the provided time zone.
-
Method Details
-
create
Create a period of the given duration using the current system time as the reference time.- Parameters:
duration
- the duration in milliseconds from the current time to the target time. A negative duration indicates a time in the past- Returns:
- a Period that represents the duration
-
createWithReferenceDate
Create a period of the given duration using the provided reference date.- Parameters:
duration
- the duration in milliseconds from the referenced time to the target time. A negative duration indicates a time before the reference timereferenceDate
- the reference date from which to compute the period- Returns:
- a Period that represents the duration
-
withLocale
Returns a new PeriodBuilder that uses the provided locale to determine what periods are available for use. -
withTimeZone
Returns a new PeriodBuilder that computes periods starting at dates in the provided time zone.
-