com.prosysopc.ua.pubsub

Class PubSubUadpStatusMessage

java.lang.Object

com.prosysopc.ua.pubsub.PubSubUadpStatusMessage

All Implemented Interfaces:

PubSubStatusMessage, PubSubUadpMessageContent

public final class PubSubUadpStatusMessage
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PubSubUadpStatusMessage.Builder Builder for PubSubUadpStatusMessage.

Method Summary

Modifier and Type	Method and Description
static PubSubUadpStatusMessage.Builder	builder() Returns a new PubSubUadpStatusMessage.Builder that can be used to construct instances of this class
boolean	equals(Object obj)
ByteString	getEncoded()
boolean	getIsCyclic() True if Publisher periodically publishes status (see PubSubStatusMessage.getNextReportTime()).
DateTime	getNextReportTime() Returns when the next status update is expected.
PubSubState	getStatus() Status of the Publisher.
DateTime	getTimestamp()
int	hashCode()
PubSubUadpStatusMessage.Builder	toBuilder() Returns a new PubSubUadpStatusMessage.Builder that is initialized with the state of this object.
String	toString()
PubSubUadpStatusMessage	withEncoded(ByteString encoded)
PubSubUadpStatusMessage	withIsCyclic(boolean isCyclic)
PubSubUadpStatusMessage	withNextReportTime(DateTime nextReportTime)
PubSubUadpStatusMessage	withStatus(PubSubState status)
PubSubUadpStatusMessage	withTimestamp(DateTime timestamp)

Methods inherited from class java.lang.Object

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

Method Detail

getEncoded

public ByteString getEncoded()

getIsCyclic

public boolean getIsCyclic()

Description copied from interface: PubSubStatusMessage

True if Publisher periodically publishes status (see PubSubStatusMessage.getNextReportTime()). If false, the middleware (such as a MQTT Broker) should notify errors (via such as MQTT Will message).

getNextReportTime

public DateTime getNextReportTime()

Description copied from interface: PubSubStatusMessage

Returns when the next status update is expected. NOTE, this can be null and should be ignored if PubSubStatusMessage.getIsCyclic() is false.

getStatus

public PubSubState getStatus()

Description copied from interface: PubSubStatusMessage

Status of the Publisher.

getTimestamp

public DateTime getTimestamp()

withEncoded

public PubSubUadpStatusMessage withEncoded(ByteString encoded)

withIsCyclic

public PubSubUadpStatusMessage withIsCyclic(boolean isCyclic)

withNextReportTime

public PubSubUadpStatusMessage withNextReportTime(DateTime nextReportTime)

withStatus

public PubSubUadpStatusMessage withStatus(PubSubState status)

withTimestamp

public PubSubUadpStatusMessage withTimestamp(DateTime timestamp)

builder

public static PubSubUadpStatusMessage.Builder builder()

Returns a new PubSubUadpStatusMessage.Builder that can be used to construct instances of this class

toBuilder

public PubSubUadpStatusMessage.Builder toBuilder()

Returns a new PubSubUadpStatusMessage.Builder that is initialized with the state of this object.

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object