Package com.inductiveautomation.ignition.gateway.storeforward.engine

Record Class EngineStatus

java.lang.Object

java.lang.Record

com.inductiveautomation.ignition.gateway.storeforward.engine.EngineStatus

Record Components:

mode - the mode (state) that the engine is currently running

reasoning - any additional messages that pertain to why the mode

accepting - if the engine is currently accepting data

public record EngineStatus(EngineStatus.EngineMode mode, Optional<LocalizedString> reasoning, boolean accepting)
extends Record

The store and forward engine status.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	EngineStatus.EngineMode

Constructor Summary

Constructors

Constructor	Description
EngineStatus(EngineStatus.EngineMode mode, Optional<LocalizedString> reasoning, boolean accepting)	Creates an instance of a EngineStatus record class.

Method Summary

Modifier and Type	Method	Description
boolean	accepting()	Returns the value of the accepting record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
static EngineStatus	erroredStatus(LocalizedString reasoning)
static EngineStatus	fullyOperationStatus()
final int	hashCode()	Returns a hash code value for this object.
EngineStatus.EngineMode	mode()	Returns the value of the mode record component.
Optional<LocalizedString>	reasoning()	Returns the value of the reasoning record component.
static EngineStatus	storageOnlyStatus(LocalizedString reasoning)
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

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

Constructor Details

EngineStatus

public EngineStatus(EngineStatus.EngineMode mode,
 Optional<LocalizedString> reasoning,
 boolean accepting)

Creates an instance of a EngineStatus record class.

Parameters:

mode - the value for the mode record component

reasoning - the value for the reasoning record component

accepting - the value for the accepting record component

Method Details

fullyOperationStatus

public static EngineStatus fullyOperationStatus()

storageOnlyStatus

public static EngineStatus storageOnlyStatus(@Nullable
 LocalizedString reasoning)

erroredStatus

public static EngineStatus erroredStatus(@Nullable
 LocalizedString reasoning)

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

mode

public EngineStatus.EngineMode mode()

Returns the value of the mode record component.

Returns:

the value of the mode record component

reasoning

public Optional<LocalizedString> reasoning()

Returns the value of the reasoning record component.

Returns:

the value of the reasoning record component

accepting

public boolean accepting()

Returns the value of the accepting record component.

Returns:

the value of the accepting record component