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 org.eclipse.jdt.annotation.NonNullByDefault;
  16
  17 /**
  18  * Signals that an "invalid property value" issue has occurred when deailng with enumerated type chronothermostat
  19  * properties.
  20  *
  21  * @author Fabio Possieri - Initial contribution
  22  */
  23 @NonNullByDefault
  24 public class SmartherIllegalPropertyValueException extends Exception {
  25
  26     private static final long serialVersionUID = -2549779559688846805L;
  27
  28     private static final String MSG_FORMAT = "'%s' = '%s'";
  29
  30     /**
  31      * Constructs a {@code SmartherIllegalPropertyValueException} with the specified detail message.
  32      *
  33      * @param message
  34      *            the error message returned from the API gateway
  35      */
  36     public SmartherIllegalPropertyValueException(String message) {
  37         super(message);
  38     }
  39
  40     /**
  41      * Constructs a {@code SmartherIllegalPropertyValueException} with the specified property name and invalid value
  42      * returned by the API gateway.
  43      *
  44      * @param propertyName
  45      *            the property name that caused the issue
  46      * @param invalidValue
  47      *            the invalid value returned by the API gateway for {@code PropertyName}
  48      */
  49     public SmartherIllegalPropertyValueException(String propertyName, String invalidValue) {
  50         super(String.format(MSG_FORMAT, propertyName, invalidValue));
  51     }
  52 }