Package io.openems.edge.core.host.jsonrpc

Record Class ExecuteSystemCommandRequest.SystemCommand

java.lang.Object

java.lang.Record

io.openems.edge.core.host.jsonrpc.ExecuteSystemCommandRequest.SystemCommand

Enclosing class:

ExecuteSystemCommandRequest

public static record ExecuteSystemCommandRequest.SystemCommand(String command, boolean runInBackground, int timeoutSeconds, Optional<String> username, Optional<String> password)
extends Record

Holds common parameters for a ExecuteSystemCommandRequest.SystemCommand.

Constructor Summary

Constructors

Constructor	Description
SystemCommand(String command, boolean runInBackground, int timeoutSeconds, Optional<String> username, Optional<String> password)	Creates an instance of a SystemCommand record class.

Method Summary

Modifier and Type	Method	Description
String	command()	Returns the value of the command record component.
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>	password()	Returns the value of the password record component.
boolean	runInBackground()	Returns the value of the runInBackground record component.
int	timeoutSeconds()	Returns the value of the timeoutSeconds record component.
final String	toString()	Returns a string representation of this record class.
Optional<String>	username()	Returns the value of the username record component.

Methods inherited from class java.lang.Object

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

Constructor Details

SystemCommand

public SystemCommand(String command,
 boolean runInBackground,
 int timeoutSeconds,
 Optional<String> username,
 Optional<String> password)

Creates an instance of a SystemCommand record class.

Parameters:

command - the value for the command record component

runInBackground - the value for the runInBackground record component

timeoutSeconds - the value for the timeoutSeconds record component

username - the value for the username record component

password - the value for the password 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. 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.

command

public String command()

Returns the value of the command record component.

Returns:

the value of the command record component

runInBackground

public boolean runInBackground()

Returns the value of the runInBackground record component.

Returns:

the value of the runInBackground record component

timeoutSeconds

public int timeoutSeconds()

Returns the value of the timeoutSeconds record component.

Returns:

the value of the timeoutSeconds record component

username

public Optional<String> username()

Returns the value of the username record component.

Returns:

the value of the username record component

password

public Optional<String> password()

Returns the value of the password record component.

Returns:

the value of the password record component