yakworks.i18n

Class MsgArgs

java.lang.Object

yakworks.i18n.MsgArgs

public class MsgArgs
extends java.lang.Object

An arg wrapper that allows the args to be an array, List or Map

Since:

0.3.0

Constructor Summary

Constructors

Constructor and Description
MsgArgs()

Method Summary

Modifier and Type	Method and Description
MsgArgs	args(java.lang.Object args)
java.util.Map	asMap() 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
static MsgArgs	empty() gets an instance initialzed with and empty map
java.lang.String	formatWith(java.text.Format messageFormat) calls messageFormat.format on the passed in messageFormat.
java.lang.Object	get()
java.lang.String	getFallbackMessage() static helper to lookup the fallback in the args if its a map
static boolean	isArray(java.lang.Object obj)
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.
boolean	isMap()
boolean	isPresent()
static MsgArgs	of(java.lang.Object args)
java.util.Map	put(java.lang.Object key, java.lang.Object val) adds an arg to the map, see getArgMap, will set one up
java.util.Map	putIfAbsent(java.lang.Object key, java.lang.Object val) adds an enrty to the msg arg if its a map returns the map or null if its list/array based args
void	setArgs(java.lang.Object args)
java.lang.Object[]	toArray() converts the args list to array

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MsgArgs

public MsgArgs()

Method Detail

of

public static MsgArgs of(java.lang.Object args)

get

public java.lang.Object get()

isPresent

public boolean isPresent()

setArgs

public void setArgs(java.lang.Object args)

args

public MsgArgs args(java.lang.Object args)

isEmpty

public boolean isEmpty()

isMap

public boolean isMap()

formatWith

public java.lang.String formatWith(java.text.Format messageFormat)

calls messageFormat.format on the passed in messageFormat. if the args is a list then it tranforms it to an array if map then passed it straight in.

toArray

public java.lang.Object[] toArray()

converts the args list to array

asMap

public java.util.Map asMap()

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

putIfAbsent

public java.util.Map putIfAbsent(java.lang.Object key,
                                 java.lang.Object val)

adds an enrty to the msg arg if its a map returns the map or null if its list/array based args

put

public java.util.Map put(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

getFallbackMessage

public java.lang.String getFallbackMessage()

static helper to lookup the fallback in the args if its a map

empty

public static MsgArgs empty()

gets an instance initialzed with and empty map

isFirstItemMap

public 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

public static boolean isEmpty(java.lang.Object obj)

isArray

public static boolean isArray(java.lang.Object obj)