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

   1 /**
   2  * Copyright (c) 2010-2022 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.velux.internal.handler.utils;
  14
  15 import java.util.Map;
  16
  17 import org.eclipse.jdt.annotation.NonNullByDefault;
  18 import org.openhab.core.thing.Bridge;
  19 import org.openhab.core.thing.ChannelUID;
  20 import org.openhab.core.thing.binding.BaseBridgeHandler;
  21
  22 /**
  23  * The {@link ExtendedBaseBridgeHandler} extended the {@link BaseBridgeHandler} interface and adds <B>publicly
  24  * visible</B> convenience methods for property handling.
  25  *
  26  * @author Guenther Schreiner - Initial contribution.
  27  */
  28 @NonNullByDefault
  29 public abstract class ExtendedBaseBridgeHandler extends BaseBridgeHandler {
  30
  31     /*
  32      * ************************
  33      * ***** Constructors *****
  34      */
  35
  36     /**
  37      * @see BaseBridgeHandler
  38      * @param bridge which will be created.
  39      */
  40     protected ExtendedBaseBridgeHandler(Bridge bridge) {
  41         super(bridge);
  42     }
  43
  44     /**
  45      * Returns a copy of the properties map, that can be modified. The method {@link #updateProperties} must be called
  46      * to persist the properties.
  47      *
  48      * @return copy of the thing properties (not null)
  49      */
  50     @Override
  51     public Map<String, String> editProperties() {
  52         return super.editProperties();
  53     }
  54
  55     /**
  56      * Informs the framework, that the given properties map of the thing was updated. This method performs a check, if
  57      * the properties were updated. If the properties did not change, the framework is not informed about changes.
  58      *
  59      * @param properties properties map, that was updated and should be persisted
  60      */
  61     @Override
  62     public void updateProperties(Map<String, String> properties) {
  63         super.updateProperties(properties);
  64     }
  65
  66     /**
  67      * Returns whether at least one item is linked for the given UID of the channel.
  68      *
  69      * @param channelUID UID of the channel (must not be null)
  70      * @return true if at least one item is linked, false otherwise
  71      */
  72     @Override
  73     public boolean isLinked(ChannelUID channelUID) {
  74         return super.isLinked(channelUID);
  75     }
  76 }