You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@logging.apache.org by ma...@apache.org on 2017/08/26 20:53:58 UTC
[40/50] logging-log4j2 git commit: Improve javadocs
Improve javadocs
Project: http://git-wip-us.apache.org/repos/asf/logging-log4j2/repo
Commit: http://git-wip-us.apache.org/repos/asf/logging-log4j2/commit/bf06bb25
Tree: http://git-wip-us.apache.org/repos/asf/logging-log4j2/tree/bf06bb25
Diff: http://git-wip-us.apache.org/repos/asf/logging-log4j2/diff/bf06bb25
Branch: refs/heads/LOG4J2-1431
Commit: bf06bb253e030d7d4b7fb0bf782438b3b232139e
Parents: 44254d2
Author: Matt Sicker <bo...@gmail.com>
Authored: Sun Feb 5 15:39:47 2017 -0600
Committer: Matt Sicker <ma...@spr.com>
Committed: Sat Aug 26 15:50:56 2017 -0500
----------------------------------------------------------------------
.../org/apache/logging/log4j/util/PropertiesUtil.java | 12 +++++++++---
1 file changed, 9 insertions(+), 3 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/logging-log4j2/blob/bf06bb25/log4j-api/src/main/java/org/apache/logging/log4j/util/PropertiesUtil.java
----------------------------------------------------------------------
diff --git a/log4j-api/src/main/java/org/apache/logging/log4j/util/PropertiesUtil.java b/log4j-api/src/main/java/org/apache/logging/log4j/util/PropertiesUtil.java
index 46f3344..6acf707 100644
--- a/log4j-api/src/main/java/org/apache/logging/log4j/util/PropertiesUtil.java
+++ b/log4j-api/src/main/java/org/apache/logging/log4j/util/PropertiesUtil.java
@@ -33,13 +33,19 @@ import java.util.concurrent.ConcurrentHashMap;
/**
* <em>Consider this class private.</em>
* <p>
- * Helps access properties. This utility provides a method to override system properties by specifying properties in a
- * properties file.
+ * Provides utility methods for managing {@link Properties} instances as well as access to the global configuration
+ * system. Properties by default are loaded from the system properties, system environment, and a classpath resource
+ * file named {@value #LOG4J_PROPERTIES_FILE_NAME}. Additional properties can be loaded by implementing a custom
+ * {@link PropertySource} service and specifying it via a {@link ServiceLoader} file called
+ * {@code META-INF/services/org.apache.logging.log4j.util.PropertySource} with a list of fully qualified class names
+ * implementing that interface.
* </p>
+ * @see PropertySource
*/
public final class PropertiesUtil {
- private static final PropertiesUtil LOG4J_PROPERTIES = new PropertiesUtil("log4j2.component.properties");
+ private static final String LOG4J_PROPERTIES_FILE_NAME = "log4j2.component.properties";
+ private static final PropertiesUtil LOG4J_PROPERTIES = new PropertiesUtil(LOG4J_PROPERTIES_FILE_NAME);
private final Environment environment;