This is an automated email from the ASF dual-hosted git repository. mattsicker pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/logging-log4j2.git
commit e562596281d9ad5a88ec9dea4fd1ee791725a6d6 Author: Matt Sicker <[email protected]> AuthorDate: Sun Oct 30 14:20:15 2022 -0500 Add javadoc for context factory interfaces Signed-off-by: Matt Sicker <[email protected]> --- .../org/apache/logging/log4j/spi/ThreadContextMap.java | 5 +++++ .../apache/logging/log4j/spi/ThreadContextStack.java | 18 ++++++++++++++++++ 2 files changed, 23 insertions(+) diff --git a/log4j-api/src/main/java/org/apache/logging/log4j/spi/ThreadContextMap.java b/log4j-api/src/main/java/org/apache/logging/log4j/spi/ThreadContextMap.java index 95edcdbc86..53802786fe 100644 --- a/log4j-api/src/main/java/org/apache/logging/log4j/spi/ThreadContextMap.java +++ b/log4j-api/src/main/java/org/apache/logging/log4j/spi/ThreadContextMap.java @@ -168,6 +168,11 @@ public interface ThreadContextMap { values.forEach(this::putValue); } + /** + * Factory for creating {@link ThreadContextMap} instances. + * + * @see DefaultContextMapFactory + */ interface Factory { /** * Creates a new ThreadContextMap. diff --git a/log4j-api/src/main/java/org/apache/logging/log4j/spi/ThreadContextStack.java b/log4j-api/src/main/java/org/apache/logging/log4j/spi/ThreadContextStack.java index 04d2ece0bf..62a11c8880 100644 --- a/log4j-api/src/main/java/org/apache/logging/log4j/spi/ThreadContextStack.java +++ b/log4j-api/src/main/java/org/apache/logging/log4j/spi/ThreadContextStack.java @@ -23,4 +23,22 @@ import org.apache.logging.log4j.ThreadContext; */ public interface ThreadContextStack extends ThreadContext.ContextStack { // empty + + /** + * Factory for creating {@link ThreadContextStack} instances. + * + * @see DefaultContextStackFactory + */ + interface Factory { + /** + * Creates a new ThreadContextStack. + */ + ThreadContextStack createThreadContextStack(); + + /** + * Indicates if context stacks are enabled. When disabled, {@link ThreadContextStack} instances are all + * empty operations. + */ + boolean isEnabled(); + } }
