Package com.io7m.idstore.protocol.admin.cb

Record Class IdA1CommandMaintenanceModeSet

java.lang.Object

java.lang.Record

com.io7m.idstore.protocol.admin.cb.IdA1CommandMaintenanceModeSet

Record Components:

fieldMessage - The message (if maintenance mode is to be turned on).

All Implemented Interfaces:

com.io7m.cedarbridge.runtime.api.CBProtocolMessageType, com.io7m.cedarbridge.runtime.api.CBSerializableType, ProtocolIdAType, ProtocolIdAv1Type

public record IdA1CommandMaintenanceModeSet(com.io7m.cedarbridge.runtime.api.CBOptionType<com.io7m.cedarbridge.runtime.api.CBString> fieldMessage)
extends Record
implements com.io7m.cedarbridge.runtime.api.CBSerializableType, ProtocolIdAv1Type

Move the server to/from maintenance mode.

Constructor Summary

Constructors

Constructor	Description
IdA1CommandMaintenanceModeSet(com.io7m.cedarbridge.runtime.api.CBOptionType<com.io7m.cedarbridge.runtime.api.CBString> fieldMessage)	Creates an instance of a IdA1CommandMaintenanceModeSet record class.

Method Summary

Modifier and Type	Method	Description
static IdA1CommandMaintenanceModeSet	deserialize(com.io7m.cedarbridge.runtime.api.CBSerializationContextType $context)	Deserialize a value of type IdA1CommandMaintenanceModeSet.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
com.io7m.cedarbridge.runtime.api.CBOptionType<com.io7m.cedarbridge.runtime.api.CBString>	fieldMessage()	Returns the value of the fieldMessage record component.
final int	hashCode()	Returns a hash code value for this object.
static void	serialize(com.io7m.cedarbridge.runtime.api.CBSerializationContextType $context, IdA1CommandMaintenanceModeSet $x)	Serialize a value of type IdA1CommandMaintenanceModeSet.
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

IdA1CommandMaintenanceModeSet

public IdA1CommandMaintenanceModeSet(com.io7m.cedarbridge.runtime.api.CBOptionType<com.io7m.cedarbridge.runtime.api.CBString> fieldMessage)

Creates an instance of a IdA1CommandMaintenanceModeSet record class.

Parameters:

fieldMessage - the value for the fieldMessage record component

Method Details

serialize

public static void serialize(com.io7m.cedarbridge.runtime.api.CBSerializationContextType $context,
 IdA1CommandMaintenanceModeSet $x)
                      throws IOException

Serialize a value of type IdA1CommandMaintenanceModeSet.

Parameters:

$context - The serialization context.

$x - The value to be serialized.

Throws:

IOException

deserialize

public static IdA1CommandMaintenanceModeSet deserialize(com.io7m.cedarbridge.runtime.api.CBSerializationContextType $context)
                                                 throws IOException

Deserialize a value of type IdA1CommandMaintenanceModeSet.

Parameters:

$context - The serialization context.

Returns:

A value of type IdA1CommandMaintenanceModeSet.

Throws:

IOException

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. All components in this record class are compared with Objects::equals(Object,Object).

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.

fieldMessage

public com.io7m.cedarbridge.runtime.api.CBOptionType<com.io7m.cedarbridge.runtime.api.CBString> fieldMessage()

Returns the value of the fieldMessage record component.

Returns:

the value of the fieldMessage record component