Package org.springframework.core.log
Class LogMessage
java.lang.Object
org.springframework.core.log.LogMessage
- All Implemented Interfaces:
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 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, Sebastien Deleuze
- See Also:
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionchar
charAt
(int index) static LogMessage
Build a lazily formatted message from the given format string and argument.static LogMessage
Build a lazily formatted message from the given format string and varargs.static LogMessage
Build a lazily formatted message from the given format string and arguments.static LogMessage
Build a lazily formatted message from the given format string and arguments.static LogMessage
Build a lazily formatted message from the given format string and arguments.int
length()
static LogMessage
of
(Supplier<? extends CharSequence> supplier) Build a lazily resolving message from the given supplier.subSequence
(int start, int end) 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, isEmpty
-
Constructor Details
-
LogMessage
public LogMessage()
-
-
Method Details
-
length
public int length()- Specified by:
length
in interfaceCharSequence
-
charAt
public char charAt(int index) - Specified by:
charAt
in interfaceCharSequence
-
subSequence
- Specified by:
subSequence
in interfaceCharSequence
-
toString
This will be called by the logging provider, potentially once per log target (therefore locally caching the result here).- Specified by:
toString
in interfaceCharSequence
- Overrides:
toString
in classObject
-
of
Build a lazily resolving message from the given supplier.- Parameters:
supplier
- the supplier (typically bound to a lambda expression)- See Also:
-
format
Build a lazily formatted message from the given format string and argument.- Parameters:
format
- the format string (followingString.format(java.lang.String, java.lang.Object...)
rules)arg1
- the argument (can benull
)- See Also:
-
format
Build a lazily formatted message from the given format string and arguments.- Parameters:
format
- the format string (followingString.format(java.lang.String, java.lang.Object...)
rules)arg1
- the first argument (can benull
)arg2
- the second argument (can benull
)- See Also:
-
format
public static LogMessage format(String format, @Nullable Object arg1, @Nullable Object arg2, @Nullable Object arg3) Build a lazily formatted message from the given format string and arguments.- Parameters:
format
- the format string (followingString.format(java.lang.String, java.lang.Object...)
rules)arg1
- the first argument (can benull
)arg2
- the second argument (can benull
)arg3
- the third argument (can benull
)- See Also:
-
format
public static LogMessage format(String format, @Nullable Object arg1, @Nullable Object arg2, @Nullable Object arg3, @Nullable Object arg4) Build a lazily formatted message from the given format string and arguments.- Parameters:
format
- the format string (followingString.format(java.lang.String, java.lang.Object...)
rules)arg1
- the first argument (can benull
)arg2
- the second argument (can benull
)arg3
- the third argument (can benull
)arg4
- the fourth argument (can benull
)- See Also:
-
format
Build a lazily formatted message from the given format string and varargs.This varargs
format()
variant may be costly. You should therefore use the individual argument variants whenever possible;format(String, Object)
,format(String, Object, Object)
, etc.- Parameters:
format
- the format string (followingString.format(java.lang.String, java.lang.Object...)
rules)args
- the varargs array (can benull
and can containnull
elements)- See Also:
-