Class TranslationFallbackEvent.PrecedingFailure

java.lang.Object

com.lokalized.TranslationFallbackEvent.PrecedingFailure

Enclosing class:

TranslationFallbackEvent

@ThreadSafe
public static final class TranslationFallbackEvent.PrecedingFailure
extends Object

Failure of one locale candidate preceding a successful fallback translation.

The runtime cause is exposed by reference and is outside this class's thread-safety guarantee.

Since:

3.1.1

Author:

Mark Allen

Constructor Summary

Constructors

Constructor	Description
PrecedingFailure(@NonNull Locale locale, @NonNull TranslationFailureReason reason, @Nullable Throwable cause)	Constructs a preceding candidate failure.

Method Summary

Modifier and Type	Method	Description
@NonNull Optional<@NonNull Throwable>	getCause()	Gets this candidate's runtime cause when present.
@NonNull Locale	getLocale()	Gets the attempted locale.
@NonNull TranslationFailureReason	getReason()	Gets the reason this candidate failed.
@NonNull String	toString()

Methods inherited from class Object

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

Constructor Details

PrecedingFailure

public PrecedingFailure(@NonNull Locale locale,
 @NonNull TranslationFailureReason reason,
 @Nullable Throwable cause)

Constructs a preceding candidate failure.

Parameters:

locale - attempted locale, not null

reason - reason the candidate failed, not null

cause - runtime cause for a resolution failure, otherwise null

Throws:

IllegalArgumentException - if the locale is malformed, a resolution failure has no cause, or another failure reason has a cause

Method Details

getLocale

public @NonNull Locale getLocale()

Gets the attempted locale.

Returns:

attempted locale, not null

getReason

public @NonNull TranslationFailureReason getReason()

Gets the reason this candidate failed.

Returns:

failure reason, not null

getCause

public @NonNull Optional<@NonNull Throwable> getCause()

Gets this candidate's runtime cause when present.

Returns:

runtime cause when present, otherwise empty, not null

toString

public @NonNull String toString()

Overrides:

toString in class Object

Returns:

diagnostic representation omitting throwable messages, not null