LOG4J2-1623 Fix 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/6482da5b Tree: http://git-wip-us.apache.org/repos/asf/logging-log4j2/tree/6482da5b Diff: http://git-wip-us.apache.org/repos/asf/logging-log4j2/diff/6482da5b Branch: refs/heads/master Commit: 6482da5b325a8d42bc79ade754a1d5b904c6dcea Parents: 3064471 Author: Mikael Ståldal <mikael.stal...@magine.com> Authored: Thu Oct 6 13:42:17 2016 +0200 Committer: Mikael Ståldal <mikael.stal...@magine.com> Committed: Thu Oct 6 13:42:17 2016 +0200 ---------------------------------------------------------------------- .../log4j/core/config/builder/api/ConfigurationBuilder.java | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/logging-log4j2/blob/6482da5b/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 b115651..8141c25 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 @@ -369,9 +369,14 @@ public interface ConfigurationBuilder<T extends Configuration> extends Builder<T ConfigurationBuilder<T> setShutdownHook(String flag); /** - * Specifies how long time appenders and other plugins will get to shutdown when the JVM shuts down. - * Default is zero. (Not used if {@link #setShutdownHook(String)} is set to "disable".) + * How long appenders and background tasks will get to shutdown when the JVM shuts down. + * Default is zero which mean that each appender uses its default timeout, and don't wait for background + * tasks. Not all appenders will honor this, it is a hint and not an absolute guarantee that the shutdown + * procedure will not take longer. Setting this too low increase the risk of losing outstanding log events + * not yet written to the final destination. (Not used if {@link #setShutdownHook(String)} is set to "disable".) * @return this builder instance. + * + * @see LoggerContext#stop(long, TimeUnit) */ ConfigurationBuilder<T> setShutdownTimeout(long timeout, TimeUnit timeUnit);
