Modifier and Type	Class and Description
public static class	ICULocaleService.ICUResourceBundleFactory A LocaleKeyFactory that creates a service based on the ICU locale data.
public static class	ICULocaleService.LocaleKey A subclass of Key that implements a locale fallback mechanism.
public abstract static class	ICULocaleService.LocaleKeyFactory A subclass of Factory that uses LocaleKeys.
public static class	ICULocaleService.SimpleLocaleKeyFactory A LocaleKeyFactory that just returns a single object for a kind/locale.

Modifier and Type	Field and Description
private ULocale	fallbackLocale
private String	fallbackLocaleName

Access	Constructor and Description
public	ICULocaleService() Construct an ICULocaleService.
public	ICULocaleService(String name) Construct an ICULocaleService with a name (useful for debugging).

Method Summary

Modifier and Type	Method and Description
public ICUService.Key	createKey(String id) Overrides com.ibm.icu.impl.ICUService.createKey. Create a key from an id. This creates a Key instance.
public ICUService.Key	createKey(String id, int kind)
public ICUService.Key	createKey(ULocale l, int kind)
public Object	get(ULocale locale) Convenience override for callers using locales.
public Object	get(ULocale locale, int kind) Convenience override for callers using locales.
public Object	get(ULocale locale, ULocale[] actualReturn) Convenience override for callers using locales.
public Object	get(ULocale locale, int kind, ULocale[] actualReturn) Convenience override for callers using locales.
public Locale[]	getAvailableLocales() Convenience method for callers using locales.
public ULocale[]	getAvailableULocales() Convenience method for callers using locales.
public ICUService.Factory	registerObject(Object obj, ULocale locale) Convenience override for callers using locales.
public ICUService.Factory	registerObject(Object obj, ULocale locale, boolean visible) Convenience override for callers using locales.
public ICUService.Factory	registerObject(Object obj, ULocale locale, int kind) Convenience function for callers using locales.
public ICUService.Factory	registerObject(Object obj, ULocale locale, int kind, boolean visible) Convenience function for callers using locales.
public String	validateFallbackLocale() Return the name of the current fallback locale.

fallbackLocale	back to summary
private ULocale fallbackLocale

fallbackLocaleName	back to summary
private String fallbackLocaleName

Constructor Detail

ICULocaleService	back to summary
public ICULocaleService() Construct an ICULocaleService.

ICULocaleService	back to summary
public ICULocaleService(String name) Construct an ICULocaleService with a name (useful for debugging).

Method Detail

createKey	back to summary
public ICUService.Key createKey(String id) Overrides com.ibm.icu.impl.ICUService.createKey. Doc from com.ibm.icu.impl.ICUService.createKey. Create a key from an id. This creates a Key instance. Subclasses can override to define more useful keys appropriate to the factories they accept. If id is null, returns null. Annotations @Override

createKey

back to summary

public ICUService.Key createKey(String id)

Overrides com.ibm.icu.impl.ICUService.createKey.

Doc from com.ibm.icu.impl.ICUService.createKey.

Create a key from an id. This creates a Key instance. Subclasses can override to define more useful keys appropriate to the factories they accept. If id is null, returns null.

Annotations

@Override

createKey	back to summary
public ICUService.Key createKey(String id, int kind)

createKey	back to summary
public ICUService.Key createKey(ULocale l, int kind)

get	back to summary
public Object get(ULocale locale) Convenience override for callers using locales. This calls get(ULocale, int, ULocale[]) with KIND_ANY for kind and null for actualReturn.

get	back to summary
public Object get(ULocale locale, int kind) Convenience override for callers using locales. This calls get(ULocale, int, ULocale[]) with a null actualReturn.

get	back to summary
public Object get(ULocale locale, ULocale[] actualReturn) Convenience override for callers using locales. This calls get(ULocale, int, ULocale[]) with KIND_ANY for kind.

get	back to summary
public Object get(ULocale locale, int kind, ULocale[] actualReturn) Convenience override for callers using locales. This uses createKey(ULocale.toString(), kind) to create a key, calls getKey, and then if actualReturn is not null, returns the actualResult from getKey (stripping any prefix) into a ULocale.

getAvailableLocales	back to summary
public Locale[] getAvailableLocales() Convenience method for callers using locales. This returns the standard Locale list, built from the Set of visible ids.

getAvailableULocales	back to summary
public ULocale[] getAvailableULocales() Convenience method for callers using locales. This returns the standard ULocale list, built from the Set of visible ids.

registerObject	back to summary
public ICUService.Factory registerObject(Object obj, ULocale locale) Convenience override for callers using locales. This calls registerObject(Object, ULocale, int kind, boolean visible) passing KIND_ANY for the kind, and true for the visibility.

registerObject	back to summary
public ICUService.Factory registerObject(Object obj, ULocale locale, boolean visible) Convenience override for callers using locales. This calls registerObject(Object, ULocale, int kind, boolean visible) passing KIND_ANY for the kind.

registerObject	back to summary
public ICUService.Factory registerObject(Object obj, ULocale locale, int kind) Convenience function for callers using locales. This calls registerObject(Object, ULocale, int kind, boolean visible) passing true for the visibility.

registerObject	back to summary
public ICUService.Factory registerObject(Object obj, ULocale locale, int kind, boolean visible) Convenience function for callers using locales. This instantiates a SimpleLocaleKeyFactory, and registers the factory.

validateFallbackLocale	back to summary
public String validateFallbackLocale() Return the name of the current fallback locale. If it has changed since this was last accessed, the service cache is cleared.

com.ibm.icu.impl back to summary

public Class ICULocaleService.ICUResourceBundleFactory

Class Inheritance

extends LocaleKeyFactory

java.lang.Object
com.ibm.icu.impl.ICULocaleService.LocaleKeyFactory
com.ibm.icu.impl.ICULocaleService.ICUResourceBundleFactory

A LocaleKeyFactory that creates a service based on the ICU locale data. This is a base class for most ICU factories. Subclasses instantiate it with a constructor that takes a bundle name, which determines the supported IDs. Subclasses then override handleCreate to create the actual service object. The default implementation returns a resource bundle.

Field Summary

Modifier and Type	Field and Description
protected final String	bundleName

Inherited from com.ibm.icu.impl.ICULocaleService.LocaleKeyFactory:: INVISIBLE name visible VISIBLE

Constructor Summary

Access	Constructor and Description
public	ICUResourceBundleFactory() Convenience constructor that uses the main ICU bundle name.
public	ICUResourceBundleFactory(String bundleName) A service factory based on ICU resource data in resources with the given name.

Method Summary

Modifier and Type	Method and Description
protected Set<String>	getSupportedIDs() Overrides com.ibm.icu.impl.ICULocaleService.LocaleKeyFactory.getSupportedIDs. Return the supported IDs.
protected Object	handleCreate(ULocale loc, int kind, ICUService service) Overrides com.ibm.icu.impl.ICULocaleService.LocaleKeyFactory.handleCreate. Create the service.
protected ClassLoader	loader()
public String	toString() Overrides com.ibm.icu.impl.ICULocaleService.LocaleKeyFactory.toString. For debugging.
public void	updateVisibleIDs(Map<String, ICUService.Factory> result) Overrides com.ibm.icu.impl.ICULocaleService.LocaleKeyFactory.updateVisibleIDs. Implements com.ibm.icu.impl.ICUService.Factory.updateVisibleIDs. Override of superclass method.

Inherited from com.ibm.icu.impl.ICULocaleService.LocaleKeyFactory:: create getDisplayName handlesKey isSupportedID

Field Detail

bundleName	back to summary
protected final String bundleName

Constructor Detail

ICUResourceBundleFactory	back to summary
public ICUResourceBundleFactory() Convenience constructor that uses the main ICU bundle name.

ICUResourceBundleFactory	back to summary
public ICUResourceBundleFactory(String bundleName) A service factory based on ICU resource data in resources with the given name.

Method Detail

getSupportedIDs	back to summary
protected Set<String> getSupportedIDs() Overrides com.ibm.icu.impl.ICULocaleService.LocaleKeyFactory.getSupportedIDs. Return the supported IDs. This is the set of all locale names for the bundleName. Annotations @Override

getSupportedIDs

back to summary

protected Set<String> getSupportedIDs()

Overrides com.ibm.icu.impl.ICULocaleService.LocaleKeyFactory.getSupportedIDs.

Return the supported IDs. This is the set of all locale names for the bundleName.

Annotations

@Override

handleCreate	back to summary
protected Object handleCreate(ULocale loc, int kind, ICUService service) Overrides com.ibm.icu.impl.ICULocaleService.LocaleKeyFactory.handleCreate. Create the service. The default implementation returns the resource bundle for the locale, ignoring kind, and service. Annotations @Override

handleCreate

back to summary

protected Object handleCreate(ULocale loc, int kind, ICUService service)

Overrides com.ibm.icu.impl.ICULocaleService.LocaleKeyFactory.handleCreate.

Create the service. The default implementation returns the resource bundle for the locale, ignoring kind, and service.

Annotations

@Override

loader	back to summary
protected ClassLoader loader()

toString	back to summary
public String toString() Overrides com.ibm.icu.impl.ICULocaleService.LocaleKeyFactory.toString. Doc from com.ibm.icu.impl.ICULocaleService.LocaleKeyFactory.toString. For debugging. Returns:String Doc from java.lang.Object.toString. a string representation of the object. Annotations @Override

toString

back to summary

public String toString()

Overrides com.ibm.icu.impl.ICULocaleService.LocaleKeyFactory.toString.

Doc from com.ibm.icu.impl.ICULocaleService.LocaleKeyFactory.toString.

For debugging.

Returns:String

Doc from java.lang.Object.toString.

a string representation of the object.

Annotations

@Override

updateVisibleIDs	back to summary
public void updateVisibleIDs(Map<String, ICUService.Factory> result) Overrides com.ibm.icu.impl.ICULocaleService.LocaleKeyFactory.updateVisibleIDs. Implements com.ibm.icu.impl.ICUService.Factory.updateVisibleIDs. Override of superclass method. Annotations @Override

updateVisibleIDs

back to summary

public void updateVisibleIDs(Map<String, ICUService.Factory> result)

Overrides com.ibm.icu.impl.ICULocaleService.LocaleKeyFactory.updateVisibleIDs.

Implements com.ibm.icu.impl.ICUService.Factory.updateVisibleIDs.

Override of superclass method.

Annotations

@Override

com.ibm.icu.impl back to summary

public Class ICULocaleService.LocaleKey

Class Inheritance

extends Key

java.lang.Object
com.ibm.icu.impl.ICUService.Key
com.ibm.icu.impl.ICULocaleService.LocaleKey

A subclass of Key that implements a locale fallback mechanism. The first locale to search for is the locale provided by the client, and the fallback locale to search for is the current default locale. If a prefix is present, the currentDescriptor includes it before the locale proper, separated by "/". This is the default key instantiated by ICULocaleService.

Canonicalization adjusts the locale string so that the section before the first understore is in lower case, and the rest is in upper case, with no trailing underscores.

Field Summary

Modifier and Type	Field and Description
private String	currentID
private String	fallbackID
private int	kind
public static final int	KIND_ANY
private String	primaryID
private int	varstart

Constructor Summary

Access	Constructor and Description
protected	LocaleKey(String primaryID, String canonicalPrimaryID, String canonicalFallbackID, int kind) PrimaryID is the user's requested locale string, canonicalPrimaryID is this string in canonical form, fallbackID is the current default locale's string in canonical form.

Method Summary

Modifier and Type	Method and Description
public String	canonicalID() Overrides com.ibm.icu.impl.ICUService.Key.canonicalID. Return the (canonical) original ID.
public ULocale	canonicalLocale() Convenience method to return the locale corresponding to the (canonical) original ID.
public static ICULocaleService.LocaleKey	createWithCanonical(ULocale locale, String canonicalFallbackID, int kind) Create a LocaleKey with canonical primary and fallback IDs.
public static ICULocaleService.LocaleKey	createWithCanonicalFallback(String primaryID, String canonicalFallbackID) Create a LocaleKey with canonical primary and fallback IDs.
public static ICULocaleService.LocaleKey	createWithCanonicalFallback(String primaryID, String canonicalFallbackID, int kind) Create a LocaleKey with canonical primary and fallback IDs.
public String	currentDescriptor() Overrides com.ibm.icu.impl.ICUService.Key.currentDescriptor. Return the (canonical) current descriptor, or null if no current id. Includes the keywords, whereas the ID does not include keywords.
public String	currentID() Overrides com.ibm.icu.impl.ICUService.Key.currentID. Return the (canonical) current ID, or null if no current id.
public ULocale	currentLocale() Convenience method to return the ulocale corresponding to the (canonical) currentID.
public boolean	fallback() Overrides com.ibm.icu.impl.ICUService.Key.fallback. If the key has a fallback, modify the key and return true, otherwise return false.
public boolean	isFallbackOf(String id) Overrides com.ibm.icu.impl.ICUService.Key.isFallbackOf. If a key created from id would eventually fallback to match the canonical ID of this key, return true.
public int	kind() Return the kind code associated with this key.
public String	prefix() Return the prefix associated with the kind, or null if the kind is KIND_ANY.

Inherited from com.ibm.icu.impl.ICUService.Key:: id

Field Detail

currentID	back to summary
private String currentID

fallbackID	back to summary
private String fallbackID

kind	back to summary
private int kind

KIND_ANY	back to summary
public static final int KIND_ANY

primaryID	back to summary
private String primaryID

varstart	back to summary
private int varstart

Constructor Detail

LocaleKey	back to summary
protected LocaleKey(String primaryID, String canonicalPrimaryID, String canonicalFallbackID, int kind) PrimaryID is the user's requested locale string, canonicalPrimaryID is this string in canonical form, fallbackID is the current default locale's string in canonical form.

Method Detail

canonicalID	back to summary
public String canonicalID() Overrides com.ibm.icu.impl.ICUService.Key.canonicalID. Return the (canonical) original ID. Annotations @Override

canonicalID

back to summary

public String canonicalID()

Overrides com.ibm.icu.impl.ICUService.Key.canonicalID.

Return the (canonical) original ID.

Annotations

@Override

canonicalLocale	back to summary
public ULocale canonicalLocale() Convenience method to return the locale corresponding to the (canonical) original ID.

createWithCanonical	back to summary
public static ICULocaleService.LocaleKey createWithCanonical(ULocale locale, String canonicalFallbackID, int kind) Create a LocaleKey with canonical primary and fallback IDs.

createWithCanonicalFallback	back to summary
public static ICULocaleService.LocaleKey createWithCanonicalFallback(String primaryID, String canonicalFallbackID) Create a LocaleKey with canonical primary and fallback IDs.

createWithCanonicalFallback	back to summary
public static ICULocaleService.LocaleKey createWithCanonicalFallback(String primaryID, String canonicalFallbackID, int kind) Create a LocaleKey with canonical primary and fallback IDs.

currentDescriptor	back to summary
public String currentDescriptor() Overrides com.ibm.icu.impl.ICUService.Key.currentDescriptor. Return the (canonical) current descriptor, or null if no current id. Includes the keywords, whereas the ID does not include keywords. Annotations @Override

currentDescriptor

back to summary

public String currentDescriptor()

Overrides com.ibm.icu.impl.ICUService.Key.currentDescriptor.

Return the (canonical) current descriptor, or null if no current id. Includes the keywords, whereas the ID does not include keywords.

Annotations

@Override

currentID	back to summary
public String currentID() Overrides com.ibm.icu.impl.ICUService.Key.currentID. Return the (canonical) current ID, or null if no current id. Annotations @Override

currentID

back to summary

public String currentID()

Overrides com.ibm.icu.impl.ICUService.Key.currentID.

Return the (canonical) current ID, or null if no current id.

Annotations

@Override

currentLocale	back to summary
public ULocale currentLocale() Convenience method to return the ulocale corresponding to the (canonical) currentID.

fallback

back to summary

public boolean fallback()

Overrides com.ibm.icu.impl.ICUService.Key.fallback.

If the key has a fallback, modify the key and return true, otherwise return false.

First falls back through the primary ID, then through the fallbackID. The final fallback is "" (root) unless the primary id was "" (root), in which case there is no fallback.

Annotations

@Override

isFallbackOf

back to summary

public boolean isFallbackOf(String id)

Overrides com.ibm.icu.impl.ICUService.Key.isFallbackOf.

If a key created from id would eventually fallback to match the canonical ID of this key, return true.

Annotations

@Override

kind	back to summary
public int kind() Return the kind code associated with this key.

prefix	back to summary
public String prefix() Return the prefix associated with the kind, or null if the kind is KIND_ANY.

com.ibm.icu.impl back to summary

public abstract Class ICULocaleService.LocaleKeyFactory

Class Inheritance

extends Object
implements Factory

java.lang.Object
com.ibm.icu.impl.ICULocaleService.LocaleKeyFactory

All Implemented Interfaces

com.ibm.icu.impl.ICUService.Factory

Known Direct Subclasses

com.ibm.icu.impl.ICULocaleService.SimpleLocaleKeyFactory, com.ibm.icu.impl.ICULocaleService.ICUResourceBundleFactory, com.ibm.icu.text.NumberFormatServiceShim.NFFactory

A subclass of Factory that uses LocaleKeys. If 'visible' the factory reports its IDs.

Field Summary

Modifier and Type	Field and Description
public static final boolean	INVISIBLE
protected final String	name
protected final boolean	visible
public static final boolean	VISIBLE

Constructor Summary

Access	Constructor and Description
protected	LocaleKeyFactory(boolean visible) Constructor used by subclasses.
protected	LocaleKeyFactory(boolean visible, String name) Constructor used by subclasses.

Method Summary

Modifier and Type	Method and Description
public Object	create(ICUService.Key key, ICUService service) Implements com.ibm.icu.impl.ICUService.Factory.create. Implement superclass abstract method.
public String	getDisplayName(String id, ULocale locale) Implements com.ibm.icu.impl.ICUService.Factory.getDisplayName. Return a localized name for the locale represented by id.
protected Set<String>	getSupportedIDs() Return the set of ids that this factory supports (visible or otherwise).
protected Object	handleCreate(ULocale loc, int kind, ICUService service) Utility method used by create(Key, ICUService).
protected boolean	handlesKey(ICUService.Key key)
protected boolean	isSupportedID(String id) Return true if this id is one the factory supports (visible or otherwise).
public String	toString() Overrides java.lang.Object.toString. For debugging.
public void	updateVisibleIDs(Map<String, ICUService.Factory> result) Implements com.ibm.icu.impl.ICUService.Factory.updateVisibleIDs. Override of superclass method.

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

Field Detail

INVISIBLE	back to summary
public static final boolean INVISIBLE

name	back to summary
protected final String name

visible	back to summary
protected final boolean visible

VISIBLE	back to summary
public static final boolean VISIBLE

Constructor Detail

LocaleKeyFactory	back to summary
protected LocaleKeyFactory(boolean visible) Constructor used by subclasses.

LocaleKeyFactory	back to summary
protected LocaleKeyFactory(boolean visible, String name) Constructor used by subclasses.

Method Detail

create

back to summary

public Object create(ICUService.Key key, ICUService service)

Implements com.ibm.icu.impl.ICUService.Factory.create.

Implement superclass abstract method. This checks the currentID of the key against the supported IDs, and passes the canonicalLocale and kind off to handleCreate (which subclasses must implement).

Annotations

@Override

getDisplayName

back to summary

public String getDisplayName(String id, ULocale locale)

Implements com.ibm.icu.impl.ICUService.Factory.getDisplayName.

Return a localized name for the locale represented by id.

Annotations

@Override

getSupportedIDs	back to summary
protected Set<String> getSupportedIDs() Return the set of ids that this factory supports (visible or otherwise). This can be called often and might need to be cached if it is expensive to create.

handleCreate	back to summary
protected Object handleCreate(ULocale loc, int kind, ICUService service) Utility method used by create(Key, ICUService). Subclasses can implement this instead of create.

handlesKey	back to summary
protected boolean handlesKey(ICUService.Key key)

isSupportedID	back to summary
protected boolean isSupportedID(String id) Return true if this id is one the factory supports (visible or otherwise).

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

For debugging.

Returns:String

Doc from java.lang.Object.toString.

a string representation of the object.

Annotations

@Override

updateVisibleIDs

back to summary

public void updateVisibleIDs(Map<String, ICUService.Factory> result)

Implements com.ibm.icu.impl.ICUService.Factory.updateVisibleIDs.

Override of superclass method.

Annotations

@Override

com.ibm.icu.impl back to summary

public Class ICULocaleService.SimpleLocaleKeyFactory

Class Inheritance

extends LocaleKeyFactory

java.lang.Object
com.ibm.icu.impl.ICULocaleService.LocaleKeyFactory
com.ibm.icu.impl.ICULocaleService.SimpleLocaleKeyFactory

A LocaleKeyFactory that just returns a single object for a kind/locale.

Field Summary

Modifier and Type	Field and Description
private final String	id
private final int	kind
private final Object	obj

Inherited from com.ibm.icu.impl.ICULocaleService.LocaleKeyFactory:: INVISIBLE name visible VISIBLE

Constructor Summary

Access	Constructor and Description
public	SimpleLocaleKeyFactory(Object obj, ULocale locale, int kind, boolean visible)
public	SimpleLocaleKeyFactory(Object obj, ULocale locale, int kind, boolean visible, String name)

Method Summary

Modifier and Type	Method and Description
public Object	create(ICUService.Key key, ICUService service) Overrides com.ibm.icu.impl.ICULocaleService.LocaleKeyFactory.create. Implements com.ibm.icu.impl.ICUService.Factory.create. Returns the service object if kind/locale match.
protected boolean	isSupportedID(String idToCheck) Overrides com.ibm.icu.impl.ICULocaleService.LocaleKeyFactory.isSupportedID. Return true if this id is one the factory supports (visible or otherwise).
public String	toString() Overrides com.ibm.icu.impl.ICULocaleService.LocaleKeyFactory.toString. For debugging.
public void	updateVisibleIDs(Map<String, ICUService.Factory> result) Overrides com.ibm.icu.impl.ICULocaleService.LocaleKeyFactory.updateVisibleIDs. Implements com.ibm.icu.impl.ICUService.Factory.updateVisibleIDs. Override of superclass method.