Update Javadoc of LogFormatUtils

Closes gh-27632
This commit is contained in:
Rossen Stoyanchev 2021-11-08 21:21:54 +00:00
parent ff1485fd8d
commit c5de5c9939
1 changed files with 3 additions and 2 deletions

View File

@ -36,8 +36,9 @@ import org.springframework.lang.Nullable;
public abstract class LogFormatUtils {
/**
* Variant of {@link #formatValue(Object, int, boolean)} and a convenience
* method that truncates at 100 characters when {@code limitLength} is set.
* Convenience variant of {@link #formatValue(Object, int, boolean)} that
* limits the length of a log message to 100 characters and also replaces
* newline characters if {@code limitLength} is set to "true".
* @param value the value to format
* @param limitLength whether to truncate the value at a length of 100
* @return the formatted value