camel-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From davscl...@apache.org
Subject [2/2] git commit: Fixed outdated javadoc on shutdown strategy.
Date Wed, 06 Nov 2013 16:36:54 GMT
Fixed outdated javadoc on shutdown strategy.


Project: http://git-wip-us.apache.org/repos/asf/camel/repo
Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/a9ca68dc
Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/a9ca68dc
Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/a9ca68dc

Branch: refs/heads/master
Commit: a9ca68dc4a43b7785d2b88db15204e48b9c349da
Parents: 5de774c
Author: Claus Ibsen <davsclaus@apache.org>
Authored: Wed Nov 6 17:36:05 2013 +0100
Committer: Claus Ibsen <davsclaus@apache.org>
Committed: Wed Nov 6 17:38:02 2013 +0100

----------------------------------------------------------------------
 .../src/main/java/org/apache/camel/spi/ShutdownStrategy.java  | 7 +++----
 1 file changed, 3 insertions(+), 4 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/camel/blob/a9ca68dc/camel-core/src/main/java/org/apache/camel/spi/ShutdownStrategy.java
----------------------------------------------------------------------
diff --git a/camel-core/src/main/java/org/apache/camel/spi/ShutdownStrategy.java b/camel-core/src/main/java/org/apache/camel/spi/ShutdownStrategy.java
index b9a9187..079f108 100644
--- a/camel-core/src/main/java/org/apache/camel/spi/ShutdownStrategy.java
+++ b/camel-core/src/main/java/org/apache/camel/spi/ShutdownStrategy.java
@@ -109,11 +109,12 @@ public interface ShutdownStrategy extends StaticService {
     /**
      * Set an timeout to wait for the shutdown to complete.
      * <p/>
-     * Setting a value of 0 or negative will disable timeout and wait until complete
-     * (potential blocking forever)
+     * You must set a positive value. If you want to wait (forever) then use
+     * a very high value such as {@link Long#MAX_VALUE}
      * <p/>
      * The default timeout unit is <tt>SECONDS</tt>
      *
+     * @throws IllegalArgumentException if the timeout value is 0 or negative
      * @param timeout timeout
      */
     void setTimeout(long timeout);
@@ -121,8 +122,6 @@ public interface ShutdownStrategy extends StaticService {
     /**
      * Gets the timeout.
      * <p/>
-     * Use positive value to set the timeout
-     * <p/>
      * The default timeout unit is <tt>SECONDS</tt>
      *
      * @return the timeout


Mime
View raw message