de.ipcon.tools

Interface L10nPackProviderI

All Known Subinterfaces:

BackendL10nProviderI, ServerConnectionI

All Known Implementing Classes:

AbstractBackendConnection, BackendConnection, BackendConnectionManager, DBMan, L10n, L10nCache

public interface L10nPackProviderI

Defines the contract for a provider of localization (L10n) packs.

Implementations of this interface are responsible for delivering L10nPack objects, which contain localized key-value pairs. This interface abstracts the source and mechanism of how these packs are retrieved (e.g., from files, database, network) and whether the provider is currently available.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	$0

Method Summary

Modifier and Type	Method and Description
L10nPack	getL10nPack(java.lang.String bundleName, java.lang.String locale) Retrieves a specific L10nPack by its bundle name and locale.
L10nPack[]	getL10nPacks(java.lang.String[] bundleNames, java.lang.String locale) Retrieves an array of L10nPack objects for multiple specified bundle names and a single locale.
L10nPathEntry[]	getL10nPath() Retrieves the localization path entries provided by this pack provider.
java.lang.String	getL10nViaString() Provides a descriptive string indicating the means by which localization (L10n) data was delivered.
boolean	isOperational() Checks if this L10n pack provider is currently operational and ready to serve requests.
default void	prefetchL10nPacks() Initiates a prefetching process for L10n packs.

Field Detail

$0

static final java.lang.String $0

See Also:

Constant Field Values

Method Detail

isOperational

boolean isOperational()

Checks if this L10n pack provider is currently operational and ready to serve requests.

Returns:

true if the provider is operational, false otherwise.

getL10nViaString

java.lang.String getL10nViaString()

Provides a descriptive string indicating the means by which localization (L10n) data was delivered. This method is primarily for logging and debugging purposes. It helps identify the origin of the localized content. For instance, it might return strings like "DBMan", "Backend.L10nCache", "BackendConnection to MyTISM Backend", or "Classpath", specifying where the L10n resources were loaded from.

Returns:

A String describing the delivery mechanism or source of the L10n data.

getL10nPack

L10nPack getL10nPack(java.lang.String bundleName,
                     java.lang.String locale)

Retrieves a specific L10nPack by its bundle name and locale.

Parameters:

bundleName - The name of the L10n bundle to retrieve.

locale - The name of the Locale for which to retrieve the pack.

Returns:

The requested L10nPack, or null if not found.

getL10nPacks

L10nPack[] getL10nPacks(java.lang.String[] bundleNames,
                        java.lang.String locale)

Retrieves an array of L10nPack objects for multiple specified bundle names and a single locale.

Parameters:

bundleNames - An array of String names of the L10n bundles to retrieve.

locale - The name of the Locale for which to retrieve the packs.

Returns:

An array of L10nPacks corresponding to the requested bundle names, or an empty array if none are found.

getL10nPath

L10nPathEntry[] getL10nPath()

Retrieves the localization path entries provided by this pack provider.

These path entries define the locations or priorities for searching localization resources within the overall L10n system.

Returns:

An array of L10nPathEntry objects.

prefetchL10nPacks

default void prefetchL10nPacks()

Initiates a prefetching process for L10n packs.

This default method can be overridden by implementations to perform asynchronous loading or caching of localization data in the background. The base implementation does nothing.