com.vaadin.signals.

Record Class SignalCommand.AdoptAsCommand

java.lang.Object
java.lang.Record
com.vaadin.signals.SignalCommand.AdoptAsCommand

Record Components:

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

targetNodeId - id of the parent node to adopt to, not null

childId - id of the child node to adopt, not null

key - key to adopt the node as, not null

All Implemented Interfaces:

SignalCommand, SignalCommand.KeyCommand

Enclosing interface:

SignalCommand

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

Adopts the given node as a child with the given key. The child must already be attached somewhere in the same tree and it cannot be an ancestor of its new parent. There cannot be an existing child with the same key. The child is detached from its previous parent.

  • Constructor Details

    • AdoptAsCommand

      public AdoptAsCommand(Id commandId, Id targetNodeId, Id childId, String key)

      Creates an instance of a AdoptAsCommand record class.

      Parameters:

      commandId - the value for the commandId record component

      targetNodeId - the value for the targetNodeId record component

      childId - the value for the childId 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

    • childId

      public Id childId()

      Returns the value of the childId record component.

      Returns:

      the value of the childId 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