This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch 2.x
in repository https://gitbox.apache.org/repos/asf/logging-log4j2.git
The following commit(s) were added to refs/heads/2.x by this push:
new 7683460816 Javadoc
7683460816 is described below
commit 7683460816162257a6bff258fd8941d4a2604b14
Author: Gary Gregory <[email protected]>
AuthorDate: Wed Oct 9 09:00:53 2024 -0400
Javadoc
---
.../apache/logging/log4j/core/filter/ThresholdFilter.java | 13 ++++++++-----
1 file changed, 8 insertions(+), 5 deletions(-)
diff --git
a/log4j-core/src/main/java/org/apache/logging/log4j/core/filter/ThresholdFilter.java
b/log4j-core/src/main/java/org/apache/logging/log4j/core/filter/ThresholdFilter.java
index 383532f509..c3fac47698 100644
---
a/log4j-core/src/main/java/org/apache/logging/log4j/core/filter/ThresholdFilter.java
+++
b/log4j-core/src/main/java/org/apache/logging/log4j/core/filter/ThresholdFilter.java
@@ -29,12 +29,15 @@ import org.apache.logging.log4j.message.Message;
import org.apache.logging.log4j.util.PerformanceSensitive;
/**
- * This filter returns the onMatch result if the level in the LogEvent is the
same or more specific
- * than the configured level and the onMismatch value otherwise. For example,
if the ThresholdFilter
- * is configured with Level ERROR and the LogEvent contains Level DEBUG then
the onMismatch value will
- * be returned since ERROR events are more specific than DEBUG.
+ * This filter returns the onMatch result if the level in the {@link LogEvent}
is the same or more specific
+ * than the configured level and the {@code onMismatch} value otherwise. For
example, if the ThresholdFilter
+ * is configured with Level {@code ERROR} and the LogEvent contains Level
{@code DEBUG} then the {@code onMismatch} value will
+ * be returned since {@code ERROR} events are more specific than {@code DEBUG}.
+ * <p>
+ * The default Level is {@code ERROR}.
+ * </p>
*
- * The default Level is ERROR.
+ * @see Level#isMoreSpecificThan(Level)
*/
@Plugin(name = "ThresholdFilter", category = Node.CATEGORY, elementType =
Filter.ELEMENT_TYPE, printObject = true)
@PerformanceSensitive("allocation")
