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

Enum SecuritySystemAlarmTypeEnum

java.lang.Object

java.lang.Enum<SecuritySystemAlarmTypeEnum>

io.github.hapjava.characteristics.impl.securitysystem.SecuritySystemAlarmTypeEnum

All Implemented Interfaces:

CharacteristicEnum, Serializable, Comparable<SecuritySystemAlarmTypeEnum>

public enum SecuritySystemAlarmTypeEnum
extends Enum<SecuritySystemAlarmTypeEnum>
implements CharacteristicEnum

Type of alarm of a SecuritySystemAccessory.

This characteristic describes the type of alarm triggered by a security system. A value of 1 indicates an ʼunknownʼ cause. Value should revert to 0 when the alarm conditions are cleared.

Author:

Gaston Dombiak

Enum Constant Summary

Enum Constants

Enum Constant	Description
NO_ALARM	Alarm conditions are cleared
UNKNOWN	Alarm type is not known

Method Summary

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

NO_ALARM

public static final SecuritySystemAlarmTypeEnum NO_ALARM

Alarm conditions are cleared

UNKNOWN

public static final SecuritySystemAlarmTypeEnum UNKNOWN

Alarm type is not known

Method Detail

values

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

Returns:

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

valueOf

public static SecuritySystemAlarmTypeEnum valueOf(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:

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

NullPointerException - if the argument is null

fromCode

public static SecuritySystemAlarmTypeEnum fromCode(Integer code)

getCode

public int getCode()

Specified by:

getCode in interface CharacteristicEnum