Class LocalizedStringWarning

java.lang.Object

com.lokalized.LocalizedStringWarning

@ThreadSafe
public final class LocalizedStringWarning
extends Object

Describes a non-fatal validation problem detected while loading a localized strings file.

Instances are supplied to a LocalizedStringWarningHandler. Lokalized constructs these objects; application code should normally only inspect them. A warning never aborts loading on its own - the configured handler decides what to do (log it, ignore it, collect it, or throw to fail the load).

Since:

3.0.0

Author:

Mark Allen

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	LocalizedStringWarning.Type	The kind of problem a LocalizedStringWarning represents.

Method Summary

Modifier and Type	Method	Description
boolean	equals(@Nullable Object object)
@NonNull Optional<@NonNull String>	getKey()	Gets the translation key that triggered the warning, when applicable.
@NonNull Optional<@NonNull Locale>	getLocale()	Gets the locale the file was being loaded for, when the warning applies to a parsed localized strings file.
@NonNull String	getMessage()	Gets a human-readable description of the warning.
@NonNull Set<@NonNull String>	getMissingLanguageForms()	Gets the missing language-form names, in localized strings file format (e.g.
@NonNull Optional<@NonNull String>	getPlaceholder()	Gets the placeholder within the key that triggered the warning, when applicable.
@NonNull String	getSource()	Gets the file path or URL that was being loaded.
@NonNull LocalizedStringWarning.Type	getType()	Gets the kind of problem this warning represents.
int	hashCode()
@NonNull String	toString()

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Method Details

getType

public @NonNull LocalizedStringWarning.Type getType()

Gets the kind of problem this warning represents.

Returns:

the warning type, not null

getSource

public @NonNull String getSource()

Gets the file path or URL that was being loaded.

Returns:

the source, not null

getLocale

public @NonNull Optional<@NonNull Locale> getLocale()

Gets the locale the file was being loaded for, when the warning applies to a parsed localized strings file.

Returns:

the locale, if applicable, not null

getKey

public @NonNull Optional<@NonNull String> getKey()

Gets the translation key that triggered the warning, when applicable.

Returns:

the translation key, if applicable, not null

getPlaceholder

public @NonNull Optional<@NonNull String> getPlaceholder()

Gets the placeholder within the key that triggered the warning, when applicable.

Returns:

the placeholder, if applicable, not null

getMissingLanguageForms

public @NonNull Set<@NonNull String> getMissingLanguageForms()

Gets the missing language-form names, in localized strings file format (e.g. CARDINALITY_MANY).

Returns:

the missing language-form names, not null

getMessage

public @NonNull String getMessage()

Gets a human-readable description of the warning.

Returns:

the message, not null

toString

public @NonNull String toString()

Overrides:

toString in class Object

equals

public boolean equals(@Nullable Object object)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object