Updated Branches: refs/heads/camel-2.12.x f5af0414a -> 93641d223 refs/heads/master 5de774cb1 -> a9ca68dc4
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/93641d22 Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/93641d22 Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/93641d22 Branch: refs/heads/camel-2.12.x Commit: 93641d223f18a50ac56663e2112ded159564f383 Parents: f5af041 Author: Claus Ibsen <[email protected]> Authored: Wed Nov 6 17:36:05 2013 +0100 Committer: Claus Ibsen <[email protected]> Committed: Wed Nov 6 17:37:44 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/93641d22/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
