git.basschouten.com Git - openhab-addons.git/blob

   1 /**
   2  * Copyright (c) 2010-2023 Contributors to the openHAB project
   3  *
   4  * See the NOTICE file(s) distributed with this work for additional
   5  * information.
   6  *
   7  * This program and the accompanying materials are made available under the
   8  * terms of the Eclipse Public License 2.0 which is available at
   9  * http://www.eclipse.org/legal/epl-2.0
  10  *
  11  * SPDX-License-Identifier: EPL-2.0
  12  */
  13 package org.openhab.binding.bticinosmarther.internal.api.exception;
  14
  15 import java.io.IOException;
  16
  17 import org.eclipse.jdt.annotation.NonNullByDefault;
  18 import org.eclipse.jdt.annotation.Nullable;
  19
  20 /**
  21  * Signals that a generic communication issue with API gateway has occurred.
  22  *
  23  * @author Fabio Possieri - Initial contribution
  24  */
  25 @NonNullByDefault
  26 public class SmartherGatewayException extends IOException {
  27
  28     private static final long serialVersionUID = -3614645621941830547L;
  29
  30     /**
  31      * Constructs a {@code SmartherGatewayException} with the specified detail message.
  32      *
  33      * @param message
  34      *            the error message returned from the API gateway
  35      */
  36     public SmartherGatewayException(@Nullable String message) {
  37         super(message);
  38     }
  39
  40     /**
  41      * Constructs a {@code SmartherGatewayException} with the specified detail message and cause.
  42      *
  43      * @param message
  44      *            the error message returned from the API gateway
  45      * @param cause
  46      *            the cause (a null value is permitted, and indicates that the cause is nonexistent or unknown)
  47      */
  48     public SmartherGatewayException(@Nullable String message, @Nullable Throwable cause) {
  49         super(message, cause);
  50     }
  51
  52     /**
  53      * Constructs a {@code SmartherGatewayException} with the specified cause and a detail message of
  54      * {@code (cause==null ? null : cause.toString())} (which typically contains the class and detail message of
  55      * {@code cause}).
  56      * This constructor is useful for API gateway exceptions that are little more than wrappers for other throwables.
  57      *
  58      * @param cause
  59      *            the cause (a null value is permitted, and indicates that the cause is nonexistent or unknown)
  60      */
  61     public SmartherGatewayException(@Nullable Throwable cause) {
  62         super(cause);
  63     }
  64 }