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 2015/08/31 20:34:00 UTC
logging-log4j2 git commit: More generic Javadoc since this class is
now used by the configuration builder.
Repository: logging-log4j2
Updated Branches:
refs/heads/LOG4J2-952 051a98110 -> 222dc9e63
More generic Javadoc since this class is now used by the configuration
builder.
Project: http://git-wip-us.apache.org/repos/asf/logging-log4j2/repo
Commit: http://git-wip-us.apache.org/repos/asf/logging-log4j2/commit/222dc9e6
Tree: http://git-wip-us.apache.org/repos/asf/logging-log4j2/tree/222dc9e6
Diff: http://git-wip-us.apache.org/repos/asf/logging-log4j2/diff/222dc9e6
Branch: refs/heads/LOG4J2-952
Commit: 222dc9e631ea8f2cda3cc38c42611aa5ad04f915
Parents: 051a981
Author: ggregory <gg...@apache.org>
Authored: Mon Aug 31 11:33:57 2015 -0700
Committer: ggregory <gg...@apache.org>
Committed: Mon Aug 31 11:33:57 2015 -0700
----------------------------------------------------------------------
.../org/apache/logging/log4j/core/util/Builder.java | 14 +++++++-------
1 file changed, 7 insertions(+), 7 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/logging-log4j2/blob/222dc9e6/log4j-core/src/main/java/org/apache/logging/log4j/core/util/Builder.java
----------------------------------------------------------------------
diff --git a/log4j-core/src/main/java/org/apache/logging/log4j/core/util/Builder.java b/log4j-core/src/main/java/org/apache/logging/log4j/core/util/Builder.java
index b70993c..6958bef 100644
--- a/log4j-core/src/main/java/org/apache/logging/log4j/core/util/Builder.java
+++ b/log4j-core/src/main/java/org/apache/logging/log4j/core/util/Builder.java
@@ -18,27 +18,27 @@
package org.apache.logging.log4j.core.util;
/**
- * A type of Plugin builder that can be used to configure and create a plugin instance using a Java DSL instead of
+ * A type of builder that can be used to configure and create a instances using a Java DSL instead of
* through a configuration file. These builders are primarily useful for internal code and unit tests, but they can
* technically be used as a verbose alternative to configuration files.
*
* <p>
- * When creating plugin builders, it is customary to create the builder class as a public static inner class
+ * When creating <em>plugin</em> builders, it is customary to create the builder class as a public static inner class
* called {@code Builder}. For instance, the builder class for
* {@link org.apache.logging.log4j.core.layout.PatternLayout PatternLayout} would be
* {@code PatternLayout.Builder}.
* </p>
*
- * @param <T> the Plugin class this is a builder for.
+ * @param <T> This builder creates instances of this class.
*/
public interface Builder<T> {
/**
- * Builds the plugin object after all configuration has been set. This will use default values for any
- * unspecified attributes for the plugin.
+ * Builds the object after all configuration has been set. This will use default values for any
+ * unspecified attributes for the object.
*
- * @return the configured plugin instance.
- * @throws org.apache.logging.log4j.core.config.ConfigurationException if there was an error building the plugin
+ * @return the configured instance.
+ * @throws org.apache.logging.log4j.core.config.ConfigurationException if there was an error building the
* object.
*/
T build();