An implementation of PeriodFormatterFactory that provides customization of formatting behavior. Instances of this factory are created by BasicPeriodFormatterService. The settings on BasicPeriodFormatterFactory are:

setDisplayLimit controls whether phrases like 'more than' or 'less than' will be displayed when the Period has a defined limit. Default is to display them.
setDisplayPastFuture controls whether phrases like 'ago' or 'from now' will be displayed to indicate past or future time. Default is to display them.
setSeparatorVariant controls how separators (between count and period, and multiple periods) will be displayed, when appropriate for the language. Default is to use full separators.
setUnitVariant controls which of various types of unit names to use. PLURALIZED indicates that full names will be used. MEDIUM indicates that medium-length (usually 2-3 character) names will be used. SHORT indicates that short (usually single character) names will be used. If there is no localization data available for either the SHORT or MEDIUM names, the other will be used, if neither is available, the PLURALIZED names will be used. Default is PLURALIZED.
setCountVariant controls how the count for the smallest unit will be formatted: either as an integer, a fraction to the smallest half, or as a decimal with 1, 2, or 3 decimal points.

Nested and Inner Type Summary

Modifier and Type	Class and Description
pack-priv static class	BasicPeriodFormatterFactory.Customizations

Field Summary

Modifier and Type	Field and Description
private BasicPeriodFormatterFactory.Customizations	customizations
private boolean	customizationsInUse
private PeriodFormatterData	data
private final PeriodFormatterDataService	ds
private String	localeName

Constructor Summary

Access	Constructor and Description
pack-priv	BasicPeriodFormatterFactory(PeriodFormatterDataService ds)

Method Summary

Modifier and Type	Method and Description
public int	Returns: the count variant getCountVariant() Return the count variant.
pack-priv PeriodFormatterData	getData()
pack-priv PeriodFormatterData	getData(String locName)
public static BasicPeriodFormatterFactory	Returns: a default BasicPeriodFormatterFactory getDefault() Return the default rdf factory as a BasicPeriodFormatterFactory.
public boolean	Returns: true if limits will be displayed getDisplayLimit() Return true if limits will be displayed.
public boolean	Returns: true if past and future will be displayed getDisplayPastFuture() Return true if past and future will be displayed.
public PeriodFormatter	getFormatter() Implements com.ibm.icu.impl.duration.PeriodFormatterFactory.getFormatter. Return a formatter based on this factory's current settings.
public int	Returns: the variant getSeparatorVariant() Return the variant indicating how separators will be displayed.
public int	Returns: the unit variant getUnitVariant() Return the unit variant.
public PeriodFormatterFactory	Returns: this PeriodFormatterFactory setCountVariant(int the variant to use variant) Implements com.ibm.icu.impl.duration.PeriodFormatterFactory.setCountVariant. Set the variant of the count to use.
public PeriodFormatterFactory	Returns: this PeriodFormatterFactory setDisplayLimit(boolean true if limits will be displayed display) Implements com.ibm.icu.impl.duration.PeriodFormatterFactory.setDisplayLimit. Set whether limits will be displayed.
public PeriodFormatterFactory	Returns: this PeriodFormatterFactory setDisplayPastFuture(boolean true if past and future will be displayed display) Implements com.ibm.icu.impl.duration.PeriodFormatterFactory.setDisplayPastFuture. Set whether past and future will be displayed.
public PeriodFormatterFactory	setLocale(String the name of the Locale localeName) Implements com.ibm.icu.impl.duration.PeriodFormatterFactory.setLocale. Set the locale for this factory.
public PeriodFormatterFactory	Returns: this PeriodFormatterFactory setSeparatorVariant(int the variant indicating separators will be displayed variant) Implements com.ibm.icu.impl.duration.PeriodFormatterFactory.setSeparatorVariant. Set how separators will be displayed.
public PeriodFormatterFactory	Returns: this PeriodFormatterFactory setUnitVariant(int the variant to use variant) Implements com.ibm.icu.impl.duration.PeriodFormatterFactory.setUnitVariant. Set the variant of the time unit names to use.
private BasicPeriodFormatterFactory.Customizations	updateCustomizations()

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

Field Detail

customizations	back to summary
private BasicPeriodFormatterFactory.Customizations customizations

customizationsInUse	back to summary
private boolean customizationsInUse

data	back to summary
private PeriodFormatterData data

ds	back to summary
private final PeriodFormatterDataService ds

localeName	back to summary
private String localeName

Constructor Detail

BasicPeriodFormatterFactory	back to summary
pack-priv BasicPeriodFormatterFactory(PeriodFormatterDataService ds)

Method Detail

getCountVariant	back to summary
public int getCountVariant() Return the count variant. Returns:int the count variant

getCountVariant

back to summary

public int getCountVariant()

Return the count variant.

Returns:int: the count variant

getData	back to summary
pack-priv PeriodFormatterData getData()

getData	back to summary
pack-priv PeriodFormatterData getData(String locName)

getDefault	back to summary
public static BasicPeriodFormatterFactory getDefault() Return the default rdf factory as a BasicPeriodFormatterFactory. Returns:BasicPeriodFormatterFactory a default BasicPeriodFormatterFactory

getDefault

back to summary

public static BasicPeriodFormatterFactory getDefault()

Return the default rdf factory as a BasicPeriodFormatterFactory.

Returns:BasicPeriodFormatterFactory: a default BasicPeriodFormatterFactory

getDisplayLimit	back to summary
public boolean getDisplayLimit() Return true if limits will be displayed. Returns:boolean true if limits will be displayed

getDisplayLimit

back to summary

public boolean getDisplayLimit()

Return true if limits will be displayed.

Returns:boolean: true if limits will be displayed

getDisplayPastFuture	back to summary
public boolean getDisplayPastFuture() Return true if past and future will be displayed. Returns:boolean true if past and future will be displayed

getDisplayPastFuture

back to summary

public boolean getDisplayPastFuture()

Return true if past and future will be displayed.

Returns:boolean: true if past and future will be displayed

getFormatter	back to summary
public PeriodFormatter getFormatter() Implements com.ibm.icu.impl.duration.PeriodFormatterFactory.getFormatter. Doc from com.ibm.icu.impl.duration.PeriodFormatterFactory.getFormatter. Return a formatter based on this factory's current settings. Returns:PeriodFormatter a PeriodFormatter Annotations @Override

getFormatter

back to summary

public PeriodFormatter getFormatter()

Implements com.ibm.icu.impl.duration.PeriodFormatterFactory.getFormatter.

Doc from com.ibm.icu.impl.duration.PeriodFormatterFactory.getFormatter.

Return a formatter based on this factory's current settings.

Returns:PeriodFormatter

a PeriodFormatter

Annotations

@Override

getSeparatorVariant	back to summary
public int getSeparatorVariant() Return the variant indicating how separators will be displayed. Returns:int the variant

getSeparatorVariant

back to summary

public int getSeparatorVariant()

Return the variant indicating how separators will be displayed.

Returns:int: the variant

getUnitVariant	back to summary
public int getUnitVariant() Return the unit variant. Returns:int the unit variant

getUnitVariant

back to summary

public int getUnitVariant()

Return the unit variant.

Returns:int: the unit variant

setCountVariant	back to summary
public PeriodFormatterFactory setCountVariant(int variant) Implements com.ibm.icu.impl.duration.PeriodFormatterFactory.setCountVariant. Set the variant of the count to use. Parameters variant:int the variant to use Returns:PeriodFormatterFactory this PeriodFormatterFactory Annotations @Override

setCountVariant

back to summary

public PeriodFormatterFactory setCountVariant(int variant)

Implements com.ibm.icu.impl.duration.PeriodFormatterFactory.setCountVariant.

Set the variant of the count to use.

Parameters

variant:int: the variant to use

Returns:PeriodFormatterFactory

this PeriodFormatterFactory

Annotations

@Override

setDisplayLimit	back to summary
public PeriodFormatterFactory setDisplayLimit(boolean display) Implements com.ibm.icu.impl.duration.PeriodFormatterFactory.setDisplayLimit. Set whether limits will be displayed. Parameters display:boolean true if limits will be displayed Returns:PeriodFormatterFactory this PeriodFormatterFactory Annotations @Override

setDisplayLimit

back to summary

public PeriodFormatterFactory setDisplayLimit(boolean display)

Implements com.ibm.icu.impl.duration.PeriodFormatterFactory.setDisplayLimit.

Set whether limits will be displayed.

Parameters

display:boolean: true if limits will be displayed

Returns:PeriodFormatterFactory

this PeriodFormatterFactory

Annotations

@Override

setDisplayPastFuture	back to summary
public PeriodFormatterFactory setDisplayPastFuture(boolean display) Implements com.ibm.icu.impl.duration.PeriodFormatterFactory.setDisplayPastFuture. Set whether past and future will be displayed. Parameters display:boolean true if past and future will be displayed Returns:PeriodFormatterFactory this PeriodFormatterFactory Annotations @Override

setDisplayPastFuture

back to summary

public PeriodFormatterFactory setDisplayPastFuture(boolean display)

Implements com.ibm.icu.impl.duration.PeriodFormatterFactory.setDisplayPastFuture.

Set whether past and future will be displayed.

Parameters

display:boolean: true if past and future will be displayed

Returns:PeriodFormatterFactory

this PeriodFormatterFactory

Annotations

@Override

setLocale	back to summary
public PeriodFormatterFactory setLocale(String localeName) Implements com.ibm.icu.impl.duration.PeriodFormatterFactory.setLocale. Set the locale for this factory. Parameters localeName:String Doc from com.ibm.icu.impl.duration.PeriodFormatterFactory.setLocale. the name of the Locale Returns:PeriodFormatterFactory Doc from com.ibm.icu.impl.duration.PeriodFormatterFactory.setLocale. this PeriodFormatterFactory Annotations @Override

setLocale

back to summary

public PeriodFormatterFactory setLocale(String localeName)

Implements com.ibm.icu.impl.duration.PeriodFormatterFactory.setLocale.

Set the locale for this factory.

Parameters

localeName:String

Doc from com.ibm.icu.impl.duration.PeriodFormatterFactory.setLocale.

the name of the Locale

Returns:PeriodFormatterFactory

Doc from com.ibm.icu.impl.duration.PeriodFormatterFactory.setLocale.

this PeriodFormatterFactory

Annotations

@Override

setSeparatorVariant	back to summary
public PeriodFormatterFactory setSeparatorVariant(int variant) Implements com.ibm.icu.impl.duration.PeriodFormatterFactory.setSeparatorVariant. Set how separators will be displayed. Parameters variant:int the variant indicating separators will be displayed Returns:PeriodFormatterFactory this PeriodFormatterFactory Annotations @Override

setSeparatorVariant

back to summary

public PeriodFormatterFactory setSeparatorVariant(int variant)

Implements com.ibm.icu.impl.duration.PeriodFormatterFactory.setSeparatorVariant.

Set how separators will be displayed.

Parameters

variant:int: the variant indicating separators will be displayed

Returns:PeriodFormatterFactory

this PeriodFormatterFactory

Annotations

@Override

setUnitVariant	back to summary
public PeriodFormatterFactory setUnitVariant(int variant) Implements com.ibm.icu.impl.duration.PeriodFormatterFactory.setUnitVariant. Set the variant of the time unit names to use. Parameters variant:int the variant to use Returns:PeriodFormatterFactory this PeriodFormatterFactory Annotations @Override

setUnitVariant

back to summary

public PeriodFormatterFactory setUnitVariant(int variant)

Implements com.ibm.icu.impl.duration.PeriodFormatterFactory.setUnitVariant.

Set the variant of the time unit names to use.

Parameters

variant:int: the variant to use

Returns:PeriodFormatterFactory

this PeriodFormatterFactory

Annotations

@Override

updateCustomizations	back to summary
private BasicPeriodFormatterFactory.Customizations updateCustomizations()

com.ibm.icu.impl.duration back to summary

pack-priv Class BasicPeriodFormatterFactory.Customizations

Class Inheritance

extends Object

java.lang.Object
com.ibm.icu.impl.duration.BasicPeriodFormatterFactory.Customizations

Field Summary

Modifier and Type	Field and Description
pack-priv byte	countVariant
pack-priv boolean	displayDirection
pack-priv boolean	displayLimit
pack-priv byte	separatorVariant
pack-priv byte	unitVariant

Constructor Summary

Access	Constructor and Description
pack-priv	Customizations()

Method Summary

Modifier and Type	Method and Description
public BasicPeriodFormatterFactory.Customizations	copy()

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

Field Detail

countVariant	back to summary
pack-priv byte countVariant

displayDirection	back to summary
pack-priv boolean displayDirection

displayLimit	back to summary
pack-priv boolean displayLimit

separatorVariant	back to summary
pack-priv byte separatorVariant

unitVariant	back to summary
pack-priv byte unitVariant

Constructor Detail

Customizations	back to summary
pack-priv Customizations()

Method Detail

copy	back to summary
public BasicPeriodFormatterFactory.Customizations copy()

public Class BasicPeriodFormatterFactory

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv Class BasicPeriodFormatterFactory.Customizations

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail