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

Enum TargetSecuritySystemStateEnum

java.lang.Object

java.lang.Enum<TargetSecuritySystemStateEnum>

io.github.hapjava.characteristics.impl.securitysystem.TargetSecuritySystemStateEnum

All Implemented Interfaces:

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

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

The target state of a SecuritySystemAccessory.

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 ”Disarm” 4-255 ”Reserved”

Author:

Gaston Dombiak

Enum Constant Summary

Enum Constants

Enum Constant	Description
AWAY_ARM	Arm the system when the home is unoccupied.
DISARM	Disarm the system.
NIGHT_ARM	Arm the system when the home is occupied and residents are sleeping.
STAY_ARM	Arm the system when the home is occupied and residents are active.

Method Summary

Modifier and Type	Method	Description
static TargetSecuritySystemStateEnum	fromCode(java.lang.Integer code)
int	getCode()
static TargetSecuritySystemStateEnum	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static TargetSecuritySystemStateEnum[]	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 TargetSecuritySystemStateEnum STAY_ARM

Arm the system when the home is occupied and residents are active.

AWAY_ARM

public static final TargetSecuritySystemStateEnum AWAY_ARM

Arm the system when the home is unoccupied.

NIGHT_ARM

public static final TargetSecuritySystemStateEnum NIGHT_ARM

Arm the system when the home is occupied and residents are sleeping.

DISARM

public static final TargetSecuritySystemStateEnum DISARM

Disarm the system.

Method Detail

values

public static TargetSecuritySystemStateEnum[] 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 (TargetSecuritySystemStateEnum c : TargetSecuritySystemStateEnum.values())
    System.out.println(c);

Returns:

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

valueOf

public static TargetSecuritySystemStateEnum 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 TargetSecuritySystemStateEnum fromCode(java.lang.Integer code)

getCode

public int getCode()

Specified by:

getCode in interface CharacteristicEnum