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.squeezebox.internal.dto;
  14
  15 import com.google.gson.annotations.SerializedName;
  16
  17 /**
  18  * The {@link ButtonDTO} represents a custom button that overrides existing
  19  * button functionality. For example, "like song" replaces the repeat button.
  20  *
  21  * @author Mark Hilbush - Initial contribution
  22  */
  23 public class ButtonDTO {
  24
  25     /**
  26      * Indicates whether button is standard or custom
  27      */
  28     public Boolean custom;
  29
  30     /**
  31      * Indicates if standard button is enabled or disabled
  32      */
  33     public Boolean enabled;
  34
  35     /**
  36      * Concatenation of elements of command array
  37      */
  38     public String command;
  39
  40     /**
  41      * Currently not used
  42      */
  43     @SerializedName("icon")
  44     public String icon;
  45
  46     /**
  47      * Currently not used
  48      */
  49     @SerializedName("jiveStyle")
  50     public String jiveStyle;
  51
  52     /**
  53      * Currently not used
  54      */
  55     @SerializedName("tooltip")
  56     public String toolTip;
  57
  58     public boolean isCustom() {
  59         return custom == null ? Boolean.FALSE : custom;
  60     }
  61
  62     public boolean isEnabled() {
  63         return enabled == null ? Boolean.FALSE : enabled;
  64     }
  65 }