Deprecate legacy EOS API classes
[controller.git] / opendaylight / md-sal / sal-common-api / src / main / java / org / opendaylight / controller / md / sal / common / api / clustering / CandidateAlreadyRegisteredException.java
index 976688946fa65b34e566ad51022a52b91b313bbb..67286e3d48e5560b0e1fbedd218e4a18768307a0 100644 (file)
@@ -14,7 +14,10 @@ import javax.annotation.Nonnull;
 /**
  * Thrown when a Candidate has already been registered for a given Entity. This could be due to a component doing a
  * duplicate registration or two different components within the same process trying to register a Candidate.
+ *
+ * @deprecated Use org.opendaylight.mdsal.common.api.clustering.CandidateAlreadyRegisteredException instead
  */
+@Deprecated
 public class CandidateAlreadyRegisteredException extends Exception {
     private static final long serialVersionUID = 1L;
 
@@ -27,6 +30,7 @@ public class CandidateAlreadyRegisteredException extends Exception {
     }
 
     /**
+     * Returns the entity for which a Candidate has already been registered in the current process.
      *
      * @return the entity for which a Candidate has already been registered in the current process
      */