pro.fessional.mirana.i18n

Class I18nMessage

java.lang.Object

pro.fessional.mirana.i18n.I18nMessage

All Implemented Interfaces:

Serializable, ChainingCast, I18nAware

Direct Known Subclasses:

I18nNotice, R

public class I18nMessage
extends Object
implements ChainingCast, I18nAware

 global message for user, the i18n templates and parameters should be merged into
 a local message based on the user's language, rather than the default message.

 - message - default i18n message or template
 - i18nCode - i18n template code
 - i18nArgs - i18n template args
 

See Also:

Serialized Form

Nested Class Summary

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

I18nAware.I18nSource

Field Summary

Fields

Modifier and Type	Field and Description
protected Object[]	i18nArgs
protected String	i18nCode
protected String	message

Constructor Summary

Constructors

Constructor and Description
I18nMessage()

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)
Object[]	getI18nArgs() the args of template
String	getI18nCode() the i18n code, also template id
String	getI18nHint() the default message or template (if no template by code)
String	getMessage()
int	hashCode()
static I18nMessage	of(@NotNull I18nAware i18n)
I18nMessage	setI18nArgs(Object... i18nArgs)
I18nMessage	setI18nCode(String i18nCode)
I18nMessage	setMessage(String message)
I18nMessage	setMessageBy(I18nAware ia)
I18nMessage	setMessageBy(String message, I18nAware ia)
I18nMessage	setMessageBy(String message, String i18nCode)
I18nMessage	setMessageBy(String message, String i18nCode, Object... i18nArgs)
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface pro.fessional.mirana.cast.ChainingCast

cast

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

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

Field Detail

message

protected String message

i18nCode

protected String i18nCode

i18nArgs

protected Object[] i18nArgs

Constructor Detail

I18nMessage

public I18nMessage()

Method Detail

getMessage

public String getMessage()

setMessage

@Contract(value="_->this")
public I18nMessage setMessage(String message)

getI18nCode

public String getI18nCode()

Description copied from interface: I18nAware

the i18n code, also template id

Specified by:

getI18nCode in interface I18nAware

setI18nCode

@Contract(value="_->this")
public I18nMessage setI18nCode(String i18nCode)

getI18nArgs

public Object[] getI18nArgs()

Description copied from interface: I18nAware

the args of template

Specified by:

getI18nArgs in interface I18nAware

setI18nArgs

@Contract(value="_->this")
public I18nMessage setI18nArgs(Object... i18nArgs)

getI18nHint

public String getI18nHint()

Description copied from interface: I18nAware

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

Specified by:

getI18nHint in interface I18nAware

setMessageBy

@Contract(value="_->this")
public I18nMessage setMessageBy(I18nAware ia)

setMessageBy

@Contract(value="_,_->this")
public I18nMessage setMessageBy(String message,
                                                             I18nAware ia)

setMessageBy

@Contract(value="_,_->this")
public I18nMessage setMessageBy(String message,
                                                             String i18nCode)

setMessageBy

@Contract(value="_,_,_->this")
public I18nMessage setMessageBy(String message,
                                                               String i18nCode,
                                                               Object... i18nArgs)

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

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

of

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