camel-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From davscl...@apache.org
Subject git commit: Fixed outdated javadoc on shutdown strategy.
Date Wed, 06 Nov 2013 16:36:14 GMT
Updated Branches:
  refs/heads/camel-2.11.x 618e08e70 -> 9a4e456fc


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/9a4e456f
Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/9a4e456f
Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/9a4e456f

Branch: refs/heads/camel-2.11.x
Commit: 9a4e456fcf4197e40263960ff417ee7b6166cc31
Parents: 618e08e
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:37:15 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/9a4e456f/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 b605b28..eceb870 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
@@ -108,11 +108,12 @@ public interface ShutdownStrategy extends Service {
     /**
      * 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);
@@ -120,8 +121,6 @@ public interface ShutdownStrategy extends Service {
     /**
      * 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