Top Description Fields Constructors Methods
org.slf4j.helpers

public final Class MessageFormatter

extends Object
Class Inheritance
Imports
java.text.MessageFormat, java.util.HashMap, .Map

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 from 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.

Authors
Ceki Gülcü, Joern Huxhorn

Field Summary

Modifier and TypeField and Description
pack-priv static final char
pack-priv static final char
pack-priv static final String
private static final char

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public static final FormattingTuple
arrayFormat(final String messagePattern, final Object[] argArray)

public static final FormattingTuple
arrayFormat(final String messagePattern, final Object[] argArray, Throwable throwable)

public static final String
basicArrayFormat(final String messagePattern, final Object[] argArray)

Assumes that argArray only contains arguments with no throwable as last element.

public static String
private static void
booleanArrayAppend(StringBuilder sbuf, boolean[] a)

private static void
private static void
private static void
private static void
doubleArrayAppend(StringBuilder sbuf, double[] a)

private static void
public static final FormattingTuple

Returns:

The formatted message
format
(String
The message pattern which will be parsed and formatted
messagePattern
,
Object
The argument to be substituted in place of the formatting anchor
arg
)

Performs single argument substitution for the 'messagePattern' passed as parameter.

public static final FormattingTuple

Returns:

The formatted message
format
(final String
The message pattern which will be parsed and formatted
messagePattern
,
Object
The argument to be substituted in place of the first formatting anchor
arg1
,
Object
The argument to be substituted in place of the second formatting anchor
arg2
)

Performs a two argument substitution for the 'messagePattern' passed as parameter.

public static Throwable

Returns:

if the last Object in argArray is a Throwable this method will return it, otherwise it returns null
getThrowableCandidate
(final Object[]
The arguments off which we want to know if it contains a Throwable as last element
argArray
)

Helper method to determine if an Object array contains a Throwable as last element

private static void
pack-priv static final boolean
isDoubleEscaped(String messagePattern, int delimeterStartIndex)

pack-priv static final boolean
isEscapedDelimeter(String messagePattern, int delimeterStartIndex)

private static void
private static void
private static void
private static void
public static Object[]

Returns:

a copy of the array without the last element
trimmedCopy
(final Object[]
The arguments from which we want to remove the last element
argArray
)

Helper method to get all but the last element of an array

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

DELIM_STARTback to summary
pack-priv static final char DELIM_START
DELIM_STOPback to summary
pack-priv static final char DELIM_STOP
DELIM_STRback to summary
pack-priv static final String DELIM_STR
ESCAPE_CHARback to summary
private static final char ESCAPE_CHAR

Constructor Detail

MessageFormatterback to summary
public MessageFormatter()

Method Detail

arrayFormatback to summary
public static final FormattingTuple arrayFormat(final String messagePattern, final Object[] argArray)
arrayFormatback to summary
public static final FormattingTuple arrayFormat(final String messagePattern, final Object[] argArray, Throwable throwable)
basicArrayFormatback to summary
public static final String basicArrayFormat(final String messagePattern, final Object[] argArray)

Assumes that argArray only contains arguments with no throwable as last element.

basicArrayFormatback to summary
public static String basicArrayFormat(NormalizedParameters np)
booleanArrayAppendback to summary
private static void booleanArrayAppend(StringBuilder sbuf, boolean[] a)
byteArrayAppendback to summary
private static void byteArrayAppend(StringBuilder sbuf, byte[] a)
charArrayAppendback to summary
private static void charArrayAppend(StringBuilder sbuf, char[] a)
deeplyAppendParameterback to summary
private static void deeplyAppendParameter(StringBuilder sbuf, Object o, Map<Object[], Object> seenMap)
doubleArrayAppendback to summary
private static void doubleArrayAppend(StringBuilder sbuf, double[] a)
floatArrayAppendback to summary
private static void floatArrayAppend(StringBuilder sbuf, float[] a)
formatback to summary
public static final FormattingTuple format(String messagePattern, Object arg)

Performs single argument substitution for the 'messagePattern' passed as parameter.

For example,

MessageFormatter.format("Hi {}.", "there");
will return the string "Hi there.".

Parameters
messagePattern:String

The message pattern which will be parsed and formatted

arg:Object

The argument to be substituted in place of the formatting anchor

Returns:FormattingTuple

The formatted message

formatback to summary
public static final FormattingTuple format(final String messagePattern, Object arg1, Object arg2)

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:String

The message pattern which will be parsed and formatted

arg1:Object

The argument to be substituted in place of the first formatting anchor

arg2:Object

The argument to be substituted in place of the second formatting anchor

Returns:FormattingTuple

The formatted message

getThrowableCandidateback to summary
public static Throwable getThrowableCandidate(final Object[] argArray)

Helper method to determine if an Object array contains a Throwable as last element

Parameters
argArray:Object[]

The arguments off which we want to know if it contains a Throwable as last element

Returns:Throwable

if the last Object in argArray is a Throwable this method will return it, otherwise it returns null

intArrayAppendback to summary
private static void intArrayAppend(StringBuilder sbuf, int[] a)
isDoubleEscapedback to summary
pack-priv static final boolean isDoubleEscaped(String messagePattern, int delimeterStartIndex)
isEscapedDelimeterback to summary
pack-priv static final boolean isEscapedDelimeter(String messagePattern, int delimeterStartIndex)
longArrayAppendback to summary
private static void longArrayAppend(StringBuilder sbuf, long[] a)
objectArrayAppendback to summary
private static void objectArrayAppend(StringBuilder sbuf, Object[] a, Map<Object[], Object> seenMap)
safeObjectAppendback to summary
private static void safeObjectAppend(StringBuilder sbuf, Object o)
shortArrayAppendback to summary
private static void shortArrayAppend(StringBuilder sbuf, short[] a)
trimmedCopyback to summary
public static Object[] trimmedCopy(final Object[] argArray)

Helper method to get all but the last element of an array

Parameters
argArray:Object[]

The arguments from which we want to remove the last element

Returns:Object[]

a copy of the array without the last element