org.springframework.core.log

Class LogMessage

java.lang.Object

org.springframework.core.log.LogMessage

All Implemented Interfaces:

java.lang.CharSequence

Direct Known Subclasses:

LogMessage.FormatMessage, LogMessage.SupplierMessage

public abstract class LogMessage
extends java.lang.Object
implements java.lang.CharSequence

A simple log message type for use with Commons Logging, allowing for convenient lazy resolution of a given Supplier instance (typically bound to a Java 8 lambda expression) or a printf-style format string (String.format(java.lang.String, java.lang.Object...))in its toString().

Since:

5.2

Author:

Juergen Hoeller

See Also:

of(Supplier), format(String, Object), format(String, Object...), Log.fatal(Object), Log.error(Object), Log.warn(Object), Log.info(Object), Log.debug(Object), Log.trace(Object)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	LogMessage.FormatMessage
private static class	LogMessage.FormatMessage1
private static class	LogMessage.FormatMessage2
private static class	LogMessage.FormatMessage3
private static class	LogMessage.FormatMessage4
private static class	LogMessage.FormatMessageX
private static class	LogMessage.SupplierMessage

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	result

Constructor Summary

Constructors

Constructor and Description
LogMessage()

Method Summary

Modifier and Type	Method and Description
(package private) abstract java.lang.String	buildString()
char	charAt(int index)
static LogMessage	format(java.lang.String format, java.lang.Object... args) Build a lazily formatted message from the given format string and varargs.
static LogMessage	format(java.lang.String format, java.lang.Object arg1) Build a lazily formatted message from the given format string and argument.
static LogMessage	format(java.lang.String format, java.lang.Object arg1, java.lang.Object arg2) Build a lazily formatted message from the given format string and arguments.
static LogMessage	format(java.lang.String format, java.lang.Object arg1, java.lang.Object arg2, java.lang.Object arg3) Build a lazily formatted message from the given format string and arguments.
static LogMessage	format(java.lang.String format, java.lang.Object arg1, java.lang.Object arg2, java.lang.Object arg3, java.lang.Object arg4) Build a lazily formatted message from the given format string and arguments.
int	length()
static LogMessage	of(java.util.function.Supplier<? extends java.lang.CharSequence> supplier) Build a lazily resolving message from the given supplier.
java.lang.CharSequence	subSequence(int start, int end)
java.lang.String	toString() This will be called by the logging provider, potentially once per log target (therefore locally caching the result here).

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.CharSequence

chars, codePoints

Field Detail

result

@Nullable
private java.lang.String result

Constructor Detail

LogMessage

public LogMessage()

Method Detail

length

public int length()

Specified by:

length in interface java.lang.CharSequence

charAt

public char charAt(int index)

Specified by:

charAt in interface java.lang.CharSequence

subSequence

public java.lang.CharSequence subSequence(int start,
                                          int end)

Specified by:

subSequence in interface java.lang.CharSequence

toString

public java.lang.String toString()

This will be called by the logging provider, potentially once per log target (therefore locally caching the result here).

Specified by:

toString in interface java.lang.CharSequence

Overrides:

toString in class java.lang.Object

buildString

abstract java.lang.String buildString()

of

public static LogMessage of(java.util.function.Supplier<? extends java.lang.CharSequence> supplier)

Build a lazily resolving message from the given supplier.

Parameters:

supplier - the supplier (typically bound to a Java 8 lambda expression)

See Also:

toString()

format

public static LogMessage format(java.lang.String format,
                                java.lang.Object arg1)

Build a lazily formatted message from the given format string and argument.

Parameters:

format - the format string (following String.format(java.lang.String, java.lang.Object...) rules)

arg1 - the argument

See Also:

String.format(String, Object...)

format

public static LogMessage format(java.lang.String format,
                                java.lang.Object arg1,
                                java.lang.Object arg2)

Build a lazily formatted message from the given format string and arguments.

Parameters:

format - the format string (following String.format(java.lang.String, java.lang.Object...) rules)

arg1 - the first argument

arg2 - the second argument

See Also:

String.format(String, Object...)

format

public static LogMessage format(java.lang.String format,
                                java.lang.Object arg1,
                                java.lang.Object arg2,
                                java.lang.Object arg3)

Build a lazily formatted message from the given format string and arguments.

Parameters:

format - the format string (following String.format(java.lang.String, java.lang.Object...) rules)

arg1 - the first argument

arg2 - the second argument

arg3 - the third argument

See Also:

String.format(String, Object...)

format

public static LogMessage format(java.lang.String format,
                                java.lang.Object arg1,
                                java.lang.Object arg2,
                                java.lang.Object arg3,
                                java.lang.Object arg4)

Build a lazily formatted message from the given format string and arguments.

Parameters:

format - the format string (following String.format(java.lang.String, java.lang.Object...) rules)

arg1 - the first argument

arg2 - the second argument

arg3 - the third argument

arg4 - the fourth argument

See Also:

String.format(String, Object...)

format

public static LogMessage format(java.lang.String format,
                                java.lang.Object... args)

Build a lazily formatted message from the given format string and varargs.

Parameters:

format - the format string (following String.format(java.lang.String, java.lang.Object...) rules)

args - the varargs array (costly, prefer individual arguments)

See Also:

String.format(String, Object...)