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/11 20:19:35 UTC
[logging-log4j2] 02/03: Javadoc.
This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch release-2.x
in repository https://gitbox.apache.org/repos/asf/logging-log4j2.git
commit ed38c6abcc0bbd08665f19eecf0d379effc86efa
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Tue Jan 11 15:04:35 2022 -0500
Javadoc.
---
.../main/java/org/apache/logging/log4j/core/util/Source.java | 12 ++++--------
1 file changed, 4 insertions(+), 8 deletions(-)
diff --git a/log4j-core/src/main/java/org/apache/logging/log4j/core/util/Source.java b/log4j-core/src/main/java/org/apache/logging/log4j/core/util/Source.java
index 7e5c786..870ee04 100644
--- a/log4j-core/src/main/java/org/apache/logging/log4j/core/util/Source.java
+++ b/log4j-core/src/main/java/org/apache/logging/log4j/core/util/Source.java
@@ -24,14 +24,10 @@ import java.util.Objects;
import org.apache.logging.log4j.core.config.ConfigurationSource;
/**
- * Represents the source for the logging configuration.
+ * Represents the source for the logging configuration as an immutable object.
*/
public class Source {
- /**
- * Captures a URI or File.
- */
-
private final File file;
private final URI uri;
private final String location;
@@ -70,7 +66,7 @@ public class Source {
}
/**
- * Returns the file configuration source, or {@code null} if this configuration source is based on an URL or has
+ * Gets the file configuration source, or {@code null} if this configuration source is based on an URL or has
* neither a file nor an URL.
*
* @return the configuration source file, or {@code null}
@@ -80,7 +76,7 @@ public class Source {
}
/**
- * Returns the configuration source URL, or {@code null} if this configuration source is based on a file or has
+ * Gets the configuration source URL, or {@code null} if this configuration source is based on a file or has
* neither a file nor an URL.
*
* @return the configuration source URL, or {@code null}
@@ -90,7 +86,7 @@ public class Source {
}
/**
- * Returns a string describing the configuration source file or URL, or {@code null} if this configuration source
+ * Gets a string describing the configuration source file or URL, or {@code null} if this configuration source
* has neither a file nor an URL.
*
* @return a string describing the configuration source file or URL, or {@code null}