org.ujorm.tools.msg

Class MessageService

java.lang.Object

org.ujorm.tools.msg.MessageService

@Immutable
public class MessageService
extends Object

Message Service. See the next example:

  final MessageArg TYPE = MessageArg.of("TYPE");
  final MessageArg NAME = MessageArg.of("NAME");

  String expResult = "The ORM framework Ujorm.";
  String template = "The " + TYPE + " framework " + NAME + ".";
  String result = MessageService.formatMsg(template, TYPE, "ORM", NAME, "Ujorm");
  assertEquals(expResult, result);
 

or an similar usage:

  final MessageArg NAME = MessageArg.of("NAME");
  final MessageArg TYPE = MessageArg.of("TYPE");

  String expResult = "The ORM framework Ujorm.";
  String expTemplate = "The ${TYPE} framework ${NAME}.";
  String template = service.template("The ", TYPE, " framework ", NAME, ".");

  Map<String, Object> args = new HashMap<>();
  args.put(TYPE.name(), "ORM");
  args.put(NAME.name(), "Ujorm");

  String result = service.format(template, args);
  assertEquals(expTemplate, template);
  assertEquals(expResult, result);
 

Since:

1.53

See Also:

MessageArg

Field Summary

Fields

Modifier and Type	Field and Description
protected String	begTag Two-character mark ("${") to introducing a template argument.
protected Locale	defaultLocale Default locale
protected char	endTag The mark ("}") to finishing a template argument.

Constructor Summary

Constructors

Constructor and Description
MessageService() Create new instance with the Locale.ENGLISH
MessageService(String begTag, char endTag, Locale defaultLocale)

Method Summary

Modifier and Type	Method and Description
protected String	convertKey(Object key) Convert value.
String	format(Appendable writer, String msg, Map<String,Object> args, Locale locale) Format a template message using named variables.
String	format(String msg, Locale locale, CharSequence key, Object value, Object... keyValuePairs) Format a template message using named variables.
String	format(String msg, Map<String,Object> args) Format a template message using named variables.
String	format(String msg, Map<String,Object> args, Locale locale) Format a template message using named variables.
static String	formatMsg(String template, CharSequence key, Object value, Object... keyValuePairs) Format a target message by a template with arguments type of Map
static String	formatMsg(String template, Map<String,Object> args) Format a target message by a template with arguments
<T> Map<String,Object>	map(T... args) Create a map from man pairs key-value
<T> String	template(T... args) Create a message template from argument pairs key-value
protected void	writeValue(Object value, Appendable writer, Locale locale) Write a value to the output buffer.

Methods inherited from class java.lang.Object

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

Field Detail

begTag

protected final String begTag

Two-character mark ("${") to introducing a template argument.

endTag

protected final char endTag

The mark ("}") to finishing a template argument.

defaultLocale

@Nonnull
protected final Locale defaultLocale

Default locale

Constructor Detail

MessageService

public MessageService()

Create new instance with the Locale.ENGLISH

MessageService

public MessageService(@Nonnull
                      String begTag,
                      @Nonnull
                      char endTag,
                      @Nonnull
                      Locale defaultLocale)

Method Detail

map

public <T> Map<String,Object> map(@Nonnull
                                  T... args)

Create a map from man pairs key-value

Parameters:

args - Key-value pairs

template

public <T> String template(@Nonnull
                           T... args)

Create a message template from argument pairs key-value

Parameters:

args - Sequence of the Objects and Arguments

format

public final String format(@Nullable
                           String msg,
                           @Nullable
                           Map<String,Object> args)

Format a template message using named variables. Each variable must be surrounded by two marks "${" and "}". The first mark is forbidden in a common text and can be replaced by the variable #{MARK}.

Parameters:

msg - Template message, see the simple example:

"The input date ${KEY,%s} must be less than: ${DATE,%F}"

or

"The input date ${KEY,%s} must be less than: ${DATE,%tY-%tm-%td %tH:%tM:%tS}"

The format expression is separated by the character (,) a and it is not mandatory.

args - Key-value map arguments

Returns:

Target result

See Also:

Formatter

format

public final String format(@Nullable
                           String msg,
                           @Nullable
                           Locale locale,
                           @Nonnull
                           CharSequence key,
                           @Nullable
                           Object value,
                           @Nonnull
                           Object... keyValuePairs)

Format a template message using named variables. Each variable must be surrounded by two marks "${" and "}". The first mark is forbidden in a common text and can be replaced by the variable #{MARK}.

Parameters:

msg - Template message, see the simple example:

"The input date ${KEY,%s} must be less than: ${DATE,%F}"

or

"The input date ${KEY,%s} must be less than: ${DATE,%tY-%tm-%td %tH:%tM:%tS}"

The format expression is separated by the character (,) a and it is not mandatory.

locale - The target locale for an argument format, the null locale will be replaced by the defaultLocale.

key - The Key (see a MessageArg)

value - The Value

keyValuePairs - Key-value pairs

See Also:

Formatter

format

public final String format(@Nullable
                           String msg,
                           @Nullable
                           Map<String,Object> args,
                           @Nullable
                           Locale locale)

Format a template message using named variables. Each variable must be surrounded by two marks "${" and "}". The first mark is forbidden in a common text and can be replaced by the variable #{MARK}.

Parameters:

msg - Template message, see the simple example:

"The input date ${KEY,%s} must be less than: ${DATE,%F}"

or

"The input date ${KEY,%s} must be less than: ${DATE,%tY-%tm-%td %tH:%tM:%tS}"

The format expression is separated by the character (,) a and it is not mandatory.

args - Key-value map arguments where arguments type of Supplier ares supported.

locale - The target locale for an argument format, the null locale will be replaced by the defaultLocale.

Returns:

The result message or an empty String if the writter is available.

See Also:

Formatter

format

public final String format(@Nullable
                           Appendable writer,
                           @Nullable
                           String msg,
                           @Nullable
                           Map<String,Object> args,
                           @Nullable
                           Locale locale)
                    throws IOException

Format a template message using named variables. Each variable must be surrounded by two marks "${" and "}". The first mark is forbidden in a common text and can be replaced by the variable #{MARK}.

Parameters:

writer - An optional writer.

msg - Template message, see the simple example:

"The input date ${KEY,%s} must be less than: ${DATE,%F}"

or

"The input date ${KEY,%s} must be less than: ${DATE,%tY-%tm-%td %tH:%tM:%tS}"

The format expression is separated by the character (,) a and it is not mandatory.

args - Key-value map arguments where arguments type of Supplier ares supported.

locale - The target locale for an argument format, the null locale will be replaced by the defaultLocale.

Returns:

The result message of an empty string of writter is available.

Throws:

IOException

See Also:

Formatter

convertKey

@Nullable
protected String convertKey(@Nonnull
                                      Object key)

Convert value. The method can be overwrited for special data types, for example: Key -> Key.getFullName() .

writeValue

protected void writeValue(@Nonnull
                          Object value,
                          @Nonnull
                          Appendable writer,
                          @Nullable
                          Locale locale)
                   throws IOException

Write a value to the output buffer. The method can be overwrited to escaping values. The method can be overwrited for special data types.

Throws:

IOException

formatMsg

public static final String formatMsg(@Nullable
                                     String template,
                                     @Nullable
                                     Map<String,Object> args)

Format a target message by a template with arguments

formatMsg

public static final String formatMsg(@Nullable
                                     String template,
                                     @Nonnull
                                     CharSequence key,
                                     @Nullable
                                     Object value,
                                     @Nonnull
                                     Object... keyValuePairs)

Format a target message by a template with arguments type of Map