Package com.vaadin.signals.impl

Record Class CommandResult.Accept

java.lang.Object
java.lang.Record
com.vaadin.signals.impl.CommandResult.Accept
Record Components:
updates - a map from node ids to modifications to apply, not null. The map is empty for condition commands that do not apply any changes even if the test passes.
originalInserts - a map from inserted node id to the originating signal command for new nodes with a matching scope owner. Not null.
All Implemented Interfaces:
CommandResult
Enclosing interface:
CommandResult
public static record CommandResult.Accept(Map<Id,CommandResult.NodeModification> updates, Map<Id,SignalCommand.ScopeOwnerCommand> originalInserts) extends Record implements CommandResult
An accepted command. Contains a collection of node updates that are performed as a result of the command and any applied insert commands with a Node.Data.scopeOwner() that matches the tree to which the command was applied.

Note that due to the way aliases are resolved, the node id in the update map might not match the node id in the applied signal command.

  • Constructor Details

  • Method Details

    • accepted

      public boolean accepted()
      Description copied from interface: CommandResult
      Tests whether this command result is accepted or rejected.
      Specified by:
      accepted in interface CommandResult
      Returns:
      true if the command is accepted, false if it's rejected

    • onlyUpdate

      public CommandResult.NodeModification onlyUpdate()
      Asserts that this result contains exactly one modification and returns it.
      Returns:
      the single modification, not null

    • 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.

    • updates

      public Map<Id,CommandResult.NodeModification> updates()
      Returns the value of the updates record component.
      Returns:
      the value of the updates record component

    • originalInserts

      public Map<Id,SignalCommand.ScopeOwnerCommand> originalInserts()
      Returns the value of the originalInserts record component.
      Returns:
      the value of the originalInserts record component