Index

A B C D E F G H I J K L M N P R S U X
All Classes and Interfaces|All Packages|Serialized Form

A

addLocaleEventListener(Localizable.LocaleEventListener) - Method in interface dev.javai18n.core.Localizable

Register LocaleEventListeners.

addLocaleEventListener(Localizable.LocaleEventListener) - Method in class dev.javai18n.core.LocalizableImpl

Register LocaleEventListeners.

addLocaleEventListener(Localizable.LocaleEventListener) - Method in class dev.javai18n.core.LocalizableLogger

Register LocaleEventListeners.

addLocaleEventListener(Localizable.LocaleEventListener) - Method in class dev.javai18n.core.LocalizationDelegate

Register LocaleEventListeners.

AssociativeResourceBundleControl - Class in dev.javai18n.core

A ResourceBundle.Control that uses an AssociativeResourceBundleLocator to load ResourceBundles associated with a baseName.

AssociativeResourceBundleControl() - Constructor for class dev.javai18n.core.AssociativeResourceBundleControl

Construct an AssociativeResourceBundleControl with an AssociativeResourceBundleLocator that uses the suffix "Bundle" to locate ResourceBundles.

AssociativeResourceBundleControlProvider - Class in dev.javai18n.core

A ResourceBundleControlProvider that uses an AssociativeResourceBundleControl to locate ResourceBundles.

AssociativeResourceBundleControlProvider() - Constructor for class dev.javai18n.core.AssociativeResourceBundleControlProvider

Constructs an AssociativeResourceBundleControlProvider.

AssociativeResourceBundleLocator - Class in dev.javai18n.core

Locates a ResourceBundle for a given baseName and locale by appending a suffix to the baseName and searching for ResourceBundles that match the composed name.

AssociativeResourceBundleLocator(String) - Constructor for class dev.javai18n.core.AssociativeResourceBundleLocator

Construct a new ResourceBundleLocator for the given suffix.

AssociativeResourceBundleProvider - Class in dev.javai18n.core

A ResourceBundleProvider that uses an AssociativeResourceBundleLocator to load ResourceBundles associated with a baseName.

AssociativeResourceBundleProvider() - Constructor for class dev.javai18n.core.AssociativeResourceBundleProvider

Constructs an AssociativeResourceBundleProvider that uses an AssociativeResourceBundleLocator with the suffix "Bundle" to locate ResourceBundles.

AttributeCollection - Interface in dev.javai18n.core

An interface for objects that allow setting of named attributes.

AttributeCollectionResourceBundle - Class in dev.javai18n.core

The base class for JsonResourceBundle and XMLResourceBundle, it maintains properties in a ConcurrentHashMap<String, Object> and provides methods for constructing an AttributeCollection object from a Class name and converting an ArrayList<Object> to an Object array, returning String arrays when all elements of the ArrayList are String objects.

AttributeCollectionResourceBundle() - Constructor for class dev.javai18n.core.AttributeCollectionResourceBundle

Default constructor for subclasses.

B

baseBundleName - Variable in class dev.javai18n.core.NestedResourceBundle

The base name of the bundle

Bundle containing typed objects - Section in class dev.javai18n.core.JsonResourceBundle

Bundle containing typed objects - Section in class dev.javai18n.core.XMLResourceBundle

C

constructAttributeCollectionObject(String) - Method in class dev.javai18n.core.AttributeCollectionResourceBundle

Construct an AttributeCollection object for the specified Class name.

CONTROL - Static variable in class dev.javai18n.core.AssociativeResourceBundleControlProvider

A static AssociativeResourceBundleControl exposed to the package.

convertToArray(ArrayList) - Method in class dev.javai18n.core.AttributeCollectionResourceBundle

Convert the specified ArrayList<Object> to an Object array.

createLocalizableLogger(String) - Static method in class dev.javai18n.core.LocalizableLogger

A factory method that returns a LocalizableLogger for the specified name in the default Locale.

D

delegate - Variable in class dev.javai18n.core.LocalizableImpl

A LocalizationDelegate to which the Localizable functions will be delegated.

delegate - Variable in class dev.javai18n.core.LocalizableLogger

The LocalizationDelegate to which Localizable methods are delegated.

delegate - Variable in class dev.javai18n.core.NestedResourceBundle

The ResourceBundle that actually contains the resources.

dev.javai18n.core - module dev.javai18n.core

Welcome to the dev/javai18n/core API documentation.

dev.javai18n.core - package dev.javai18n.core

dev.javai18n.core.spi - package dev.javai18n.core.spi

Document structure - Section in class dev.javai18n.core.JsonResourceBundle

Document structure - Section in class dev.javai18n.core.XMLResourceBundle

dump() - Method in class dev.javai18n.core.NestedResourceBundle

Writes the structure of this NestedResourceBundle to the system log at DEBUG level.

E

ensureRegistered() - Static method in class dev.javai18n.core.I18NModuleRegistrar

Ensure that all module-level registrations for the i18n module have been performed.

F

formats - Variable in class dev.javai18n.core.AssociativeResourceBundleLocator

The supported ResourceBundle formats.

G

GET_BUNDLE_CALLBACK - Static variable in class dev.javai18n.core.ModuleResourceBundleCallback

A singleton that will be registered with the GetResourceBundleRegistrar.

getAvailableLocales() - Method in interface dev.javai18n.core.Localizable

Returns the Locales supported by the object.

getAvailableLocales() - Method in class dev.javai18n.core.LocalizableImpl

Returns the Locales supported by the object.

getAvailableLocales() - Method in class dev.javai18n.core.LocalizableLogger

Returns the Locales supported by the object.

getAvailableLocales() - Method in class dev.javai18n.core.LocalizationDelegate

Returns the Locales supported by the object.

getBaseBundleName() - Method in class dev.javai18n.core.NestedResourceBundle

Overrides the getBaseBundleName of ResourceBundle to provide the name supplied to the constructor.

getBundle(String, Locale) - Method in class dev.javai18n.core.AssociativeResourceBundleProvider

Return a ResourceBundle found by appending "Bundle" to the baseName, or null.

getBundle(String, Locale, ResourceStreamLoader) - Method in class dev.javai18n.core.AssociativeResourceBundleLocator

Locate a ResourceBundle for the given baseName plus this AssociativeResourceBundleLocator's suffix for the given locale and loader.

getBundleLocale() - Method in interface dev.javai18n.core.Localizable

Get the current Locale for ResourceBundles provided by the object.

getBundleLocale() - Method in class dev.javai18n.core.LocalizableImpl

Get the current Locale for ResourceBundles provided by the object.

getBundleLocale() - Method in class dev.javai18n.core.LocalizableLogger

Get the current Locale for ResourceBundles provided by the object.

getBundleLocale() - Method in class dev.javai18n.core.LocalizationDelegate

Get the current Locale for ResourceBundles provided by the object.

getCallbackForModule(Module) - Static method in class dev.javai18n.core.GetResourceBundleRegistrar

A static method to retrieve the GetResourceBundleCallback associated with the specified Module.

getClassBundle(String, Locale, ResourceStreamLoader) - Method in class dev.javai18n.core.AssociativeResourceBundleLocator

Locate a class-based ResourceBundle for the given bundleName, locale, format and loader.

getControl(String) - Method in class dev.javai18n.core.AssociativeResourceBundleControlProvider

Return a ResourceBundle found by adding the literal "Bundle" to the baseName and searching for matching java classes, JSON files, XML files and properties files.

getDelegate() - Method in class dev.javai18n.core.NestedResourceBundle

Returns the delegate ResourceBundle.

getFormats() - Method in class dev.javai18n.core.AssociativeResourceBundleLocator

Returns a List of Strings containing formats available to locate ResourceBundles for this object's baseName.

getFormats(String) - Method in class dev.javai18n.core.AssociativeResourceBundleControl

Returns the list of formats from the locator.

getJsonBundle(String, Locale, ResourceStreamLoader) - Method in class dev.javai18n.core.AssociativeResourceBundleLocator

Locate a JSON-based ResourceBundle for the given bundleName, locale, format and loader.

getKey() - Method in class dev.javai18n.core.Resource

Get the key used to look up the resource.

getKeys() - Method in class dev.javai18n.core.AttributeCollectionResourceBundle

Returns an enumeration of the keys in this ResourceBundle and its parent bundles.

getKeys() - Method in class dev.javai18n.core.NestedResourceBundle

Returns an enumeration of the keys.

getLocale() - Method in class dev.javai18n.core.NestedResourceBundle

The locale of the delegate.

getLocalizableSource() - Method in class dev.javai18n.core.Localizable.LocaleEvent

Gets the Localizable source of the LocaleEvent.

getLogger() - Method in class dev.javai18n.core.LocalizableLogger

Returns the System.Logger that is actually doing the logging.

getName() - Method in class dev.javai18n.core.LocalizableLogger

Returns the name of this logger.

getNestedResourceBundle() - Method in class dev.javai18n.core.LocalizationDelegate

Get a NestedResourceBundle for the localizedObject and its current locale.

getObject() - Method in class dev.javai18n.core.Resource

Get the localized Object for the Resource.

getParent() - Method in class dev.javai18n.core.NestedResourceBundle

Return the parent bundle of this bundle.

getPropertiesBundle(String, Locale, ResourceStreamLoader) - Method in class dev.javai18n.core.AssociativeResourceBundleLocator

Locate a properties-based ResourceBundle for the given bundleName, locale, format and loader.

getResource() - Method in interface dev.javai18n.core.Resourceful

Get the current Resource for the object.

getResource() - Method in class dev.javai18n.core.ResourcefulDelegate

Get the Resource holding locale-specific values for the owning component.

getResourceAsStream(String) - Method in class dev.javai18n.core.ResourceStreamLoader

Get an InputStream for the specified name, using the Module if one was provided or the ClassLoader if not.

getResourceBundle() - Method in interface dev.javai18n.core.Localizable

Returns the ResourceBundle for the object according to its locale.

getResourceBundle() - Method in class dev.javai18n.core.LocalizableImpl

Returns the ResourceBundle for the object according to its locale.

getResourceBundle() - Method in class dev.javai18n.core.LocalizableLogger

Returns the ResourceBundle for the object according to its locale.

getResourceBundle() - Method in class dev.javai18n.core.LocalizationDelegate

Returns the ResourceBundle for the object according to its locale.

getResourceBundle(String, Locale) - Method in interface dev.javai18n.core.GetResourceBundleCallback

Invokes ResourceBundle.getBundle() for the given baseName and locale.

getResourceBundle(String, Locale) - Method in class dev.javai18n.core.ModuleResourceBundleCallback

Invokes ResourceBundle.getBundle() for the given baseName and locale.

GetResourceBundleCallback - Interface in dev.javai18n.core

An interface that calls back to ResourceBundle.getBundle().

GetResourceBundleRegistrar - Class in dev.javai18n.core

This class allows registration of GetResourceBundleCallback instances so that they may be retrieved and used to place the call to ResourceBundle.getBundle() from the appropriate module.

getResourceClassLoader() - Method in class dev.javai18n.core.ResourceStreamLoader

If this object was constructed with a ClassLoader, it is returned otherwise the ClassLoader for the Module is returned.

getSource() - Method in class dev.javai18n.core.Resource

Get the source Localizable object for this Resource.

getString() - Method in class dev.javai18n.core.Resource

Get the localized String for the Resource.

getStringArray() - Method in class dev.javai18n.core.Resource

Get the localized String array for the Resource.

getSuperBundle() - Method in class dev.javai18n.core.NestedResourceBundle

Returns the superBundle

getXmlBundle(String, Locale, ResourceStreamLoader) - Method in class dev.javai18n.core.AssociativeResourceBundleLocator

Locate an xml-based ResourceBundle for the given bundleName, locale, format and loader.

H

handleGetObject(String) - Method in class dev.javai18n.core.AttributeCollectionResourceBundle

Gets an object for the given key from this resource bundle.

handleGetObject(String) - Method in class dev.javai18n.core.NestedResourceBundle

Gets an object for the given key from this ResourceBundle.

handleKeySet() - Method in class dev.javai18n.core.AttributeCollectionResourceBundle

Returns the set of keys owned directly by this bundle, excluding parent bundles.

handleKeySet() - Method in class dev.javai18n.core.NestedResourceBundle

Returns a Set of all keys contained in this NestedResourceBundle's delegate.

I

I18N_LOGGER - Static variable in class dev.javai18n.core.LocalizableLogger

The logger used internally by the i18n framework.

I18NModuleRegistrar - Class in dev.javai18n.core

Consolidates module-level registrations for the i18n module.

isLoggable(System.Logger.Level) - Method in class dev.javai18n.core.LocalizableLogger

Checks if a message of the given level would be logged by this logger.

J

JsonResourceBundle - Class in dev.javai18n.core

A ResourceBundle loaded from a JSON document.

JsonResourceBundle(InputStream) - Constructor for class dev.javai18n.core.JsonResourceBundle

Constructs a JsonResourceBundle given an InputStream that provides the JSON document.

K

keySet() - Method in class dev.javai18n.core.NestedResourceBundle

Returns a Set of all keys contained in this NestedResourceBundle, its parent bundles, and the higher levels in the nesting hierarchy.

L

listeners - Variable in class dev.javai18n.core.LocalizationDelegate

The set of LocaleEventListeners.

locale - Variable in class dev.javai18n.core.LocalizationDelegate

The locale for the Localizable object.

LocaleEvent(Localizable) - Constructor for class dev.javai18n.core.Localizable.LocaleEvent

Constructs a LocaleEvent object given a Localizable source.

Localizable - Interface in dev.javai18n.core

An interface to identify classes whose behavior can be localized.

Localizable.LocaleEvent - Class in dev.javai18n.core

LocaleEvents are generated by Localizable objects when their Locale changes.

Localizable.LocaleEventListener - Interface in dev.javai18n.core

An interface for listeners of LocaleEvents.

LocalizableImpl - Class in dev.javai18n.core

A base implementation of the Localizable interface that uses a LocalizationDelegate for Localizable services.

LocalizableImpl() - Constructor for class dev.javai18n.core.LocalizableImpl

Construct a LocalizableImpl.

LocalizableLogger - Class in dev.javai18n.core

A System.Logger that is Localizable.

LocalizableLogger(String) - Constructor for class dev.javai18n.core.LocalizableLogger

Constructs a new LocalizableLogger for the specified name with the default Locale.

LocalizableLoggerProvider - Interface in dev.javai18n.core.spi

The service provider interface for the LocalizableLogger class.

LocalizationDelegate - Class in dev.javai18n.core

A Class that objects that implement the Localizable interface can embed and to which they can delegate the required methods of that interface.

LocalizationDelegate(Localizable) - Constructor for class dev.javai18n.core.LocalizationDelegate

Construct a LocalizationDelegate.

localizedObject - Variable in class dev.javai18n.core.LocalizationDelegate

The class for which this delegate handles Localizable functionality.

log(System.Logger.Level, Object) - Method in class dev.javai18n.core.LocalizableLogger

Logs a message produced from the given object.

log(System.Logger.Level, String) - Method in class dev.javai18n.core.LocalizableLogger

Logs a message.

log(System.Logger.Level, String, Object...) - Method in class dev.javai18n.core.LocalizableLogger

Logs a message with an optional list of parameters.

log(System.Logger.Level, String, Throwable) - Method in class dev.javai18n.core.LocalizableLogger

Logs a message associated with a given throwable.

log(System.Logger.Level, Supplier) - Method in class dev.javai18n.core.LocalizableLogger

Logs a lazily supplied message.

log(System.Logger.Level, Supplier, Throwable) - Method in class dev.javai18n.core.LocalizableLogger

Logs a lazily supplied message associated with a given throwable.

log(System.Logger.Level, ResourceBundle, String, Object...) - Method in class dev.javai18n.core.LocalizableLogger

Logs a message with resource bundle and an optional list of parameters.

log(System.Logger.Level, ResourceBundle, String, Throwable) - Method in class dev.javai18n.core.LocalizableLogger

Logs a localized message associated with a given throwable.

logger - Variable in class dev.javai18n.core.LocalizableLogger

The System.Logger that does the logging.

logLock - Variable in class dev.javai18n.core.LocalizableLogger

A lock to synchronize locale changes with logger replacement.

M

ModuleProviderImpl - Class in dev.javai18n.core.spi

An AssociativeResourceBundleProvider that implements the ResourceBundleProvider interfaces defined in this module.

ModuleProviderImpl() - Constructor for class dev.javai18n.core.spi.ModuleProviderImpl

ModuleResourceBundleCallback - Class in dev.javai18n.core

A class that is called back from the i18n module so that it can issue the ResourceBundle.getBundle() call from this module's context.

ModuleResourceBundleCallback() - Constructor for class dev.javai18n.core.ModuleResourceBundleCallback

Constructs a ModuleResourceBundleCallback.

N

name - Variable in class dev.javai18n.core.LocalizableLogger

The name of this logger.

NestedResourceBundle - Class in dev.javai18n.core

A ResourceBundle that allows for nesting other ResourceBundles in a hierarchy and searching for resources in the next higher level of the hierarchy when the resource is not found at a lower level.

NestedResourceBundle(ResourceBundle, NestedResourceBundle, String) - Constructor for class dev.javai18n.core.NestedResourceBundle

Construct a NestedResourceBundle from the specified delegate bundle, superBundle and baseBundleName.

newBundle(String, Locale, String, ResourceStreamLoader, boolean) - Method in class dev.javai18n.core.AssociativeResourceBundleLocator

Locate a ResourceBundle for the given baseName plus this AssociativeResourceBundleLocator's suffix for the given locale, format and loader.

newBundle(String, Locale, String, ClassLoader, boolean) - Method in class dev.javai18n.core.AssociativeResourceBundleControl

Locate a ResourceBundle for the given baseName plus this AssociativeResourceBundleLocator's suffix for the given locale, format and loader.

No-arg constructor requirement - Section in class dev.javai18n.core.JsonResourceBundle

No-arg constructor requirement - Section in class dev.javai18n.core.XMLResourceBundle

NoCallbackRegisteredForModuleException - Exception Class in dev.javai18n.core

An exception that is thrown if there is no GetResourceBundleCallback registered for a module.

NoCallbackRegisteredForModuleException(String) - Constructor for exception class dev.javai18n.core.NoCallbackRegisteredForModuleException

Construct a NoCallbackRegisteredForModuleException.

P

Package registration - Section in class dev.javai18n.core.JsonResourceBundle

Package registration - Section in class dev.javai18n.core.XMLResourceBundle

processLocaleEvent(Localizable.LocaleEvent) - Method in interface dev.javai18n.core.Localizable.LocaleEventListener

Process the LocaleEvent.

processLocaleEvent(Localizable.LocaleEvent) - Method in class dev.javai18n.core.ResourcefulDelegate

Forward a LocaleEvent to the event handler.

props - Variable in class dev.javai18n.core.AttributeCollectionResourceBundle

The map that contains the resource keys and values.

R

rb - Variable in class dev.javai18n.core.LocalizationDelegate

The ResourceBundle for this object's current locale.

registerAttributeCollectionPackage(String) - Static method in class dev.javai18n.core.AttributeCollectionResourceBundle

Register a package whose AttributeCollection implementations are permitted for instantiation from resource files.

registerGetResourceBundleCallback(GetResourceBundleCallback) - Static method in class dev.javai18n.core.GetResourceBundleRegistrar

A static method to register the GetResourceBundleCallback associated with the specified Module.

registerListener() - Method in class dev.javai18n.core.ResourcefulDelegate

Register this delegate as a Localizable.LocaleEventListener on the resource's source.

removeLocaleEventListener(Localizable.LocaleEventListener) - Method in interface dev.javai18n.core.Localizable

Unregister LocaleEventListeners.

removeLocaleEventListener(Localizable.LocaleEventListener) - Method in class dev.javai18n.core.LocalizableImpl

Unregister LocaleEventListeners.

removeLocaleEventListener(Localizable.LocaleEventListener) - Method in class dev.javai18n.core.LocalizableLogger

Unregister LocaleEventListeners.

removeLocaleEventListener(Localizable.LocaleEventListener) - Method in class dev.javai18n.core.LocalizationDelegate

Unregister LocaleEventListeners.

resolveEntity(String, String) - Method in class dev.javai18n.core.XMLResourceBundle.PropertiesDtdResolver

RESOLVER - Static variable in class dev.javai18n.core.XMLResourceBundle.PropertiesDtdResolver

Singleton instance of the resolver.

Resource - Class in dev.javai18n.core

A Resource object encapsulates a resource obtainable from a Localizable object with a specified key.

Resource(Localizable, String) - Constructor for class dev.javai18n.core.Resource

Constructs a Resource from a Localizable source and a String key.

Resourceful - Interface in dev.javai18n.core

An interface to identify Resourceful objects - objects that support setting and getting a Resource.

ResourcefulDelegate - Class in dev.javai18n.core

A delegate that handles Resource ownership and Localizable.LocaleEventListener registration on behalf of Resourceful objects that cannot share a common base class.

ResourcefulDelegate(Resource, Localizable.LocaleEventListener) - Constructor for class dev.javai18n.core.ResourcefulDelegate

Construct a ResourcefulDelegate.

ResourceStreamLoader - Class in dev.javai18n.core

A helper class to facilitate use of either Modules or ClassLoaders to read resource data.

ResourceStreamLoader(ClassLoader) - Constructor for class dev.javai18n.core.ResourceStreamLoader

Construct a ResourceStreamLoader with the specified ClassLoader.

ResourceStreamLoader(Module) - Constructor for class dev.javai18n.core.ResourceStreamLoader

Construct a ResourceStreamLoader with the specified Module.

S

setAttribute(String, Object) - Method in interface dev.javai18n.core.AttributeCollection

Sets the value of the named attribute.

setBundleLocale(Locale) - Method in interface dev.javai18n.core.Localizable

Set the current Locale for ResourceBundles provided by the object.

setBundleLocale(Locale) - Method in class dev.javai18n.core.LocalizableImpl

Set the current Locale for ResourceBundles provided by the object.

setBundleLocale(Locale) - Method in class dev.javai18n.core.LocalizableLogger

Set the current Locale for ResourceBundles provided by the object.

setBundleLocale(Locale) - Method in class dev.javai18n.core.LocalizationDelegate

Set the current Locale for ResourceBundles provided by the object.

setResource(Resource) - Method in interface dev.javai18n.core.Resourceful

Set the current Resource for the object.

setResource(Resource) - Method in class dev.javai18n.core.ResourcefulDelegate

Set the Resource holding locale-specific values for the owning component.

String-only bundle - Section in class dev.javai18n.core.JsonResourceBundle

String-only bundle - Section in class dev.javai18n.core.XMLResourceBundle

superBundle - Variable in class dev.javai18n.core.NestedResourceBundle

The NestedResourceBundle for the next higher level in the nesting hierarchy.

U

updateResourceBundle() - Method in class dev.javai18n.core.LocalizationDelegate

Updates the ResourceBundle for the object based on its current locale.

X

XMLResourceBundle - Class in dev.javai18n.core

A ResourceBundle loaded from an XML document.

XMLResourceBundle(InputStream) - Constructor for class dev.javai18n.core.XMLResourceBundle

Constructs an XMLResourceBundle given an InputStream that provides the XML document.

XMLResourceBundle.PropertiesDtdResolver - Class in dev.javai18n.core

An EntityResolver that resolves the properties DTD.

A B C D E F G H I J K L M N P R S U X
All Classes and Interfaces|All Packages|Serialized Form