Added to the Javadoc

git-svn-id: https://svn.apache.org/repos/asf/incubator/qpid/trunk@542476 13f79535-47bb-0310-9956-ffa450edef68

1 files changed, 8 insertions, 4 deletions

diff --git a/qpid/java/client/src/main/java/org/apache/qpid/client/failover/FailoverException.java b/qpid/java/client/src/main/java/org/apache/qpid/client/failover/FailoverException.java
index 49377fdc19..95899d533a 100644
--- a/qpid/java/client/src/main/java/org/apache/qpid/client/failover/FailoverException.java
+++ b/qpid/java/client/src/main/java/org/apache/qpid/client/failover/FailoverException.java
@@ -7,9 +7,9 @@
  * to you under the Apache License, Version 2.0 (the
  * "License"); you may not use this file except in compliance
  * with the License.  You may obtain a copy of the License at
- * 
+ *
  *   http://www.apache.org/licenses/LICENSE-2.0
- * 
+ *
  * Unless required by applicable law or agreed to in writing,
  * software distributed under the License is distributed on an
  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
@@ -21,8 +21,12 @@
 package org.apache.qpid.client.failover;
 
 /**
- * This exception is thrown when failover is taking place and we need to let other
- * parts of the client know about this.
+ * This exception is thrown when failover is taking place and otherparts of the client need to know about this.
+ *
+ * @todo This exception is created and passed as an argument to a method, rather than thrown. The exception is being
+ *       used to represent a signal, passed out to other threads. Use of exceptions as arguments rather than as
+ *       exceptions is extremly confusing. Eliminate. Use a Condition or set a flag and check it instead. Also
+ *       FailoverException is Runtime but handled and should only use Runtimes for non-handleable conditions.
  */
 public class FailoverException extends RuntimeException
 {