org.ujorm.tools

Class MessageService

java.lang.Object

org.ujorm.tools.MessageService

public class MessageService
extends Object

Message Service. See the next example

  final MessageService service = new MessageService();
  final MessageArg<String> NAME = new MessageArg<>("NAME");
  String expResult = "The ORM framework Ujorm.";
  String expTemplate = "The ORM framework ${NAME}.";
  String template = service.template("The ORM framework ", NAME, ".");
  Map args = service.map(NAME, "Ujorm");
  String result = service.format(template, args);
  assertEquals(expTemplate, template);
  assertEquals(expResult, result);
 

Since:

1.53

Field Summary

Fields

Modifier and Type	Field and Description
static String	PARAM_BEG Two-character mark ("${") to introducing a template argument.
static char	PARAM_END The mark ("}") to finishing a template argument.

Constructor Summary

Constructors

Constructor and Description
MessageService()

Method Summary

Modifier and Type	Method and Description
protected void	appendValue(String value, StringBuffer result) Append a value to the output buffer.
protected Object	convertValue(Object value) Convert value.
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.
Map<String,Object>	map(Object... args) Create a map from man pairs key-value
String	template(Object... args) Create a message template from argument pairs key-value

Methods inherited from class java.lang.Object

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

Field Detail

PARAM_BEG

public static final String PARAM_BEG

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

See Also:

Constant Field Values

PARAM_END

public static final char PARAM_END

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

See Also:

Constant Field Values

Constructor Detail

MessageService

public MessageService()

Method Detail

map

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

Create a map from man pairs key-value

Parameters:

args - Key-value pairs

template

public String template(@Nonnull
                       Object... 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
                           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

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

Returns:

Target result

See Also:

Formatter

convertValue

@Nullable
protected Object convertValue(@Nullable
                                        Object value)

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

appendValue

protected void appendValue(@Nullable
                           String value,
                           @Nonnull
                           StringBuffer result)

Append a value to the output buffer. The method can be overwrited to escaping values.