OSGi 8.1.0 · org.osgi.service.dal.functions.data.AlarmData

Field Summary

Modifier and Type	Field and Description
public static final String	FIELD_SEVERITY Represents the severity field name.
public static final String	FIELD_TYPE Represents the type field name.
private final int	severity
public static final int	SEVERITY_CRITICAL The severity rating indicates that there a critical alarm.
public static final int	SEVERITY_MAJOR The severity rating indicates that there is a major alarm.
public static final int	SEVERITY_MINOR The severity rating indicates that there is a minor alarm.
public static final int	SEVERITY_UNDEFINED The severity constant indicates that there is no severity rating for this alarm.
private final int	type
public static final int	TYPE_ACCESS_CONTROL The alarm type indicates that there is access control issue.
public static final int	TYPE_BURGLAR The alarm type indicates that there is a burglar notification.
public static final int	TYPE_COLD The alarm type indicates that temperature is too low.
public static final int	TYPE_GAS_CO The alarm type indicates that carbon monoxide (CO) is detected.
public static final int	TYPE_GAS_CO2 The alarm type indicates that carbon dioxide (CO2) is detected.
public static final int	TYPE_HARDWARE_FAIL The alarm type indicates that there is hardware failure.
public static final int	TYPE_HEAT The alarm type indicates that temperature is too high.
public static final int	TYPE_POWER_FAIL The alarm type indicates a power cut.
public static final int	TYPE_SMOKE The alarm type indicates that smoke is detected.
public static final int	TYPE_SOFTWARE_FAIL The alarm type indicates that there is software failure.
public static final int	TYPE_TAMPER The alarm type for a tamper indication.
public static final int	TYPE_UNDEFINED The alarm type indicates that the type is not specified.
public static final int	TYPE_WATER The alarm type indicates that a water leak is detected.

Inherited from org.osgi.service.dal.FunctionData:: DESCRIPTION FIELD_METADATA FIELD_TIMESTAMP

Constructor Summary

Access	Constructor and Description
public	AlarmData(Map<String, ?> Contains the new `AlarmData` instance field values. fields) Constructs new `AlarmData` instance with the specified field values.
public	AlarmData(long The alarm data timestamp optional field. timestamp, Map<String, ?> The alarm data metadata optional field. metadata, int The alarm data severity optional field. severity, int The alarm data type optional field. type) Constructs new `AlarmData` instance with the specified arguments.

Method Summary

Modifier and Type	Method and Description
public int	Returns: `-1`, `0` or `1` depending on the comparison rules. compareTo(Object `AlarmData` to be compared. o) Overrides org.osgi.service.dal.FunctionData.compareTo. Implements java.lang.Comparable.compareTo. Compares this `AlarmData` instance with the given argument.
public boolean	Returns: `true` if this object is equivalent to the specified one. equals(Object The object to compare this data. o) Overrides org.osgi.service.dal.FunctionData.equals. Two `AlarmData` instances are equal if they contain equal metadata, timestamp, type and severity.
public int	Returns: The alarm severity. getSeverity() Returns the alarm severity.
private String	getSeverityAsString()
public int	Returns: The alarm type. getType() Returns the alarm type.
public int	Returns: The hash code of this `AlarmData` object. hashCode() Overrides org.osgi.service.dal.FunctionData.hashCode. Returns the hash code for this `AlarmData` object.
public String	Returns: The string representation of this alarm data. toString() Overrides java.lang.Object.toString. Returns the string representation of this alarm data.
private void	validate()

Inherited from org.osgi.service.dal.FunctionData:: getMetadata getTimestamp

Field Detail

FIELD_SEVERITY	back to summary
public static final String FIELD_SEVERITY Represents the severity field name. The field value is available with `getSeverity()`. The field type is `int`. The constant can be used as a key to `AlarmData(Map)` .

FIELD_TYPE	back to summary
public static final String FIELD_TYPE Represents the type field name. The field value is available with `getType()`. The field type is `int`. The constant can be used as a key to `AlarmData(Map)`.

severity	back to summary
private final int severity

SEVERITY_CRITICAL	back to summary
public static final int SEVERITY_CRITICAL The severity rating indicates that there a critical alarm. The severity priority is higher than `SEVERITY_MINOR` and `SEVERITY_MAJOR`.

SEVERITY_MAJOR	back to summary
public static final int SEVERITY_MAJOR The severity rating indicates that there is a major alarm. The severity priority is higher than `SEVERITY_MINOR` and lower than `SEVERITY_CRITICAL`.

SEVERITY_MINOR	back to summary
public static final int SEVERITY_MINOR The severity rating indicates that there is a minor alarm. The severity priority is lower than `SEVERITY_MAJOR` and `SEVERITY_CRITICAL`.

SEVERITY_UNDEFINED	back to summary
public static final int SEVERITY_UNDEFINED The severity constant indicates that there is no severity rating for this alarm.

type	back to summary
private final int type

TYPE_ACCESS_CONTROL	back to summary
public static final int TYPE_ACCESS_CONTROL The alarm type indicates that there is access control issue. For example, the alarm can indicate that the door is unlocked.

TYPE_BURGLAR	back to summary
public static final int TYPE_BURGLAR The alarm type indicates that there is a burglar notification. For example, the alarm can indicate that the glass is broken.

TYPE_COLD	back to summary
public static final int TYPE_COLD The alarm type indicates that temperature is too low.

TYPE_GAS_CO	back to summary
public static final int TYPE_GAS_CO The alarm type indicates that carbon monoxide (CO) is detected.

TYPE_GAS_CO2	back to summary
public static final int TYPE_GAS_CO2 The alarm type indicates that carbon dioxide (CO2) is detected.

TYPE_HARDWARE_FAIL	back to summary
public static final int TYPE_HARDWARE_FAIL The alarm type indicates that there is hardware failure.

TYPE_HEAT	back to summary
public static final int TYPE_HEAT The alarm type indicates that temperature is too high.

TYPE_POWER_FAIL	back to summary
public static final int TYPE_POWER_FAIL The alarm type indicates a power cut.

TYPE_SMOKE	back to summary
public static final int TYPE_SMOKE The alarm type indicates that smoke is detected.

TYPE_SOFTWARE_FAIL	back to summary
public static final int TYPE_SOFTWARE_FAIL The alarm type indicates that there is software failure.

TYPE_TAMPER	back to summary
public static final int TYPE_TAMPER The alarm type for a tamper indication.

TYPE_UNDEFINED	back to summary
public static final int TYPE_UNDEFINED The alarm type indicates that the type is not specified.

TYPE_WATER	back to summary
public static final int TYPE_WATER The alarm type indicates that a water leak is detected.

Constructor Detail

AlarmData back to summary

AlarmData	back to summary
public AlarmData(Map<String, ?> fields) Constructs new `AlarmData` instance with the specified field values. The map keys must match to the field names. The map values will be assigned to the appropriate class fields. For example, the maps can be: {"severity"=Integer(1)...}. That map will initialize the `FIELD_SEVERITY` field with 1. If severity is missing, `SEVERITY_UNDEFINED` is used. `FIELD_SEVERITY` - optional field. The value type must be `Integer`. `FIELD_TYPE` - optional field. The value type must be `Integer`. Parameters fields:Map<String, ?> Contains the new `AlarmData` instance field values. Exceptions ClassCastException: If the field value types are not expected. IllegalArgumentException: If the alarm severity is invalid. NullPointerException: If the fields map is `null`.

public AlarmData(Map<String, ?> fields)

Constructs new AlarmData instance with the specified field values. The map keys must match to the field names. The map values will be assigned to the appropriate class fields. For example, the maps can be: {"severity"=Integer(1)...}. That map will initialize the FIELD_SEVERITY field with 1. If severity is missing, SEVERITY_UNDEFINED is used.

FIELD_SEVERITY - optional field. The value type must be Integer.
FIELD_TYPE - optional field. The value type must be Integer.

Parameters

fields:Map<String, ?>: Contains the new AlarmData instance field values.

Exceptions

ClassCastException:: If the field value types are not expected.
IllegalArgumentException:: If the alarm severity is invalid.
NullPointerException:: If the fields map is null.

AlarmData back to summary

AlarmData	back to summary
public AlarmData(long timestamp, Map<String, ?> metadata, int severity, int type) Constructs new `AlarmData` instance with the specified arguments. Parameters timestamp:long The alarm data timestamp optional field. metadata:Map<String, ?> The alarm data metadata optional field. severity:int The alarm data severity optional field. type:int The alarm data type optional field. Exceptions IllegalArgumentException: If the alarm severity is invalid.

public AlarmData(long timestamp, Map<String, ?> metadata, int severity, int type)

Constructs new AlarmData instance with the specified arguments.

Parameters

timestamp:long: The alarm data timestamp optional field.
metadata:Map<String, ?>: The alarm data metadata optional field.
severity:int: The alarm data severity optional field.
type:int: The alarm data type optional field.

Exceptions

IllegalArgumentException:: If the alarm severity is invalid.

Method Detail

compareTo back to summary

compareTo	back to summary
public int compareTo(Object o) Overrides org.osgi.service.dal.FunctionData.compareTo. Implements java.lang.Comparable.compareTo. Compares this `AlarmData` instance with the given argument. If the argument is not `AlarmData`, it throws `ClassCastException`. Otherwise, this method returns: `-1` if this instance field is less than a field of the specified argument. `0` if all fields are equivalent. `1` if this instance field is greater than a field of the specified argument. The fields are compared in this order: timestamp, metadata, type, severity. Parameters o:Object `AlarmData` to be compared. Returns:int `-1`, `0` or `1` depending on the comparison rules. Annotations @Override Exceptions ClassCastException: If the method argument is not of type `AlarmData`. See Also `java.lang.Comparable#compareTo(java.lang.Object)`

public int compareTo(Object o)

Overrides org.osgi.service.dal.FunctionData.compareTo.

Implements java.lang.Comparable.compareTo.

Compares this AlarmData instance with the given argument. If the argument is not AlarmData, it throws ClassCastException. Otherwise, this method returns:

-1 if this instance field is less than a field of the specified argument.
0 if all fields are equivalent.
1 if this instance field is greater than a field of the specified argument.

The fields are compared in this order: timestamp, metadata, type, severity.

Parameters

o:Object: AlarmData to be compared.

Returns:int

-1, 0 or 1 depending on the comparison rules.

Annotations

@Override

Exceptions

ClassCastException:: If the method argument is not of type AlarmData.

equals back to summary

equals	back to summary
public boolean equals(Object o) Overrides org.osgi.service.dal.FunctionData.equals. Two `AlarmData` instances are equal if they contain equal metadata, timestamp, type and severity. Parameters o:Object The object to compare this data. Returns:boolean `true` if this object is equivalent to the specified one. Annotations @Override See Also `org.osgi.service.dal.FunctionData#equals(java.lang.Object)`

public boolean equals(Object o)

Overrides org.osgi.service.dal.FunctionData.equals.

Two AlarmData instances are equal if they contain equal metadata, timestamp, type and severity.

Parameters

o:Object: The object to compare this data.

Returns:boolean

true if this object is equivalent to the specified one.

Annotations

@Override

getSeverity back to summary

getSeverity	back to summary
public int getSeverity() Returns the alarm severity. The severity can be one of: `SEVERITY_UNDEFINED` `SEVERITY_MINOR` `SEVERITY_MAJOR` `SEVERITY_CRITICAL` Returns:int The alarm severity.

public int getSeverity()

Returns the alarm severity. The severity can be one of:

Returns:int: The alarm severity.

getSeverityAsString	back to summary
private String getSeverityAsString()

getType back to summary

getType	back to summary
public int getType() Returns the alarm type. The type can be one of the predefined: `TYPE_UNDEFINED` `TYPE_SMOKE` `TYPE_HEAT` `TYPE_COLD` `TYPE_GAS_CO` `TYPE_GAS_CO2` `TYPE_WATER` `TYPE_POWER_FAIL` `TYPE_HARDWARE_FAIL` `TYPE_SOFTWARE_FAIL` vendor specific Zero and positive values are reserved for this definition and further extensions of the alarm types. Custom types can be used only as negative values to prevent potential collisions. Returns:int The alarm type.

public int getType()

Returns the alarm type. The type can be one of the predefined:

Zero and positive values are reserved for this definition and further extensions of the alarm types. Custom types can be used only as negative values to prevent potential collisions.

Returns:int: The alarm type.

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides org.osgi.service.dal.FunctionData.hashCode. Returns the hash code for this `AlarmData` object. The hash code is a sum of `FunctionData#hashCode()`, the alarm severity and the alarm type. Returns:int The hash code of this `AlarmData` object. Annotations @Override See Also `org.osgi.service.dal.FunctionData#hashCode()`

public int hashCode()

Overrides org.osgi.service.dal.FunctionData.hashCode.

Returns the hash code for this AlarmData object. The hash code is a sum of FunctionData#hashCode(), the alarm severity and the alarm type.

Returns:int

The hash code of this AlarmData object.

Annotations

@Override

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Returns the string representation of this alarm data. Returns:String The string representation of this alarm data. Annotations @Override

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Returns the string representation of this alarm data.

Returns:String

The string representation of this alarm data.

Annotations

@Override

validate	back to summary
private void validate()

public Class AlarmData

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail