Package org.lfenergy.compas.sct.commons.dto

Record Class ControlBlockNetworkSettings.SettingsOrError

java.lang.Object

java.lang.Record

org.lfenergy.compas.sct.commons.dto.ControlBlockNetworkSettings.SettingsOrError

Record Components:

settings - Network settings for ControlBlock communication. Can be null when errorMessage is provided

errorMessage - should be null if settings is provided

Enclosing interface:

ControlBlockNetworkSettings

public static record ControlBlockNetworkSettings.SettingsOrError(ControlBlockNetworkSettings.Settings settings, String errorMessage)
extends Record

Network settings for ControlBlock communication or Error message

Constructor Summary

Constructors

Constructor	Description
SettingsOrError(ControlBlockNetworkSettings.Settings settings, String errorMessage)	Creates an instance of a SettingsOrError record class.

Method Summary

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

SettingsOrError

public SettingsOrError(ControlBlockNetworkSettings.Settings settings,
 String errorMessage)

Creates an instance of a SettingsOrError record class.

Parameters:

settings - the value for the settings record component

errorMessage - the value for the errorMessage record component

Method Details

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.

settings

public ControlBlockNetworkSettings.Settings settings()

Returns the value of the settings record component.

Returns:

the value of the settings record component

errorMessage

public String errorMessage()

Returns the value of the errorMessage record component.

Returns:

the value of the errorMessage record component