We use cookies to serve our customers and website visitors in the best possible way. Cookies are used for the proper functioning of the website and for improving the user experience, monitoring visitor traffic and marketing purposes. By continuing to browse the site, you agree to our use of cookies. You can read more about cookies here.
com.vaadin.signals.
Package com.vaadin.signals
Interface SignalCommand
All Known Subinterfaces:
SignalCommand.ConditionCommand, SignalCommand.GlobalCommand, SignalCommand.KeyCommand, SignalCommand.ScopeOwnerCommand, SignalCommand.ValueCommand
All Known Implementing Classes:
SignalCommand.AdoptAsCommand, SignalCommand.AdoptAtCommand, SignalCommand.ClearCommand, SignalCommand.ClearOwnerCommand, SignalCommand.IncrementCommand, SignalCommand.InsertCommand, SignalCommand.KeyCondition, SignalCommand.LastUpdateCondition, SignalCommand.PositionCondition, SignalCommand.PutCommand, SignalCommand.PutIfAbsentCommand, SignalCommand.RemoveByKeyCommand, SignalCommand.RemoveCommand, SignalCommand.SetCommand, SignalCommand.SnapshotCommand, SignalCommand.TransactionCommand, SignalCommand.ValueCondition
public sealed interface SignalCommand
permits SignalCommand.ScopeOwnerCommand, SignalCommand.ValueCommand, SignalCommand.KeyCommand, SignalCommand.ConditionCommand, SignalCommand.GlobalCommand, SignalCommand.AdoptAtCommand, SignalCommand.IncrementCommand, SignalCommand.ClearCommand, SignalCommand.RemoveCommand
A command triggered from a signal.
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final recordAdopts the given node as a child with the given key.
static final recordAdopts the given node as a child at the given insertion position.
static final recordRemoves all children from the target node.
static final recordRemoves all nodes that have its scope owner set as the given id.
static interfaceA signal command that doesn't apply any change but only performs a test that will be part of determining whether a transaction passes.
static interfaceA signal command that doesn't target a specific node.
static final recordIncrements the value of the given node by the given delta.
static final recordInserts a new node with the given value at the given list insert position.
static interfaceA signal command that targets a map entry by key.
static final recordTests whether the given node has the expected child for a specific map key.
static final recordTests that the given node was last updated by the command with the given id.
static final recordTests whether the given node has a given child at a given position.
static final recordStores the given value in a child node with the given key.
static final recordStores the given value in a child node with the given key if it doesn't already exist.
static final recordRemoves the child with the given key, if present.
static final recordRemoves the given node from its parent, optionally verifying that the parent is as expected.
static interfaceA signal command that creates a new signal node that might have an owner.
static final recordSets the value of the given node.
static final recordInitializes a tree based on a collection of pre-existing nodes.
static final recordA sequence of commands that should be applied atomically and only if all commands are individually accepted.
static interfaceA signal command that sets the value of a signal.
static final recordTests whether the given node has the expected value, based on JSON equality.
-
Method Summary
Modifier and TypeMethodDescriptionGets the unique command id used to track the status of this command.
Gets the id of the signal node that is targeted by this command.
-
Method Details
-
commandId
Id commandId()Gets the unique command id used to track the status of this command. For commands that creates a new node, the command id is also used as the node id of the created node.
Returns:
the unique command id used to track the status of this command, not
null -
targetNodeId
Id targetNodeId()Gets the id of the signal node that is targeted by this command. Some commands might target multiple nodes e.g. in a parent-child relationship and in that case this node is the primary node. Some commands, implementing
SignalCommand.GlobalCommanddo not target any specific node and for those commands,Id.ZEROis used as the node id.Returns:
id of the primary node targeted by this command, not
null
-