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.neeo.internal.models;
  14
  15 import org.eclipse.jdt.annotation.NonNullByDefault;
  16 import org.eclipse.jdt.annotation.Nullable;
  17
  18 /**
  19  * The model representing a Neeo Macro (serialize/deserialize json use only)
  20  *
  21  * @author Tim Roberts - Initial contribution
  22  */
  23 @NonNullByDefault
  24 public class NeeoMacro {
  25
  26     /** The macro key */
  27     @Nullable
  28     private String key;
  29
  30     /** The component type */
  31     @Nullable
  32     private String componentType;
  33
  34     /** The macro name */
  35     @Nullable
  36     private String name;
  37
  38     /** The macro label */
  39     @Nullable
  40     private String label;
  41
  42     /** The associated device name */
  43     @Nullable
  44     private String deviceName;
  45
  46     /** The associated room name */
  47     @Nullable
  48     private String roomName;
  49
  50     /**
  51      * Gets the macro key
  52      *
  53      * @return the key
  54      */
  55     @Nullable
  56     public String getKey() {
  57         return key;
  58     }
  59
  60     /**
  61      * Gets the component type
  62      *
  63      * @return the component type
  64      */
  65     @Nullable
  66     public String getComponentType() {
  67         return componentType;
  68     }
  69
  70     /**
  71      * Gets the macro name
  72      *
  73      * @return the name
  74      */
  75     @Nullable
  76     public String getName() {
  77         return name;
  78     }
  79
  80     /**
  81      * Gets the macro label
  82      *
  83      * @return the label
  84      */
  85     @Nullable
  86     public String getLabel() {
  87         return label;
  88     }
  89
  90     /**
  91      * Gets the associated device name
  92      *
  93      * @return the device name
  94      */
  95     @Nullable
  96     public String getDeviceName() {
  97         return deviceName;
  98     }
  99
 100     /**
 101      * Gets the associated room name
 102      *
 103      * @return the room name
 104      */
 105     @Nullable
 106     public String getRoomName() {
 107         return roomName;
 108     }
 109
 110     @Override
 111     public String toString() {
 112         return "NeeoMacro [key=" + key + ", componentType=" + componentType + ", name=" + name + ", label=" + label
 113                 + ", deviceName=" + deviceName + ", roomName=" + roomName + "]";
 114     }
 115 }