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.boschshc.internal.services.privacymode;
  14
  15 import org.eclipse.jdt.annotation.NonNullByDefault;
  16 import org.openhab.core.library.types.OnOffType;
  17
  18 /**
  19  * Possible privacy mode states of security cameras.
  20  *
  21  * @author David Pace - Initial contribution
  22  *
  23  */
  24 @NonNullByDefault
  25 public enum PrivacyModeState {
  26
  27     /**
  28      * Privacy mode enabled / camera disabled
  29      */
  30     ENABLED,
  31
  32     /**
  33      * Privacy mode disabled / camera enabled
  34      */
  35     DISABLED;
  36
  37     /**
  38      * Converts an {@link OnOffType} state into a {@link PrivacyModeState}.
  39      *
  40      * @param onOff the on/off state
  41      * @return the corresponding privacy mode state
  42      */
  43     public static PrivacyModeState from(OnOffType onOff) {
  44         return onOff == OnOffType.ON ? ENABLED : DISABLED;
  45     }
  46
  47     /**
  48      * Converts this {@link PrivacyModeState} into an {@link OnOffType}.
  49      *
  50      * @return the on/off state corresponding to the privacy mode state of this enumeration literal
  51      */
  52     public OnOffType toOnOffType() {
  53         return this == ENABLED ? OnOffType.ON : OnOffType.OFF;
  54     }
  55 }