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.heos.internal.handler;
  14
  15 import java.io.IOException;
  16
  17 import org.eclipse.jdt.annotation.NonNullByDefault;
  18 import org.eclipse.jdt.annotation.Nullable;
  19 import org.openhab.binding.heos.internal.resources.Telnet.ReadException;
  20 import org.openhab.core.thing.ThingUID;
  21 import org.openhab.core.types.Command;
  22
  23 /**
  24  * The {@link HeosChannelHandler} handles the base class for the different
  25  * channel handler which handles the command from the channels of the things
  26  * to the HEOS system
  27  *
  28  * @author Johannes Einig - Initial contribution
  29  */
  30 @NonNullByDefault
  31 public interface HeosChannelHandler {
  32     /**
  33      * Handle a command received from a channel. Requires the class which
  34      * wants to handle the command to decide which subclass has to be used
  35      *
  36      * @param command the command to handle
  37      * @param id of the group or player
  38      * @param uid
  39      */
  40     void handlePlayerCommand(Command command, String id, ThingUID uid) throws IOException, ReadException;
  41
  42     void handleGroupCommand(Command command, @Nullable String id, ThingUID uid, HeosGroupHandler heosGroupHandler)
  43             throws IOException, ReadException;
  44
  45     /**
  46      * Handles a command for classes without an id. Used
  47      * for BridgeHandler
  48      *
  49      * @param command the command to handle
  50      * @param uid
  51      */
  52     void handleBridgeCommand(Command command, ThingUID uid) throws IOException, ReadException;
  53 }