pro.fessional.mirana.i18n

Class I18nString

java.lang.Object

pro.fessional.mirana.i18n.I18nString

All Implemented Interfaces:

Serializable, I18nAware

public class I18nString
extends Object
implements I18nAware

 String can be used as i18n template (MessageFormat by default)
 - i18nCode - template id, default empty
 - i18nArgs - template arguments, default empty
 - i18nHint - default text or template, not in hash and equals, default empty
 - i18nCache - cached value for performance
 

Since:

2019-09-19

Author:

trydofor

See Also:

MessageFormat, Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface pro.fessional.mirana.i18n.I18nAware

I18nAware.I18nSource

Constructor Summary

Constructors

Constructor and Description
I18nString(String i18nCode)
I18nString(String i18nCode, String i18nHint)
I18nString(String i18nCode, String i18nHint, Object... args)

Method Summary

Modifier and Type	Method and Description
void	applyLocale(Locale locale, @NotNull I18nAware.I18nSource source) apply the internal locale and updates the i18n state based on the provided source.
boolean	equals(Object o)
@NotNull Object[]	getI18nArgs() the args of template
@Nullable String	getI18nCache()
@NotNull String	getI18nCode() the i18n code, also template id
@NotNull String	getI18nHint() the default message or template (if no template by code)
int	hashCode()
boolean	isEmpty()
static I18nString	of(@NotNull I18nAware i18n) the string as i18nCode, empty args and hint
static I18nString	of(String str) the string as i18nCode, empty args and hint
I18nString	setI18nCache(String i18nCache)
I18nString	setI18nHint(String i18nHint)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface pro.fessional.mirana.i18n.I18nAware

getI18nArgsIf, getI18nArgsOr, getI18nCodeIf, getI18nCodeOr, getI18nHintIf, getI18nHintOr, toI18nString, toI18nString, toI18nString, toString, toString, toString

Constructor Detail

I18nString

public I18nString(String i18nCode)

I18nString

public I18nString(String i18nCode,
                  String i18nHint)

I18nString

public I18nString(String i18nCode,
                  String i18nHint,
                  Object... args)

Method Detail

getI18nCode

@NotNull
public @NotNull String getI18nCode()

Description copied from interface: I18nAware

the i18n code, also template id

Specified by:

getI18nCode in interface I18nAware

getI18nArgs

@NotNull
public @NotNull Object[] getI18nArgs()

Description copied from interface: I18nAware

the args of template

Specified by:

getI18nArgs in interface I18nAware

getI18nHint

@NotNull
public @NotNull String getI18nHint()

Description copied from interface: I18nAware

the default message or template (if no template by code)

Specified by:

getI18nHint in interface I18nAware

setI18nHint

@Contract(value="_ -> this")
public I18nString setI18nHint(String i18nHint)

getI18nCache

@Nullable
public @Nullable String getI18nCache()

setI18nCache

@Contract(value="_->this")
public I18nString setI18nCache(String i18nCache)

isEmpty

public boolean isEmpty()

applyLocale

public void applyLocale(Locale locale,
                        @NotNull
                        @NotNull I18nAware.I18nSource source)

Description copied from interface: I18nAware

apply the internal locale and updates the i18n state based on the provided source.

Specified by:

applyLocale in interface I18nAware

Parameters:

locale - the locale to be applied

source - the i18n source providing the translations

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

of

public static I18nString of(String str)

the string as i18nCode, empty args and hint

of

public static I18nString of(@NotNull
                            @NotNull I18nAware i18n)

the string as i18nCode, empty args and hint