A Service provides access to service objects that implement a particular service, e.g. transliterators. Users provide a String id (for example, a locale string) to the service, and get back an object for that id. Service objects can be any kind of object. The service object is cached and returned for later queries, so generally it should not be mutable, or the caller should clone the object before modifying it.
Services 'canonicalize' the query id and use the canonical id to query for the service. The service also defines a mechanism to 'fallback' the id multiple times. Clients can optionally request the actual id that was matched by a query when they use an id to retrieve a service object.
Service objects are instantiated by Factory objects registered with the service. The service queries each Factory in turn, from most recently registered to earliest registered, until one returns a service object. If none responds with a service object, a fallback id is generated, and the process repeats until a service object is returned or until the id has no further fallbacks.
Factories can be dynamically registered and unregistered with the service. When registered, a Factory is installed at the head of the factory list, and so gets 'first crack' at any keys or fallback keys. When unregistered, it is removed from the service and can no longer be located through it. Service objects generated by this factory and held by the client are unaffected.
ICUService uses Keys to query factories and perform fallback. The Key defines the canonical form of the id, and implements the fallback strategy. Custom Keys can be defined that parse complex IDs into components that Factories can more easily use. The Key can cache the results of this parsing to save repeated effort. ICUService provides convenience APIs that take Strings and generate default Keys for use in querying.
ICUService provides API to get the list of ids publicly supported by the service (although queries aren't restricted to this list). This list contains only 'simple' IDs, and not fully unique ids. Factories are associated with each simple ID and the responsible factory can also return a human-readable localized version of the simple ID, for use in user interfaces. ICUService can also provide a sorted collection of the all the localized visible ids.
ICUService implements ICUNotifier, so that clients can register to receive notification when factories are added or removed from the service. ICUService provides a default EventListener subinterface, ServiceListener, which can be registered with the service. When the service changes, the ServiceListener's serviceChanged method is called, with the service as the only argument.
The ICUService API is both rich and generic, and it is expected that most implementations will statically 'wrap' ICUService to present a more appropriate API-- for example, to declare the type of the objects returned from get, to limit the factories that can be registered with the service, or to define their own listener interface with a custom callback method. They might also customize ICUService by overriding it, for example, to customize the Key and fallback strategy. ICULocaleService is a customized service that uses Locale names as ids and uses Keys that implement the standard resource bundle fallback strategy.
| Modifier and Type | Class and Description |
|---|---|
| private static class | |
| public static interface | ICUService.Factory
Factories generate the service objects maintained by the service. |
| public static class | ICUService.Key
Keys are used to communicate with factories to generate an instance of the service. |
| private static class | |
| public static interface | ICUService.ServiceListener
ServiceListener is the listener that ICUService provides by default. |
| public static class | ICUService.SimpleFactory
A default implementation of factory. |
| Modifier and Type | Field and Description |
|---|---|
| private Map | |
| private static final boolean | |
| private int | defaultSize
Record the default number of factories for this service. |
| private ICUService. | |
| private final List | factories
All the factories registered with this service. |
| private final ICURWLock | factoryLock
Access to factories is protected by a read-write lock. |
| private Map | |
| protected final String | name
Name used for debugging. |
| Access | Constructor and Description |
|---|---|
| public | |
| public |
| Modifier and Type | Method and Description |
|---|---|
| protected boolean | acceptsListener(EventListener l)
Implements abstract com. |
| protected void | |
| protected void | |
| public ICUService. | |
| public final List | |
| public Object | |
| public Object | |
| public String | getDisplayName(String id)
Convenience override for getDisplayName(String, ULocale) that uses the current default locale. |
| public String | getDisplayName(String id, ULocale locale)
Given a visible id, return the display name in the requested locale. |
| public SortedMap | getDisplayNames()
Convenience override of getDisplayNames(ULocale, Comparator, String) that uses the current default Locale as the locale, null as the comparator, and null for the matchID. |
| public SortedMap | getDisplayNames(ULocale locale)
Convenience override of getDisplayNames(ULocale, Comparator, String) that uses null for the comparator, and null for the matchID. |
| public SortedMap | getDisplayNames(ULocale locale, Comparator<Object> com)
Convenience override of getDisplayNames(ULocale, Comparator, String) that uses null for the matchID, thus returning all display names. |
| public SortedMap | getDisplayNames(ULocale locale, String matchID)
Convenience override of getDisplayNames(ULocale, Comparator, String) that uses null for the comparator. |
| public SortedMap | getDisplayNames(ULocale locale, Comparator<Object> com, String matchID)
Return a snapshot of the mapping from display names to visible IDs for this service. |
| public Object | |
| public Object | getKey(ICUService.
Given a key, return a service object, and, if actualReturn is not null, the descriptor with which it was found in the first element of actualReturn. |
| public Object | |
| public String | |
| private Map | |
| public Set | getVisibleIDs()
Convenience override for getVisibleIDs(String) that passes null as the fallback, thus returning all visible IDs. |
| public Set | |
| protected Object | handleDefault(ICUService.
Default handler for this service if no factory in the list handled the key. |
| public boolean | |
| protected void | |
| protected void | notifyListener(EventListener l)
Implements abstract com. |
| public final ICUService. | |
| public ICUService. | registerObject(Object obj, String id)
A convenience override of registerObject(Object, String, boolean) that defaults visible to true. |
| public ICUService. | registerObject(Object obj, String id, boolean visible)
Register an object with the provided id. The id will be canonicalized. |
| protected void | |
| public final void | |
| public String | stats()
When the statistics for this service is already enabled, return the log and resets he statistics. |
| public String | toString()
Overrides java. |
| public final boolean |
| cache | back to summary |
|---|---|
| private Map<String, ICUService. | |
| DEBUG | back to summary |
|---|---|
| private static final boolean DEBUG | |
| defaultSize | back to summary |
|---|---|
| private int defaultSize Record the default number of factories for this service. Can be set by markDefault. | |
| dnref | back to summary |
|---|---|
| private ICUService. | |
| factories | back to summary |
|---|---|
| private final List<ICUService. All the factories registered with this service. | |
| factoryLock | back to summary |
|---|---|
| private final ICURWLock factoryLock Access to factories is protected by a read-write lock. This is to allow multiple threads to read concurrently, but keep changes to the factory list atomic with respect to all readers. | |
| idcache | back to summary |
|---|---|
| private Map<String, ICUService. | |
| name | back to summary |
|---|---|
| protected final String name Name used for debugging. | |
| ICUService | back to summary |
|---|---|
| public ICUService() Constructor. | |
| ICUService | back to summary |
|---|---|
| public ICUService(String name) Construct with a name (useful for debugging). | |
| acceptsListener | back to summary |
|---|---|
| protected boolean acceptsListener(EventListener l) Implements abstract com. Return true if the listener is accepted; by default this requires a ServiceListener. Subclasses can override to accept different listeners.
| |
| clearCaches | back to summary |
|---|---|
| protected void clearCaches() Clear caches maintained by this service. Subclasses can override if they implement additional that need to be cleared when the service changes. Subclasses should generally not call this method directly, as it must only be called while synchronized on this. | |
| clearServiceCache | back to summary |
|---|---|
| protected void clearServiceCache() Clears only the service cache. This can be called by subclasses when a change affects the service cache but not the id caches, e.g., when the default locale changes the resolution of ids changes, but not the visible ids themselves. | |
| createKey | back to summary |
|---|---|
| public ICUService. 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. | |
| factories | back to summary |
|---|---|
| public final List Return a snapshot of the currently registered factories. There is no guarantee that the list will still match the current factory list of the service subsequent to this call. | |
| get | back to summary |
|---|---|
| public Object get(String descriptor) Convenience override for get(String, String[]). This uses createKey to create a key for the provided descriptor. | |
| get | back to summary |
|---|---|
| public Object get(String descriptor, String[] actualReturn) Convenience override for get(Key, String[]). This uses createKey to create a key from the provided descriptor. | |
| getDisplayName | back to summary |
|---|---|
| public String getDisplayName(String id) Convenience override for getDisplayName(String, ULocale) that uses the current default locale. | |
| getDisplayName | back to summary |
|---|---|
| public String getDisplayName(String id, ULocale locale) Given a visible id, return the display name in the requested locale. If there is no directly supported id corresponding to this id, return null. | |
| getDisplayNames | back to summary |
|---|---|
| public SortedMap Convenience override of getDisplayNames(ULocale, Comparator, String) that uses the current default Locale as the locale, null as the comparator, and null for the matchID. | |
| getDisplayNames | back to summary |
|---|---|
| public SortedMap Convenience override of getDisplayNames(ULocale, Comparator, String) that uses null for the comparator, and null for the matchID. | |
| getDisplayNames | back to summary |
|---|---|
| public SortedMap Convenience override of getDisplayNames(ULocale, Comparator, String) that uses null for the matchID, thus returning all display names. | |
| getDisplayNames | back to summary |
|---|---|
| public SortedMap Convenience override of getDisplayNames(ULocale, Comparator, String) that uses null for the comparator. | |
| getDisplayNames | back to summary |
|---|---|
| public SortedMap Return a snapshot of the mapping from display names to visible IDs for this service. This set will not change as factories are added or removed, but the supported ids will, so there is no guarantee that all and only the ids in the returned map will be visible and supported by the service in subsequent calls, nor is there any guarantee that the current display names match those in the set. The display names are sorted based on the comparator provided. | |
| getKey | back to summary |
|---|---|
| public Object getKey(ICUService. Convenience override for get(Key, String[]). | |
| getKey | back to summary |
|---|---|
| public Object getKey(ICUService. Given a key, return a service object, and, if actualReturn is not null, the descriptor with which it was found in the first element of actualReturn. If no service object matches this key, return null, and leave actualReturn unchanged. This queries the cache using the key's descriptor, and if no object in the cache matches it, tries the key on each registered factory, in order. If none generates a service object for the key, repeats the process with each fallback of the key, until either one returns a service object, or the key has no fallback. If key is null, just returns null. | |
| getKey | back to summary |
|---|---|
| public Object getKey(ICUService. | |
| getName | back to summary |
|---|---|
| public String getName() Return the name of this service. This will be the empty string if none was assigned. | |
| getVisibleIDMap | back to summary |
|---|---|
| private Map Return a map from visible ids to factories. | |
| getVisibleIDs | back to summary |
|---|---|
| public Set Convenience override for getVisibleIDs(String) that passes null as the fallback, thus returning all visible IDs. | |
| getVisibleIDs | back to summary |
|---|---|
| public Set Return a snapshot of the visible IDs for this service. This set will not change as Factories are added or removed, but the supported ids will, so there is no guarantee that all and only the ids in the returned set are visible and supported by the service in subsequent calls. matchID is passed to createKey to create a key. If the key is not null, it is used to filter out ids that don't have the key as a fallback. | |
| handleDefault | back to summary |
|---|---|
| protected Object handleDefault(ICUService. Default handler for this service if no factory in the list handled the key. | |
| isDefault | back to summary |
|---|---|
| public boolean isDefault() Return true if the service is in its default state. The default implementation returns true if there are no factories registered. | |
| markDefault | back to summary |
|---|---|
| protected void markDefault() Set the default size to the current number of registered factories. Used by subclasses to customize the behavior of isDefault. | |
| notifyListener | back to summary |
|---|---|
| protected void notifyListener(EventListener l) Implements abstract com. Notify the listener, which by default is a ServiceListener. Subclasses can override to use a different listener.
| |
| registerFactory | back to summary |
|---|---|
| public final ICUService. Register a Factory. Returns the factory if the service accepts the factory, otherwise returns null. The default implementation accepts all factories. | |
| registerObject | back to summary |
|---|---|
| public ICUService. A convenience override of registerObject(Object, String, boolean) that defaults visible to true. | |
| registerObject | back to summary |
|---|---|
| public ICUService. Register an object with the provided id. The id will be canonicalized. The canonicalized ID will be returned by getVisibleIDs if visible is true. | |
| reInitializeFactories | back to summary |
|---|---|
| protected void reInitializeFactories() Reinitialize the factory list to its default state. By default this clears the list. Subclasses can override to provide other default initialization of the factory list. Subclasses must not call this method directly, as it must only be called while holding write access to the factory list. | |
| reset | back to summary |
|---|---|
| public final void reset() Reset the service to the default factories. The factory lock is acquired and then reInitializeFactories is called. | |
| stats | back to summary |
|---|---|
| public String stats() When the statistics for this service is already enabled, return the log and resets he statistics. When the statistics is not enabled, this method enable the statistics. Used for debugging purposes. | |
| toString | back to summary |
|---|---|
| public String toString() Overrides java. Returns the result of super.toString, appending the name in curly braces.
| |
| unregisterFactory | back to summary |
|---|---|
| public final boolean unregisterFactory(ICUService. Unregister a factory. The first matching registered factory will be removed from the list. Returns true if a matching factory was removed. | |
| Access | Constructor and Description |
|---|---|
| pack-priv |
| actualDescriptor | back to summary |
|---|---|
| pack-priv final String actualDescriptor | |
| service | back to summary |
|---|---|
| pack-priv final Object service | |
| CacheEntry | back to summary |
|---|---|
| pack-priv CacheEntry(String actualDescriptor, Object service) | |
| Modifier and Type | Method and Description |
|---|---|
| public Object | create(ICUService.
Create a service object from the key, if this factory supports the key. |
| public String | getDisplayName(String id, ULocale locale)
Return the display name for this id in the provided locale. |
| public void | updateVisibleIDs(Map<String, ICUService.
Update the result IDs (not descriptors) to reflect the IDs this factory handles. |
| create | back to summary |
|---|---|
| public Object create(ICUService. Create a service object from the key, if this factory supports the key. Otherwise, return null. If the factory supports the key, then it can call the service's getKey(Key, String[], Factory) method passing itself as the factory to get the object that the service would have created prior to the factory's registration with the service. This can change the key, so any information required from the key should be extracted before making such a callback. | |
| getDisplayName | back to summary |
|---|---|
| public String getDisplayName(String id, ULocale locale) Return the display name for this id in the provided locale. This is an localized id, not a descriptor. If the id is not visible or not defined by the factory, return null. If locale is null, return id unchanged. | |
| updateVisibleIDs | back to summary |
|---|---|
| public void updateVisibleIDs(Map<String, ICUService. Update the result IDs (not descriptors) to reflect the IDs this factory handles. This function and getDisplayName are used to support ICUService.getDisplayNames. Basically, the factory has to determine which IDs it will permit to be available, and of those, which it will provide localized display names for. In most cases this reflects the IDs that the factory directly supports. | |
Keys provide both a currentDescriptor and a currentID. The descriptor contains an optional prefix, followed by '/' and the currentID. Factories that handle complex keys, for example number format factories that generate multiple kinds of formatters for the same locale, use the descriptor to provide a fully unique identifier for the service object, while using the currentID (in this case, the locale string), as the visible IDs that can be localized.
The default implementation of Key has no fallbacks and has no custom descriptors.
| Access | Constructor and Description |
|---|---|
| public |
| Modifier and Type | Method and Description |
|---|---|
| public String | canonicalID()
Return the canonical version of the original ID. This implementation returns the original ID unchanged. |
| public String | |
| public String | |
| public boolean | |
| public final String | |
| public boolean | isFallbackOf(String idToCheck)
If a key created from id would eventually fallback to match the canonical ID of this key, return true. |
| id | back to summary |
|---|---|
| private final String id | |
| Key | back to summary |
|---|---|
| public Key(String id) Construct a key from an id. | |
| canonicalID | back to summary |
|---|---|
| public String canonicalID() Return the canonical version of the original ID. This implementation returns the original ID unchanged. | |
| currentDescriptor | back to summary |
|---|---|
| public String currentDescriptor() Return the current descriptor. This implementation returns the current ID. The current descriptor is used to fully identify an instance of the service in the cache. A factory may handle all descriptors for an ID, or just a particular descriptor. The factory can either parse the descriptor or use custom API on the key in order to instantiate the service. | |
| currentID | back to summary |
|---|---|
| public String currentID() Return the (canonical) current ID. This implementation returns the canonical ID. | |
| fallback | back to summary |
|---|---|
| public boolean fallback() If the key has a fallback, modify the key and return true, otherwise return false. The current ID will change if there is a fallback. No currentIDs should be repeated, and fallback must eventually return false. This implementation has no fallbacks and always returns false. | |
| id | back to summary |
|---|---|
| public final String id() Return the original ID used to construct this key. | |
| isFallbackOf | back to summary |
|---|---|
| public boolean isFallbackOf(String idToCheck) If a key created from id would eventually fallback to match the canonical ID of this key, return true. | |
| Modifier and Type | Field and Description |
|---|---|
| private Comparator | |
| private SortedMap | |
| private final ULocale |
| Access | Constructor and Description |
|---|---|
| pack-priv |
| com | back to summary |
|---|---|
| private Comparator<Object> com | |
| dnCache | back to summary |
|---|---|
| private SortedMap<String, String> dnCache | |
| locale | back to summary |
|---|---|
| private final ULocale locale | |
| LocaleRef | back to summary |
|---|---|
| pack-priv LocaleRef(SortedMap<String, String> dnCache, ULocale locale, Comparator<Object> com) | |
| get | back to summary |
|---|---|
| pack-priv SortedMap | |
| Modifier and Type | Method and Description |
|---|---|
| public void |
| serviceChanged | back to summary |
|---|---|
| public void serviceChanged(ICUService service) | |
| Modifier and Type | Field and Description |
|---|---|
| protected String | |
| protected Object | |
| protected boolean |
| Access | Constructor and Description |
|---|---|
| public | SimpleFactory(Object instance, String id)
Convenience constructor that calls SimpleFactory(Object, String, boolean) with visible true. |
| public | SimpleFactory(Object instance, String id, boolean visible)
Construct a simple factory that maps a single id to a single service instance. |
| Modifier and Type | Method and Description |
|---|---|
| public Object | create(ICUService.
Implements com. |
| public String | getDisplayName(String identifier, ULocale locale)
Implements com. |
| public String | |
| public void | updateVisibleIDs(Map<String, ICUService.
Implements com. |
| id | back to summary |
|---|---|
| protected String id | |
| instance | back to summary |
|---|---|
| protected Object instance | |
| visible | back to summary |
|---|---|
| protected boolean visible | |
| SimpleFactory | back to summary |
|---|---|
| public SimpleFactory(Object instance, String id) Convenience constructor that calls SimpleFactory(Object, String, boolean) with visible true. | |
| SimpleFactory | back to summary |
|---|---|
| public SimpleFactory(Object instance, String id, boolean visible) Construct a simple factory that maps a single id to a single service instance. If visible is true, the id will be visible. Neither the instance nor the id can be null. | |
| create | back to summary |
|---|---|
| public Object create(ICUService. Implements com. Return the service instance if the factory's id is equal to the key's currentID. Service is ignored.
| |
| getDisplayName | back to summary |
|---|---|
| public String getDisplayName(String identifier, ULocale locale) Implements com. If this.id equals id, returns id regardless of locale, otherwise returns null. (This default implementation has no localized id information.)
| |
| toString | back to summary |
|---|---|
| public String toString() Overrides java. For debugging.
| |
| updateVisibleIDs | back to summary |
|---|---|
| public void updateVisibleIDs(Map<String, ICUService. Implements com. If visible, adds a mapping from id -> this to the result, otherwise removes id from result.
| |