Package com.isode.mhfcm

Class CircuitStatus

java.lang.Object

com.isode.mhfcm.CircuitStatus

public class CircuitStatus
extends Object

Object used to represent circuit status.

Since:

16.4

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	CircuitStatus.Status	Different types of CircuitStatus message.

Method Summary

Modifier and Type	Method	Description
CircuitStatus.Status	getStatus()	Determine the status associated with this CircuitStatus
static CircuitStatus.Status	getStatus(String c)	Determine the Status enum for a particular code string
Date	getTimeOfChange()	Determine the time of the last state change.
String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Details

getStatus

public CircuitStatus.Status getStatus()

Determine the status associated with this CircuitStatus

Returns:

a type. Will never be null.

getTimeOfChange

public Date getTimeOfChange()

Determine the time of the last state change. For DATA_BEING_RECEIVED, this is the time of the start of transmission. For all other status values, this is the time of the end of transmission.

Returns:

the time of the last state change

getStatus

public static CircuitStatus.Status getStatus(String c)

Determine the Status enum for a particular code string

Parameters:

c - the code string (must not be null)

Returns:

a Status enum corresponding to the specified code, or null if there is no matching Status

toString

public String toString()

Overrides:

toString in class Object