You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@logging.apache.org by rg...@apache.org on 2015/09/08 02:41:08 UTC

[25/50] logging-log4j2 git commit: More precise Javadoc.

More precise Javadoc.

Project: http://git-wip-us.apache.org/repos/asf/logging-log4j2/repo
Commit: http://git-wip-us.apache.org/repos/asf/logging-log4j2/commit/0a56f89a
Tree: http://git-wip-us.apache.org/repos/asf/logging-log4j2/tree/0a56f89a
Diff: http://git-wip-us.apache.org/repos/asf/logging-log4j2/diff/0a56f89a

Branch: refs/heads/master
Commit: 0a56f89a9083dfafa0ba7ba077eca02a4d3d7965
Parents: 6137242
Author: ggregory <gg...@apache.org>
Authored: Tue Sep 1 09:25:01 2015 -0700
Committer: ggregory <gg...@apache.org>
Committed: Tue Sep 1 09:25:01 2015 -0700

----------------------------------------------------------------------
 .../builder/api/ConfigurationBuilder.java       | 32 ++++++++++----------
 1 file changed, 16 insertions(+), 16 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/logging-log4j2/blob/0a56f89a/log4j-core/src/main/java/org/apache/logging/log4j/core/config/builder/api/ConfigurationBuilder.java
----------------------------------------------------------------------
diff --git a/log4j-core/src/main/java/org/apache/logging/log4j/core/config/builder/api/ConfigurationBuilder.java b/log4j-core/src/main/java/org/apache/logging/log4j/core/config/builder/api/ConfigurationBuilder.java
index 74e9bb6..de1b4cc 100644
--- a/log4j-core/src/main/java/org/apache/logging/log4j/core/config/builder/api/ConfigurationBuilder.java
+++ b/log4j-core/src/main/java/org/apache/logging/log4j/core/config/builder/api/ConfigurationBuilder.java
@@ -74,14 +74,14 @@ public interface ConfigurationBuilder<T extends Configuration> extends Builder<T
      * Returns a builder for creating Appenders.
      * @param name The name of the Appender.
      * @param pluginName The Plugin type of the Appender.
-     * @return the AppenderComponentBuilder.
+     * @return A new AppenderComponentBuilder.
      */
     AppenderComponentBuilder newAppender(String name, String pluginName);
 
     /**
      * Returns a builder for creating AppenderRefs.
      * @param ref The name of the Appender being referenced.
-     * @return the AppenderRefComponentBuilder.
+     * @return A new AppenderRefComponentBuilder.
      */
     AppenderRefComponentBuilder newAppenderRef(String ref);
 
@@ -89,7 +89,7 @@ public interface ConfigurationBuilder<T extends Configuration> extends Builder<T
      * Returns a builder for creating Async Loggers.
      * @param name The name of the Logger.
      * @param level The logging Level to be assigned to the Logger.
-     * @return The LoggerComponentBuilder.
+     * @return A new LoggerComponentBuilder.
      */
     LoggerComponentBuilder newAsyncLogger(String name, Level level);
 
@@ -97,21 +97,21 @@ public interface ConfigurationBuilder<T extends Configuration> extends Builder<T
      * Returns a builder for creating Async Loggers.
      * @param name The name of the Logger.
      * @param level The logging Level to be assigned to the Logger.
-     * @return The LoggerComponentBuilder.
+     * @return A new LoggerComponentBuilder.
      */
     LoggerComponentBuilder newAsyncLogger(String name, String level);
 
     /**
      * Returns a builder for creating the async root Logger.
      * @param level The logging Level to be assigned to the root Logger.
-     * @return The RootLoggerComponentBuilder.
+     * @return A new RootLoggerComponentBuilder.
      */
     RootLoggerComponentBuilder newAsyncRootLogger(Level level);
 
     /**
      * Returns a builder for creating the async root Logger.
      * @param level The logging Level to be assigned to the root Logger.
-     * @return The RootLoggerComponentBuilder.
+     * @return A new RootLoggerComponentBuilder.
      */
     RootLoggerComponentBuilder newAsyncRootLogger(String level);
 
@@ -119,7 +119,7 @@ public interface ConfigurationBuilder<T extends Configuration> extends Builder<T
      * Returns a builder for creating generic components.
      * @param name The name of the component (may be null).
      * @param pluginName The Plugin type of the component.
-     * @return The ComponentBuilder.
+     * @return A new ComponentBuilder.
      */
     <B extends ComponentBuilder<B>> ComponentBuilder<B> newComponent(String name, String pluginName);
 
@@ -128,7 +128,7 @@ public interface ConfigurationBuilder<T extends Configuration> extends Builder<T
      * @param name The name of the component (may be null).
      * @param pluginName The Plugin type of the component.
      * @param value The value of the component.
-     * @return The ComponentBuilder.
+     * @return A new ComponentBuilder.
      */
     <B extends ComponentBuilder<B>> ComponentBuilder<B> newComponent(String name, String pluginName, String value);
 
@@ -137,7 +137,7 @@ public interface ConfigurationBuilder<T extends Configuration> extends Builder<T
      * Returns a builder for creating CustomLevels
      * @param name The name of the custom level.
      * @param level The integer value to be assigned to the level.
-     * @return The CustomLevelComponentBuilder.
+     * @return A new CustomLevelComponentBuilder.
      */
     CustomLevelComponentBuilder newCustomLevel(String name, int level);
 
@@ -146,7 +146,7 @@ public interface ConfigurationBuilder<T extends Configuration> extends Builder<T
      * @param pluginName The Plugin type of the Filter.
      * @param onMatch "ACCEPT", "DENY", or "NEUTRAL"
      * @param onMisMatch "ACCEPT", "DENY", or "NEUTRAL"
-     * @return The FilterComponentBuilder.
+     * @return A new FilterComponentBuilder.
      */
     FilterComponentBuilder newFilter(String pluginName, Filter.Result onMatch, Filter.Result onMisMatch);
 
@@ -155,14 +155,14 @@ public interface ConfigurationBuilder<T extends Configuration> extends Builder<T
      * @param pluginName The Plugin type of the Filter.
      * @param onMatch "ACCEPT", "DENY", or "NEUTRAL"
      * @param onMisMatch "ACCEPT", "DENY", or "NEUTRAL"
-     * @return The FilterComponentBuilder.
+     * @return A new FilterComponentBuilder.
      */
     FilterComponentBuilder newFilter(String pluginName, String onMatch, String onMisMatch);
 
     /**
      * Returns a builder for creating Layouts.
      * @param type The Plugin type of the Layout.
-     * @return The LayoutComponentBuilder.
+     * @return A new LayoutComponentBuilder.
      */
     LayoutComponentBuilder newLayout(String pluginName);
 
@@ -170,7 +170,7 @@ public interface ConfigurationBuilder<T extends Configuration> extends Builder<T
      * Returns a builder for creating Loggers.
      * @param name The name of the Logger.
      * @param level The logging Level to be assigned to the Logger.
-     * @return The LoggerComponentBuilder.
+     * @return A new LoggerComponentBuilder.
      */
     LoggerComponentBuilder newLogger(String name, Level level);
 
@@ -178,21 +178,21 @@ public interface ConfigurationBuilder<T extends Configuration> extends Builder<T
      * Returns a builder for creating Loggers.
      * @param name The name of the Logger.
      * @param level The logging Level to be assigned to the Logger.
-     * @return The LoggerComponentBuilder.
+     * @return A new LoggerComponentBuilder.
      */
     LoggerComponentBuilder newLogger(String name, String level);
 
     /**
      * Returns a builder for creating the root Logger.
      * @param level The logging Level to be assigned to the root Logger.
-     * @return The RootLoggerComponentBuilder.
+     * @return A new RootLoggerComponentBuilder.
      */
     RootLoggerComponentBuilder newRootLogger(Level level);
 
     /**
      * Returns a builder for creating the root Logger.
      * @param level The logging Level to be assigned to the root Logger.
-     * @return The RootLoggerComponentBuilder.
+     * @return A new RootLoggerComponentBuilder.
      */
     RootLoggerComponentBuilder newRootLogger(String level);