Polish "Document StructuredLoggingJsonMembersCustomizer constructor params"

See gh-43314
This commit is contained in:
Andy Wilkinson 2024-11-28 13:38:32 +00:00
parent 34ac045073
commit 15109b2eb2
1 changed files with 11 additions and 7 deletions

View File

@ -16,23 +16,27 @@
package org.springframework.boot.logging.structured; package org.springframework.boot.logging.structured;
import ch.qos.logback.classic.pattern.ThrowableProxyConverter;
import org.springframework.boot.json.JsonWriter; import org.springframework.boot.json.JsonWriter;
import org.springframework.boot.json.JsonWriter.Members; import org.springframework.boot.json.JsonWriter.Members;
import org.springframework.core.env.Environment;
/** /**
* Customer that can be injected into a {@link StructuredLogFormatter} implementations to * Customizer that can be injected into {@link StructuredLogFormatter} implementations to
* customize {@link JsonWriter} {@link Members}. * customize {@link JsonWriter} {@link Members}.
* <p> * <p>
* An implementation may be provided using the {@code logging.structured.json.customizer} * An implementation may be provided using the {@code logging.structured.json.customizer}
* property. * property.
* <p> * <p>
* {@code StructuredLoggingJsonMembersCustomizer} implementations may optionally take the * Implementing classes can declare the following parameter types in the constructor:
* following constructor parameters:
* <ul> * <ul>
* <li>{@link org.springframework.core.env.Environment} - The Spring * <li>{@link Environment}</li>
* {@code Environment}.</li> * </ul>
* <li>{@link ch.qos.logback.classic.pattern.ThrowableProxyConverter} - The Logback * When using Logback, implementing classes can also use the following parameter types in
* {@code ThrowableProxyConverter} (available only if Logback is using).</li> * the constructor:
* <ul>
* <li>{@link ThrowableProxyConverter}</li>
* </ul> * </ul>
* *
* @param <T> the type being written * @param <T> the type being written