org.spf4j.base

Class Slf4jMessageFormatter

java.lang.Object

org.spf4j.base.Slf4jMessageFormatter

public final class Slf4jMessageFormatter
extends Object

A more flexible implementation of the SLF4j message formatter (org.slf4j.helpers.MessageFormatter). the following improvements: 1) Allow to format to a procvided destination (Appendable) allowing you to reduce the amount of garbage generated in a custom formatter... 2) Lets you know which arguments have been used in the message allowing you to implement extra logic to handle the unused ones 3) Lets you plug custom formatters for argument types. (you can get better performance and more flexibility) 4) Processing arguments that are arrays is sligtly faster than the slf4j formatter.

Author:

zoly

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Slf4jMessageFormatter.ErrorHandler

Method Summary

Modifier and Type	Method and Description
static void	exHandle(Object obj, Appendable sbuf, Throwable t)
static int	format(Appendable to, ObjectAppenderSupplier appSupplier, String messagePattern, Object... argArray) Slf4j message formatter.
static int	format(Appendable to, String messagePattern, Object... argArray) Slf4j message formatter.
static int	format(Appendable to, String messagePattern, ObjectAppenderSupplier appSupplier, Object... argArray) slf4j message formatter.
static int	format(int firstArgIdx, Appendable to, String messagePattern, ObjectAppenderSupplier appSupplier, Object... argArray) Slf4j message formatter.
static int	format(Slf4jMessageFormatter.ErrorHandler exHandler, int firstArgIdx, Appendable to, String messagePattern, ObjectAppenderSupplier appSupplier, Object... argArray) Slf4j message formatter.
static void	safeObjectAppend(Slf4jMessageFormatter.ErrorHandler exHandler, Appendable sbuf, Object obj, ObjectAppenderSupplier appSupplier)
static String	toString(String messagePattern, Object... argArray)

Methods inherited from class java.lang.Object

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

Method Detail

exHandle

public static void exHandle(Object obj,
                            Appendable sbuf,
                            Throwable t)
                     throws IOException

Throws:

IOException

toString

public static String toString(@Nonnull
                              String messagePattern,
                              Object... argArray)

format

public static int format(@Nonnull
                         Appendable to,
                         @Nonnull
                         String messagePattern,
                         Object... argArray)
                  throws IOException

Slf4j message formatter.

Parameters:

to - Appendable to put formatted message to.

messagePattern - see org.slf4j.helpers.MessageFormatter for format.

argArray - the message arguments.

Returns:

the number of arguments used in the message.

Throws:

IOException

format

public static int format(@Nonnull
                         Appendable to,
                         @Nonnull
                         ObjectAppenderSupplier appSupplier,
                         @Nonnull
                         String messagePattern,
                         Object... argArray)
                  throws IOException

Slf4j message formatter.

Parameters:

to - Appendable to put formatted message to.

appSupplier - a supplier that will provide the serialization method for a particular argument type.

messagePattern - see org.slf4j.helpers.MessageFormatter for format.

argArray - the message arguments.

Returns:

the number of arguments used in the message.

Throws:

IOException

format

public static int format(@Nonnull
                         Appendable to,
                         @Nonnull
                         String messagePattern,
                         @Nonnull
                         ObjectAppenderSupplier appSupplier,
                         Object... argArray)
                  throws IOException

slf4j message formatter.

Parameters:

to - Appendable to put formatted message to.

messagePattern - see org.slf4j.helpers.MessageFormatter for format.

appSupplier - a supplier that will provide the serialization method for a particular argument type.

argArray - the message arguments.

Returns:

the number of arguments used in the message.

Throws:

IOException - something wend wrong while writing to the appendable.

format

public static int format(int firstArgIdx,
                         @Nonnull
                         Appendable to,
                         @Nonnull
                         String messagePattern,
                         @Nonnull
                         ObjectAppenderSupplier appSupplier,
                         Object... argArray)
                  throws IOException

Slf4j message formatter.

Parameters:

to - Appendable to put formatted message to.

messagePattern - see org.slf4j.helpers.MessageFormatter for format.

appSupplier - a supplier that will provide the serialization method for a particular argument type.

firstArgIdx - the index of the first parameter.

argArray - the message arguments.

Returns:

the index of the last arguments used in the message + 1.

Throws:

IOException - something wend wrong while writing to the appendable.

format

public static int format(Slf4jMessageFormatter.ErrorHandler exHandler,
                         int firstArgIdx,
                         @Nonnull
                         Appendable to,
                         @Nonnull
                         String messagePattern,
                         @Nonnull
                         ObjectAppenderSupplier appSupplier,
                         Object... argArray)
                  throws IOException

Slf4j message formatter.

Parameters:

safe - - if true recoverable exHandle will be caught when writing arguments, and a error will be appended instead.

to - Appendable to put formatted message to.

messagePattern - see org.slf4j.helpers.MessageFormatter for format.

appSupplier - a supplier that will provide the serialization method for a particular argument type.

firstArgIdx - the index of the first parameter.

argArray - the message arguments.

Returns:

the index of the last arguments used in the message + 1.

Throws:

IOException - something wend wrong while writing to the appendable.

safeObjectAppend

public static void safeObjectAppend(Slf4jMessageFormatter.ErrorHandler exHandler,
                                    Appendable sbuf,
                                    Object obj,
                                    ObjectAppenderSupplier appSupplier)
                             throws IOException

Throws:

IOException