You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@logging.apache.org by gg...@apache.org on 2022/01/05 22:54:56 UTC

[logging-log4j2] 01/02: Log4j 1.2 bridge adds org.apache.log4j.spi.RootLogger.

This is an automated email from the ASF dual-hosted git repository.

ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/logging-log4j2.git

commit b405c93edcca3c9dce8f57ffee12128ef280226f
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Wed Jan 5 17:51:21 2022 -0500

    Log4j 1.2 bridge adds org.apache.log4j.spi.RootLogger.
---
 .../main/java/org/apache/log4j/spi/RootLogger.java | 64 ++++++++++++++++++++++
 1 file changed, 64 insertions(+)

diff --git a/log4j-1.2-api/src/main/java/org/apache/log4j/spi/RootLogger.java b/log4j-1.2-api/src/main/java/org/apache/log4j/spi/RootLogger.java
new file mode 100644
index 0000000..afd4619
--- /dev/null
+++ b/log4j-1.2-api/src/main/java/org/apache/log4j/spi/RootLogger.java
@@ -0,0 +1,64 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ * 
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ * 
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.apache.log4j.spi;
+
+import org.apache.log4j.Level;
+import org.apache.log4j.Logger;
+import org.apache.log4j.helpers.LogLog;
+
+/**
+ * RootLogger sits at the top of the logger hierarchy. It is a regular logger except that it provides several guarantees.
+ * <p>
+ * First, it cannot be assigned a <code>null</code> level. Second, since root logger cannot have a parent, the
+ * {@link #getChainedLevel} method always returns the value of the level field without walking the hierarchy.
+ * </p>
+ */
+public final class RootLogger extends Logger {
+
+    /**
+     * The root logger names itself as "root". However, the root logger cannot be retrieved by name.
+     */
+    public RootLogger(Level level) {
+        // Note that the Log4j 2 root logger name is "".
+        super("root");
+        setLevel(level);
+    }
+
+    /**
+     * Gets the assigned level value without walking the logger hierarchy.
+     */
+    public final Level getChainedLevel() {
+        return getLevel();
+    }
+
+    /**
+     * Sets the log level.
+     *
+     * Setting a null value to the level of the root logger may have catastrophic results. We prevent this here.
+     * 
+     * @since 0.8.3
+     */
+    public final void setLevel(Level level) {
+        if (level == null) {
+            LogLog.error("You have tried to set a null level to root.", new Throwable());
+        } else {
+            super.setLevel(level);
+        }
+    }
+
+}