Package com.vaadin.signals

Record Class SignalCommand.RemoveByKeyCommand

java.lang.Object

java.lang.Record

com.vaadin.signals.SignalCommand.RemoveByKeyCommand

Record Components:

commandId - the unique command id used to track the status of this command instance, not null

targetNodeId - id of the node to update, not null

key - the key to remove, not null

All Implemented Interfaces:

SignalCommand, SignalCommand.KeyCommand

Enclosing interface:

SignalCommand

public static record SignalCommand.RemoveByKeyCommand(Id commandId, Id targetNodeId, String key)
extends Record
implements SignalCommand.KeyCommand

Removes the child with the given key, if present.

Nested Class Summary

Nested classes/interfaces inherited from interface com.vaadin.signals.SignalCommand

SignalCommand.AdoptAsCommand, SignalCommand.AdoptAtCommand, SignalCommand.ClearCommand, SignalCommand.ClearOwnerCommand, SignalCommand.ConditionCommand, SignalCommand.GlobalCommand, SignalCommand.IncrementCommand, SignalCommand.InsertCommand, SignalCommand.KeyCommand, SignalCommand.KeyCondition, SignalCommand.LastUpdateCondition, SignalCommand.PositionCondition, SignalCommand.PutCommand, SignalCommand.PutIfAbsentCommand, SignalCommand.RemoveByKeyCommand, SignalCommand.RemoveCommand, SignalCommand.ScopeOwnerCommand, SignalCommand.SetCommand, SignalCommand.SnapshotCommand, SignalCommand.TransactionCommand, SignalCommand.ValueCommand, SignalCommand.ValueCondition

Constructor Summary

Constructors

Constructor	Description
RemoveByKeyCommand(Id commandId, Id targetNodeId, String key)	Creates an instance of a RemoveByKeyCommand record class.

Method Summary

Modifier and Type	Method	Description
Id	commandId()	Returns the value of the commandId 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.
String	key()	Returns the value of the key record component.
Id	targetNodeId()	Returns the value of the targetNodeId 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

RemoveByKeyCommand

public RemoveByKeyCommand(Id commandId,
 Id targetNodeId,
 String key)

Creates an instance of a RemoveByKeyCommand record class.

Parameters:

commandId - the value for the commandId record component

targetNodeId - the value for the targetNodeId record component

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

commandId

public Id commandId()

Returns the value of the commandId record component.

Specified by:

commandId in interface SignalCommand

Returns:

the value of the commandId record component

targetNodeId

public Id targetNodeId()

Returns the value of the targetNodeId record component.

Specified by:

targetNodeId in interface SignalCommand

Returns:

the value of the targetNodeId record component

key

public String key()

Returns the value of the key record component.

Specified by:

key in interface SignalCommand.KeyCommand

Returns:

the value of the key record component