yakworks.i18n

Interface MsgKey

All Known Subinterfaces:

MsgContext<E>, MsgKeyDecorator, MsgMultiKey

All Known Implementing Classes:

DefaultMsgContext, DefaultMsgKey, DefaultMsgMultiKey

public interface MsgKey

MsgKey contains the lookup code for the message and the argument map for name substitutions. Can also have a defaultMessage stored as a key in the argument map Related to org.springframework.context.MessageSourceResolvable interface but simplified. * This differs in that its simplified and skinnied down - only one code instead of array - message arguments are params and are not an array but based on keys in map - if a list or array is passed then it looks at the first element to see if its a map and uses that - no default message prop but one can be passed into the map with the key 'defaultMessage'

Since:

0.3.0

Method Summary

Modifier and Type	Method and Description
default MsgArgs	getArgs() Return the Map of arguments to be used to resolve this message as ICU.
java.lang.String	getCode()
default java.lang.String	getFallbackMessage() fallbackMessage is the same as defaultMessage for example in spring.
static DefaultMsgKey	of(java.lang.String code, java.lang.Object args) key from code and map args
static DefaultMsgKey	ofCode(java.lang.String code) Make key form code
default void	setArgs(MsgArgs v)
default void	setArgs(java.lang.Object v)
default void	setCode(java.lang.String code)
default void	setFallbackMessage(java.lang.String v)

Method Detail

getCode

java.lang.String getCode()

setCode

default void setCode(java.lang.String code)

getArgs

@Nullable
default MsgArgs getArgs()

Return the Map of arguments to be used to resolve this message as ICU. A default message can also be in the map params as a 'defaultMessage' key.

setArgs

default void setArgs(MsgArgs v)

setArgs

default void setArgs(java.lang.Object v)

getFallbackMessage

default java.lang.String getFallbackMessage()

fallbackMessage is the same as defaultMessage for example in spring. Its name as a fallback as thats what it is and should not really be used or leaned on, it means the i18n is not configured correctly If one is set here then return it, if not it looks at args and if its a map then returns the 'fallbackMessage' key if it exists

setFallbackMessage

default void setFallbackMessage(java.lang.String v)

ofCode

static DefaultMsgKey ofCode(java.lang.String code)

Make key form code

of

static DefaultMsgKey of(java.lang.String code,
                        java.lang.Object args)

key from code and map args