Package io.github.hapjava.characteristics.impl.securitysystem

Enum CurrentSecuritySystemStateEnum

java.lang.Object

java.lang.Enum<CurrentSecuritySystemStateEnum>

io.github.hapjava.characteristics.impl.securitysystem.CurrentSecuritySystemStateEnum

All Implemented Interfaces:

CharacteristicEnum, java.io.Serializable, java.lang.Comparable<CurrentSecuritySystemStateEnum>

public enum CurrentSecuritySystemStateEnum
extends java.lang.Enum<CurrentSecuritySystemStateEnum>
implements CharacteristicEnum

The current state of a SecuritySystemAccessory. Unlike TargetSecuritySystemStateEnum, this enum includes a triggered state. 0 ”Stay Arm. The home is occupied and the residents are active. e.g. morning or evenings” 1 ”Away Arm. The home is unoccupied” 2 ”Night Arm. The home is occupied and the residents are sleeping” 3 ”Disarmed” 4 ”Alarm Triggered” 5-255 ”Reserved”

Author:

Gaston Dombiak

Enum Constant Summary

Enum Constants

Enum Constant	Description
AWAY_ARM	The home is unoccupied.
DISARMED	The security system is disarmed.
NIGHT_ARM	The home is occupied and residents are sleeping.
STAY_ARM	The home is occupied and residents are active.
TRIGGERED	The security system is triggered.

Method Summary

Modifier and Type	Method	Description
static CurrentSecuritySystemStateEnum	fromCode(java.lang.Integer code)
int	getCode()
static CurrentSecuritySystemStateEnum	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static CurrentSecuritySystemStateEnum[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

STAY_ARM

public static final CurrentSecuritySystemStateEnum STAY_ARM

The home is occupied and residents are active.

AWAY_ARM

public static final CurrentSecuritySystemStateEnum AWAY_ARM

The home is unoccupied.

NIGHT_ARM

public static final CurrentSecuritySystemStateEnum NIGHT_ARM

The home is occupied and residents are sleeping.

DISARMED

public static final CurrentSecuritySystemStateEnum DISARMED

The security system is disarmed.

TRIGGERED

public static final CurrentSecuritySystemStateEnum TRIGGERED

The security system is triggered.

Method Detail

values

public static CurrentSecuritySystemStateEnum[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (CurrentSecuritySystemStateEnum c : CurrentSecuritySystemStateEnum.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static CurrentSecuritySystemStateEnum valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

fromCode

public static CurrentSecuritySystemStateEnum fromCode(java.lang.Integer code)

getCode

public int getCode()

Specified by:

getCode in interface CharacteristicEnum