Package io.netty.util.internal.logging
Class MessageFormatter
java.lang.Object
io.netty.util.internal.logging.MessageFormatter
Formats messages according to very simple substitution rules. Substitutions
can be made 1, 2 or more arguments.
For example,
MessageFormatter.format("Hi {}.", "there")will return the string "Hi there.". The {} pair is called the formatting anchor. It serves to designate the location where arguments need to be substituted within the message pattern. In case your message contains the '{' or the '}' character, you do not have to do anything special unless the '}' character immediately follows '{'. For example,
MessageFormatter.format("Set {1,2,3} is not equal to {}.", "1,2");will return the string "Set {1,2,3} is not equal to 1,2.". If for whatever reason you need to place the string "{}" in the message without its formatting anchor meaning, then you need to escape the '{' character with '\', that is the backslash character. Only the '{' character should be escaped. There is no need to escape the '}' character. For example,
MessageFormatter.format("Set \\{} is not equal to {}.", "1,2");will return the string "Set {} is not equal to 1,2.". The escaping behavior just described can be overridden by escaping the escape character '\'. Calling
MessageFormatter.format("File name is C:\\\\{}.", "file.zip");will return the string "File name is C:\file.zip". The formatting conventions are different than those of
MessageFormat
which ships with the Java platform. This is justified by the fact that
SLF4J's implementation is 10 times faster than that of MessageFormat
.
This local performance difference is both measurable and significant in the
larger context of the complete logging processing chain.
See also format(String, Object)
,
format(String, Object, Object)
and
arrayFormat(String, Object[])
methods for more details.-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic FormattingTuple
arrayFormat
(String messagePattern, Object[] argArray) Same principle as theformat(String, Object)
andformat(String, Object, Object)
methods except that any number of arguments can be passed in an array.private static void
booleanArrayAppend
(StringBuilder sbuf, boolean[] a) private static void
byteArrayAppend
(StringBuilder sbuf, byte[] a) private static void
charArrayAppend
(StringBuilder sbuf, char[] a) private static void
deeplyAppendParameter
(StringBuilder sbuf, Object o, Set<Object[]> seenSet) private static void
doubleArrayAppend
(StringBuilder sbuf, double[] a) private static void
floatArrayAppend
(StringBuilder sbuf, float[] a) static FormattingTuple
Performs single argument substitution for the 'messagePattern' passed as parameter.static FormattingTuple
Performs a two argument substitution for the 'messagePattern' passed as parameter.private static void
intArrayAppend
(StringBuilder sbuf, int[] a) private static void
longArrayAppend
(StringBuilder sbuf, long[] a) private static void
objectArrayAppend
(StringBuilder sbuf, Object[] a, Set<Object[]> seenSet) private static void
safeObjectAppend
(StringBuilder sbuf, Object o) private static void
shortArrayAppend
(StringBuilder sbuf, short[] a)
-
Field Details
-
DELIM_STR
- See Also:
-
ESCAPE_CHAR
private static final char ESCAPE_CHAR- See Also:
-
-
Constructor Details
-
MessageFormatter
private MessageFormatter()
-
-
Method Details
-
format
Performs single argument substitution for the 'messagePattern' passed as parameter. For example,MessageFormatter.format("Hi {}.", "there");
will return the string "Hi there.".- Parameters:
messagePattern
- The message pattern which will be parsed and formattedarg
- The argument to be substituted in place of the formatting anchor- Returns:
- The formatted message
-
format
Performs a two argument substitution for the 'messagePattern' passed as parameter. For example,MessageFormatter.format("Hi {}. My name is {}.", "Alice", "Bob");
will return the string "Hi Alice. My name is Bob.".- Parameters:
messagePattern
- The message pattern which will be parsed and formattedargA
- The argument to be substituted in place of the first formatting anchorargB
- The argument to be substituted in place of the second formatting anchor- Returns:
- The formatted message
-
arrayFormat
Same principle as theformat(String, Object)
andformat(String, Object, Object)
methods except that any number of arguments can be passed in an array.- Parameters:
messagePattern
- The message pattern which will be parsed and formattedargArray
- An array of arguments to be substituted in place of formatting anchors- Returns:
- The formatted message
-
deeplyAppendParameter
-
safeObjectAppend
-
objectArrayAppend
-
booleanArrayAppend
-
byteArrayAppend
-
charArrayAppend
-
shortArrayAppend
-
intArrayAppend
-
longArrayAppend
-
floatArrayAppend
-
doubleArrayAppend
-