info.magnolia.freemarker

Class MessagesWrapper

java.lang.Object

info.magnolia.freemarker.MessagesWrapper

public class MessagesWrapper
extends Object

Utility class that has methods which allow passing multiple parameters from a freemarker template to a message string using the square bracket syntax (e.g. ${i18n.get('message', ['param1', 'param2']}). There are convenience methods which allow selecting the message bundle directly from within the template as well (by passing the basename parameter), but using those methods removed fallback to default message bundles so they should be used only when such custom bundle contains all messages requested in given context.

See Also:

for more syntax details.

Method Summary

Modifier and Type	Method and Description
String	get(String key) We still use the deprecated method TranslationService.translate(info.magnolia.i18nsystem.LocaleProvider, String, String[]) due to compatibility with obsolete i18nBasename, the method TranslationService.translate(info.magnolia.i18nsystem.LocaleProvider, String[]) calls this method internally anyway.
String	get(String key, List args)
protected String	get(String key, List args, Messages messages) Deprecated. since 5.4.4. Use get(String, java.util.List) instead.
String	get(String key, List args, String basename) Deprecated. since 5.4.4. Use get(String, java.util.List) instead.
protected String	get(String key, Messages messages) Deprecated. since 5.4.4. Use get(String) instead.
String	get(String key, String basename) Deprecated. since 5.4.4. Use get(String) instead.
String	getWithDefault(String key, List args, String defaultMsg) Deprecated. since 5.4.4. Use get(String, java.util.List) instead.
protected String	getWithDefault(String key, List args, String defaultMsg, Messages messages) Deprecated. since 5.4.4. Use get(String, java.util.List) instead.
String	getWithDefault(String key, List args, String defaultMsg, String basename) Deprecated. since 5.4.4. Use get(String, java.util.List) instead.
String	getWithDefault(String key, String defaultMsg) Deprecated. since 5.4.4. Use get(String, java.util.List) instead.
protected String	getWithDefault(String key, String defaultMsg, Messages messages) Deprecated. since 5.4.4. Use get(String, java.util.List) instead.
String	getWithDefault(String key, String defaultMsg, String basename) Deprecated. since 5.4.4. Use get(String, java.util.List) instead.

Methods inherited from class java.lang.Object

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

Method Detail

get

public String get(String key)

We still use the deprecated method TranslationService.translate(info.magnolia.i18nsystem.LocaleProvider, String, String[]) due to compatibility with obsolete i18nBasename, the method TranslationService.translate(info.magnolia.i18nsystem.LocaleProvider, String[]) calls this method internally anyway.

get

public String get(String key,
                  List args)

get

@Deprecated
public String get(String key,
                              String basename)

Deprecated. since 5.4.4. Use get(String) instead.

get

@Deprecated
public String get(String key,
                              List args,
                              String basename)

Deprecated. since 5.4.4. Use get(String, java.util.List) instead.

getWithDefault

@Deprecated
public String getWithDefault(String key,
                                         String defaultMsg)

Deprecated. since 5.4.4. Use get(String, java.util.List) instead.

getWithDefault

@Deprecated
public String getWithDefault(String key,
                                         String defaultMsg,
                                         String basename)

Deprecated. since 5.4.4. Use get(String, java.util.List) instead.

getWithDefault

@Deprecated
public String getWithDefault(String key,
                                         List args,
                                         String defaultMsg)

Deprecated. since 5.4.4. Use get(String, java.util.List) instead.

getWithDefault

@Deprecated
public String getWithDefault(String key,
                                         List args,
                                         String defaultMsg,
                                         String basename)

Deprecated. since 5.4.4. Use get(String, java.util.List) instead.

get

@Deprecated
protected String get(String key,
                                 Messages messages)

Deprecated. since 5.4.4. Use get(String) instead.

get

@Deprecated
protected String get(String key,
                                 List args,
                                 Messages messages)

Deprecated. since 5.4.4. Use get(String, java.util.List) instead.

getWithDefault

@Deprecated
protected String getWithDefault(String key,
                                            String defaultMsg,
                                            Messages messages)

Deprecated. since 5.4.4. Use get(String, java.util.List) instead.

getWithDefault

@Deprecated
protected String getWithDefault(String key,
                                            List args,
                                            String defaultMsg,
                                            Messages messages)

Deprecated. since 5.4.4. Use get(String, java.util.List) instead.