Skip to content

Commit 15109b2

Browse files
committed
Polish "Document StructuredLoggingJsonMembersCustomizer constructor params"
See gh-43314
1 parent 34ac045 commit 15109b2

File tree

1 file changed

+11
-7
lines changed

1 file changed

+11
-7
lines changed

spring-boot-project/spring-boot/src/main/java/org/springframework/boot/logging/structured/StructuredLoggingJsonMembersCustomizer.java

+11-7
Original file line numberDiff line numberDiff line change
@@ -16,23 +16,27 @@
1616

1717
package org.springframework.boot.logging.structured;
1818

19+
import ch.qos.logback.classic.pattern.ThrowableProxyConverter;
20+
1921
import org.springframework.boot.json.JsonWriter;
2022
import org.springframework.boot.json.JsonWriter.Members;
23+
import org.springframework.core.env.Environment;
2124

2225
/**
23-
* Customer that can be injected into a {@link StructuredLogFormatter} implementations to
26+
* Customizer that can be injected into {@link StructuredLogFormatter} implementations to
2427
* customize {@link JsonWriter} {@link Members}.
2528
* <p>
2629
* An implementation may be provided using the {@code logging.structured.json.customizer}
2730
* property.
2831
* <p>
29-
* {@code StructuredLoggingJsonMembersCustomizer} implementations may optionally take the
30-
* following constructor parameters:
32+
* Implementing classes can declare the following parameter types in the constructor:
33+
* <ul>
34+
* <li>{@link Environment}</li>
35+
* </ul>
36+
* When using Logback, implementing classes can also use the following parameter types in
37+
* the constructor:
3138
* <ul>
32-
* <li>{@link org.springframework.core.env.Environment} - The Spring
33-
* {@code Environment}.</li>
34-
* <li>{@link ch.qos.logback.classic.pattern.ThrowableProxyConverter} - The Logback
35-
* {@code ThrowableProxyConverter} (available only if Logback is using).</li>
39+
* <li>{@link ThrowableProxyConverter}</li>
3640
* </ul>
3741
*
3842
* @param <T> the type being written

0 commit comments

Comments
 (0)