Package com.io7m.idstore.protocol.admin

Record Class IdACommandMaintenanceModeSet

java.lang.Object

java.lang.Record

com.io7m.idstore.protocol.admin.IdACommandMaintenanceModeSet

Record Components:

message - The message

All Implemented Interfaces:

com.io7m.hibiscus.api.HBCommandType, com.io7m.hibiscus.api.HBMessageType, IdACommandType<IdAResponseMaintenanceModeSet>, IdAMessageType, IdProtocolMessageType

public record IdACommandMaintenanceModeSet(Optional<String> message)
extends Record
implements IdACommandType<IdAResponseMaintenanceModeSet>

Move the server to/from maintenance mode. If a message is specified, the server is moved into maintenance mode. If no message is specified, the server is moved out of maintenance mode.

Constructor Summary

Constructors

Constructor	Description
IdACommandMaintenanceModeSet(Optional<String> message)	Move the server to/from maintenance mode.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
Optional<String>	message()	Returns the value of the message record component.
Class<IdAResponseMaintenanceModeSet>	responseClass()
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

IdACommandMaintenanceModeSet

public IdACommandMaintenanceModeSet(Optional<String> message)

Move the server to/from maintenance mode. If a message is specified, the server is moved into maintenance mode. If no message is specified, the server is moved out of maintenance mode.

Parameters:

message - The message

Method Details

responseClass

public Class<IdAResponseMaintenanceModeSet> responseClass()

Specified by:

responseClass in interface IdACommandType<IdAResponseMaintenanceModeSet>

Returns:

The response type associated with this command

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.

message

public Optional<String> message()

Returns the value of the message record component.

Returns:

the value of the message record component