Class TranslationFallbackEvent

java.lang.Object

com.lokalized.TranslationFallbackEvent

@ThreadSafe
public final class TranslationFallbackEvent
extends Object

Diagnostic event for a lookup whose later locale candidate supplied a translation.

The event records every preceding candidate's own failure reason and cause, in attempt order. It contains no rendered translation or caller placeholder values. Collection state is unmodifiable; runtime causes are exposed by reference and are outside this class's thread-safety guarantee.

Since:

3.1.1

Author:

Mark Allen

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	TranslationFallbackEvent.PrecedingFailure	Failure of one locale candidate preceding a successful fallback translation.

Constructor Summary

Constructors

Constructor	Description
TranslationFallbackEvent(@NonNull TranslationResult translationResult, @NonNull List<@NonNull TranslationFallbackEvent.PrecedingFailure> precedingFailures)	Constructs an event from a successful result and the failures preceding it.

Method Summary

Modifier and Type	Method	Description
@NonNull List<@NonNull Locale>	getAttemptedLocales()	Gets all attempted locales through the successful candidate.
@NonNull String	getKey()	Gets the translation key.
@NonNull Optional<@NonNull LocaleMatchResult>	getLocaleMatchResult()	Gets the locale-negotiation diagnostics when available.
@NonNull Locale	getLookupLocale()	Gets the locale used to begin per-key lookup.
@NonNull List<@NonNull TranslationFallbackEvent.PrecedingFailure>	getPrecedingFailures()	Gets the failures preceding the successful candidate.
@NonNull Locale	getResolvedLocale()	Gets the locale that supplied the translation.
@NonNull String	toString()

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

TranslationFallbackEvent

public TranslationFallbackEvent(@NonNull TranslationResult translationResult,
 @NonNull List<@NonNull TranslationFallbackEvent.PrecedingFailure> precedingFailures)

Constructs an event from a successful result and the failures preceding it. Custom Strings implementations can use this constructor to expose the same diagnostics.

The locale-match result and unmodifiable attempted-locales list are shared with translationResult. The supplied failure list is defensively copied. This event does not retain the rendered translation from translationResult.

Parameters:

translationResult - a translated result whose successful locale follows at least one failed candidate, not null

precedingFailures - failures for every preceding candidate, in attempt order, not null

Throws:

IllegalArgumentException - if the result is not translated, there are no preceding candidates, or the failures do not correspond exactly to the preceding attempted locales

Method Details

getKey

public @NonNull String getKey()

Gets the translation key.

Returns:

translation key, not null

getLookupLocale

public @NonNull Locale getLookupLocale()

Gets the locale used to begin per-key lookup.

Returns:

lookup locale, not null

getLocaleMatchResult

public @NonNull Optional<@NonNull LocaleMatchResult> getLocaleMatchResult()

Gets the locale-negotiation diagnostics when available.

Returns:

locale-match result when available, otherwise empty, not null

getAttemptedLocales

public @NonNull List<@NonNull Locale> getAttemptedLocales()

Gets all attempted locales through the successful candidate.

Returns:

attempted locales in attempt order, not null

getResolvedLocale

public @NonNull Locale getResolvedLocale()

Gets the locale that supplied the translation.

Returns:

resolved locale, not null

getPrecedingFailures

public @NonNull List<@NonNull TranslationFallbackEvent.PrecedingFailure> getPrecedingFailures()

Gets the failures preceding the successful candidate.

Returns:

preceding failures in attempt order, not null

toString

public @NonNull String toString()

Overrides:

toString in class Object

Returns:

diagnostic representation omitting translation text and throwable messages, not null