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

   1 /**
   2  * Copyright (c) 2010-2020 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;
  14
  15 import org.eclipse.jdt.annotation.NonNullByDefault;
  16 import org.eclipse.jdt.annotation.Nullable;
  17 import org.openhab.binding.neeo.internal.handler.NeeoRoomHandler;
  18
  19 /**
  20  * THe configuration class for the room used by {@link NeeoRoomHandler}
  21  *
  22  * @author Tim Roberts - initial contribution
  23  */
  24 @NonNullByDefault
  25 public class NeeoRoomConfig {
  26
  27     /** The NEEO room key */
  28     @Nullable
  29     private String roomKey;
  30
  31     /** The refresh polling (in seconds) */
  32     private int refreshPolling;
  33
  34     /** Whether to exclude things */
  35     private boolean excludeThings;
  36
  37     /**
  38      * Gets the room key
  39      *
  40      * @return the room key
  41      */
  42     @Nullable
  43     public String getRoomKey() {
  44         return roomKey;
  45     }
  46
  47     /**
  48      * Sets the room key.
  49      *
  50      * @param roomKey the new room key
  51      */
  52     public void setRoomKey(String roomKey) {
  53         this.roomKey = roomKey;
  54     }
  55
  56     /**
  57      * Gets the refresh polling (in seconds)
  58      *
  59      * @return the refresh polling
  60      */
  61     public int getRefreshPolling() {
  62         return refreshPolling;
  63     }
  64
  65     /**
  66      * Set's the refresh polling
  67      *
  68      * @param refreshPolling the refresh polling
  69      */
  70     public void setRefreshPolling(int refreshPolling) {
  71         this.refreshPolling = refreshPolling;
  72     }
  73
  74     /**
  75      * Whether to exclude things or not
  76      *
  77      * @return true to exclude, false otherwise
  78      */
  79     public boolean isExcludeThings() {
  80         return excludeThings;
  81     }
  82
  83     /**
  84      * Sets whether to exclude things
  85      *
  86      * @param excludeThings true to exclude, false otherwise
  87      */
  88     public void setExcludeThings(boolean excludeThings) {
  89         this.excludeThings = excludeThings;
  90     }
  91 }