opendaylight/md-sal/cds-access-api/src/main/java/org/opendaylight/controller/cluster/access/AbstractVersionException.java

   1 /*
   2  * Copyright (c) 2016 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 package org.opendaylight.controller.cluster.access;
   9
  10 import static java.util.Objects.requireNonNull;
  11
  12 import java.io.Serial;
  13 import org.eclipse.jdt.annotation.NonNull;
  14
  15 /**
  16  * Abstract base exception used for reporting version mismatches from {@link ABIVersion}.
  17  */
  18 public abstract class AbstractVersionException extends Exception {
  19     @Serial
  20     private static final long serialVersionUID = 1L;
  21
  22     private final @NonNull ABIVersion closestVersion;
  23     private final int version;
  24
  25     AbstractVersionException(final String message, final short version, final ABIVersion closestVersion) {
  26         super(message);
  27         this.closestVersion = requireNonNull(closestVersion);
  28         this.version = Short.toUnsignedInt(version);
  29     }
  30
  31     /**
  32      * Return the numeric version which has caused this exception.
  33      *
  34      * @return Numeric version
  35      */
  36     public final int version() {
  37         return version;
  38     }
  39
  40     /**
  41      * Return the closest version supported by this codebase.
  42      *
  43      * @return Closest supported {@link ABIVersion}
  44      */
  45     public final @NonNull ABIVersion closestVersion() {
  46         return closestVersion;
  47     }
  48 }