MsgKey (i18n 0.4.1 API)

All Known Subinterfaces:

MsgContext<E>

All Known Implementing Classes:

DefaultMsgContext, DefaultMsgKey
```
public interface MsgKey<E>
```
ICUMsgKey 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

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`default E`	`args(java.lang.Object args)`
`default E`	`code(java.lang.String code)`
`default E`	`fallbackMessage(java.lang.String defMsg)`
`default java.lang.String`	`formatWith(java.text.Format messageFormat)` calls format on the passed in messageFormat.
`default java.util.Map`	`getArgMap()` if args is null or empty then this initializes it to a map for names args should check that return map as null means it didnt succeed
`default java.lang.Object`	`getArgs()` Return the Map of arguments to be used to resolve this message as ICU.
`default java.util.Map`	`getArgsMap()` get the args as a Map, returns null if they are a list and not a map
`default java.lang.String`	`getCode()`
`java.lang.String`	`getFallbackMessage()` fallbackMessage is the same as defaultMessage for example in spring.
`static java.lang.String`	`getFallbackMessage(java.lang.String fieldMessage, java.lang.Object args)`
`static boolean`	`isArray(java.lang.Object obj)`
`default boolean`	`isEmpty()`
`static boolean`	`isEmpty(java.lang.Object obj)`
`static boolean`	`isFirstItemMap(java.lang.Object... args)` Checks if args is Array or List and if the first item is a map, if so then it should use that map for the args and ignores the rest.
`static DefaultMsgKey`	`of(java.lang.String code)` Make key form code
`static DefaultMsgKey`	`of(java.lang.String code, java.lang.Object args)` key from code and map args
`default java.util.Map`	`putArg(java.lang.Object key, java.lang.Object val)` adds an arg to the map, see getArgMap, will set one up
`default void`	`setArgs(java.lang.Object args)`
`default void`	`setCode(java.lang.String code)`
`default void`	`setFallbackMessage(java.lang.String defMsg)`
`default java.lang.Object[]`	`toArray()` converts the args list to array

- Method Detail
  - getCode
```
default java.lang.String getCode()
```
  - setCode
```
default void setCode(java.lang.String code)
```
  - code
```
default E code(java.lang.String code)
```
  - getArgs
```
@Nullable
default java.lang.Object 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(java.lang.Object args)
```
  - args
```
default E args(java.lang.Object args)
```
  - getArgsMap
```
default java.util.Map getArgsMap()
```
    get the args as a Map, returns null if they are a list and not a map
  - getFallbackMessage
```
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 defMsg)
```
  - fallbackMessage
```
default E fallbackMessage(java.lang.String defMsg)
```
  - isEmpty
```
default boolean isEmpty()
```
  - formatWith
```
default java.lang.String formatWith(java.text.Format messageFormat)
```
    calls format on the passed in messageFormat. works with ICU and stock java one spring uses
  - toArray
```
default java.lang.Object[] toArray()
```
    converts the args list to array
  - getArgMap
```
default java.util.Map getArgMap()
```
    if args is null or empty then this initializes it to a map for names args should check that return map as null means it didnt succeed
    
    Returns:
    
    the initialized Map reference, null if its a list arg
  - putArg
```
default java.util.Map putArg(java.lang.Object key,
                             java.lang.Object val)
```
    adds an arg to the map, see getArgMap, will set one up
    
    Returns:
    
    the args as map
  - isFirstItemMap
```
static boolean isFirstItemMap(java.lang.Object... args)
```
    Checks if args is Array or List and if the first item is a map, if so then it should use that map for the args and ignores the rest. Used for compatibility with Spring tempaltes where is can only pass arrays for args
  - isEmpty
```
static boolean isEmpty(java.lang.Object obj)
```
  - isArray
```
static boolean isArray(java.lang.Object obj)
```
  - getFallbackMessage
```
static java.lang.String getFallbackMessage(java.lang.String fieldMessage,
                                           java.lang.Object args)
```
  - of
```
static DefaultMsgKey of(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

Interface MsgKey<E>

Method Summary

Method Detail

getCode

setCode

code

getArgs

setArgs

args

getArgsMap

getFallbackMessage

setFallbackMessage

fallbackMessage

isEmpty

formatWith

toArray

getArgMap

putArg

isFirstItemMap

isEmpty

isArray

getFallbackMessage

of

of