Package org.openhab.core.automation

Class RuleStatusInfo

java.lang.Object

org.openhab.core.automation.RuleStatusInfo

@NonNullByDefault
public class RuleStatusInfo
extends Object

This class is used to present status of a rule. The status consists of the following parts: The main status, a status detail, a string description and the duration (in ms).

Author:

Yordan Mihaylov - Initial contribution, Kai Kreuzer - Refactored to match ThingStatusInfo implementation, Robert Delbrück - add duration property

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	RuleStatusInfo()	Default constructor for deserialization e.g. by Gson.
	RuleStatusInfo(RuleStatus status)	Constructs a status info.
	RuleStatusInfo(RuleStatus status, RuleStatusDetail statusDetail)	Constructs a status info.
	RuleStatusInfo(RuleStatus status, RuleStatusDetail statusDetail, @Nullable String description)	Constructs a status info.
	RuleStatusInfo(RuleStatus status, RuleStatusDetail statusDetail, @Nullable String description, @Nullable Long duration)	Constructs a status info.

Method Summary

Modifier and Type	Method	Description
boolean	equals(@Nullable Object obj)
@Nullable String	getDescription()	Gets the description of the status.
@Nullable Long	getDuration()	Gets the duration of the rule execution that led to this status.
RuleStatus	getStatus()	Gets the status itself.
RuleStatusDetail	getStatusDetail()	Gets the detail of the status.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

RuleStatusInfo

protected RuleStatusInfo()

Default constructor for deserialization e.g. by Gson.

RuleStatusInfo

public RuleStatusInfo(RuleStatus status)

Constructs a status info.

Parameters:

status - the status

RuleStatusInfo

public RuleStatusInfo(RuleStatus status,
 RuleStatusDetail statusDetail)

Constructs a status info.

Parameters:

status - the status

statusDetail - the detail of the status

RuleStatusInfo

public RuleStatusInfo(RuleStatus status,
 RuleStatusDetail statusDetail,
 @Nullable String description)

Constructs a status info.

Parameters:

status - the status

statusDetail - the detail of the status

description - the description of the status

RuleStatusInfo

public RuleStatusInfo(RuleStatus status,
 RuleStatusDetail statusDetail,
 @Nullable String description,
 @Nullable Long duration)

Constructs a status info.

Parameters:

status - the status

statusDetail - the detail of the status

description - the description of the status

duration - the duration of the rule execution in milliseconds that led to this status, or null if not applicable

Method Details

getStatus

public RuleStatus getStatus()

Gets the status itself.

Returns:

the status

getStatusDetail

public RuleStatusDetail getStatusDetail()

Gets the detail of the status.

Returns:

the status detail

getDescription

public @Nullable String getDescription()

Gets the description of the status.

Returns:

the description

getDuration

public @Nullable Long getDuration()

Gets the duration of the rule execution that led to this status.

Returns:

the duration in milliseconds, or null if not applicable

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(@Nullable Object obj)

Overrides:

equals in class Object