opendaylight/md-sal/sal-common-api/src/main/java/org/opendaylight/controller/md/sal/common/api/clustering/CandidateAlreadyRegisteredException.java

   1 /*
   2  * Copyright (c) 2015 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8
   9 package org.opendaylight.controller.md.sal.common.api.clustering;
  10
  11 import com.google.common.base.Preconditions;
  12 import javax.annotation.Nonnull;
  13
  14 /**
  15  * Thrown when a Candidate has already been registered for a given Entity. This could be due to a component doing a
  16  * duplicate registration or two different components within the same process trying to register a Candidate.
  17  */
  18 public class CandidateAlreadyRegisteredException extends Exception {
  19     private static final long serialVersionUID = 1L;
  20
  21     private final Entity entity;
  22
  23     public CandidateAlreadyRegisteredException(@Nonnull Entity entity) {
  24         super(String.format("Candidate has already been registered for %s",
  25                 Preconditions.checkNotNull(entity, "entity should not be null")));
  26         this.entity = entity;
  27     }
  28
  29     /**
  30      *
  31      * @return the entity for which a Candidate has already been registered in the current process
  32      */
  33     @Nonnull
  34     public Entity getEntity() {
  35         return entity;
  36     }
  37 }