Merge pull request #104 from benjchristensen/queue-javadoc

improve clarity of javadoc for HystrixCommand.queue()
Netflix · Feb 14, 2013 · 7a3f005 · 7a3f005
2 parents b4accad + 123598a
commit 7a3f005
Showing 1 changed file with 6 additions and 3 deletions.
diff --git a/hystrix-core/src/main/java/com/netflix/hystrix/HystrixCommand.java b/hystrix-core/src/main/java/com/netflix/hystrix/HystrixCommand.java
@@ -503,10 +503,13 @@ private R executeWithSemaphore() {
      * <p>
      * We don't throw an exception but just flip to synchronous execution so code doesn't need to change in order to switch a command from running on a separate thread to the calling thread.
      * 
-     * 
      * @return {@code Future<R>} Result of {@link #run()} execution or a fallback from {@link #getFallback()} if the command fails for any reason.
-     * @throws HystrixRuntimeException
-     *             via {@code Future.get()} in {@link ExecutionException#getCause()} if a failure occurs and a fallback cannot be retrieved
+     * @throws HystrixRuntimeException if a fallback does not exist
+     *              <p>
+     *              <ul>
+     *                  <li>via {@code Future.get()} in {@link ExecutionException#getCause()} if a failure occurs</li>
+     *                  <li>or immediately if the command can not be queued (such as short-circuited or thread-pool/semaphore rejected)</li>
+     *              </ul>
      * @throws HystrixBadRequestException
      *             via {@code Future.get()} in {@link ExecutionException#getCause()} if invalid arguments or state were used representing a user failure, not a system failure
      */