Uses of Interface
com.vaadin.flow.signals.SignalCommand

Packages that use SignalCommand

Package	Description
com.vaadin.flow.signals
com.vaadin.flow.signals.function
com.vaadin.flow.signals.impl
com.vaadin.flow.signals.shared
com.vaadin.flow.signals.shared.impl

Uses of SignalCommand in com.vaadin.flow.signals

Subinterfaces of SignalCommand in com.vaadin.flow.signals

Modifier and Type	Interface	Description
static interface	SignalCommand.ConditionCommand	A signal command that doesn't apply any change but only performs a test that will be part of determining whether a transaction passes.
static interface	SignalCommand.GlobalCommand	A signal command that doesn't target a specific node.
static interface	SignalCommand.KeyCommand	A signal command that targets a map entry by key.
static interface	SignalCommand.ScopeOwnerCommand	A signal command that creates a new signal node that might have an owner.
static interface	SignalCommand.ValueCommand	A signal command that sets the value of a signal.

Classes in com.vaadin.flow.signals that implement SignalCommand

Modifier and Type	Class	Description
static final record	SignalCommand.AdoptAsCommand	Adopts the given node as a child with the given key.
static final record	SignalCommand.AdoptAtCommand	Adopts the given node as a child at the given insertion position.
static final record	SignalCommand.ClearCommand	Removes all children from the target node.
static final record	SignalCommand.ClearOwnerCommand	Removes all nodes that have its scope owner set as the given id.
static final record	SignalCommand.IncrementCommand	Increments the value of the given node by the given delta.
static final record	SignalCommand.InsertCommand	Inserts a new node with the given value at the given list insert position.
static final record	SignalCommand.KeyCondition	Tests whether the given node has the expected child for a specific map key.
static final record	SignalCommand.LastUpdateCondition	Tests that the given node was last updated by the command with the given id.
static final record	SignalCommand.PositionCondition	Tests whether the given node has a given child at a given position.
static final record	SignalCommand.PutCommand	Stores the given value in a child node with the given key.
static final record	SignalCommand.PutIfAbsentCommand	Stores the given value in a child node with the given key if it doesn't already exist.
static final record	SignalCommand.RemoveByKeyCommand	Removes the child with the given key, if present.
static final record	SignalCommand.RemoveCommand	Removes the given node from its parent, optionally verifying that the parent is as expected.
static final record	SignalCommand.SetCommand	Sets the value of the given node.
static final record	SignalCommand.SnapshotCommand	Initializes a tree based on a collection of pre-existing nodes.
static final record	SignalCommand.TransactionCommand	A sequence of commands that should be applied atomically and only if all commands are individually accepted.
static final record	SignalCommand.ValueCondition	Tests whether the given node has the expected value, based on JSON equality.

Methods in com.vaadin.flow.signals that return types with arguments of type SignalCommand

Modifier and Type	Method	Description
List<SignalCommand>	SignalCommand.TransactionCommand.commands()	Returns the value of the commands record component.

Constructor parameters in com.vaadin.flow.signals with type arguments of type SignalCommand

Modifier	Constructor	Description
	TransactionCommand(Id commandId, List<SignalCommand> commands)	Creates an instance of a TransactionCommand record class.

Uses of SignalCommand in com.vaadin.flow.signals.function

Methods in com.vaadin.flow.signals.function with parameters of type SignalCommand

Modifier and Type	Method	Description
boolean	CommandValidator.isValid(SignalCommand command)	Tests whether the given command is valid and should be allowed to execute.

Uses of SignalCommand in com.vaadin.flow.signals.impl

Methods in com.vaadin.flow.signals.impl with parameters of type SignalCommand

Modifier and Type	Method	Description
void	Transaction.include(SignalTree tree, SignalCommand command, @Nullable CommandsAndHandlers.CommandResultHandler resultHandler)	Includes the given command to the given tree in the context of this transaction and sets the command to be applied to the underlying signal tree.
abstract void	Transaction.include(SignalTree tree, SignalCommand command, @Nullable CommandsAndHandlers.CommandResultHandler resultHandler, boolean applyToTree)	Includes the given command to the given tree in the context of this transaction and optionally also sets the command to be applied to the underlying signal tree.

Uses of SignalCommand in com.vaadin.flow.signals.shared

Methods in com.vaadin.flow.signals.shared with parameters of type SignalCommand

Modifier and Type	Method	Description
static boolean	SignalUtils.isValid(AbstractSignal<?> signal, SignalCommand command)	Checks whether the given command is considered valid by the validator instance of the provided signal.
protected SignalOperation<Void>	AbstractSignal.submit(SignalCommand command)	Submits a command for this signal and updates the created operation without a value once the command result is confirmed.
protected <R> SignalOperation<R>	AbstractSignal.submit(SignalCommand command, AbstractSignal.ResultConverter<R> resultConverter)	Submits a command for this signal and uses the provided result converter to updates the created operation once the command result is confirmed.
protected <R, O extends SignalOperation<R>> O	AbstractSignal.submit(SignalCommand command, AbstractSignal.ResultConverter<R> resultConverter, O operation)	Submits a command for this signal and updates the given operation using the given result converter once the command result is confirmed.
protected <I extends AbstractSignal<?>> InsertOperation<I>	AbstractSignal.submitInsert(SignalCommand command, AbstractSignal.ChildSignalFactory<I> childFactory)	Submits a command for this signal and creates and insert operation that is updated once the command result is confirmed.
protected <O extends SignalOperation<Void>> O	AbstractSignal.submitVoidOperation(SignalCommand command, O operation)	Submits a command for this signal and updates the given operation without a value once the command result is confirmed.

Uses of SignalCommand in com.vaadin.flow.signals.shared.impl

Methods in com.vaadin.flow.signals.shared.impl that return types with arguments of type SignalCommand

Modifier and Type	Method	Description
List<SignalCommand>	CommandsAndHandlers.getCommands()	Gets an unmodifiable view of the commands.

Methods in com.vaadin.flow.signals.shared.impl with parameters of type SignalCommand

Modifier and Type	Method	Description
void	MutableTreeRevision.apply(SignalCommand command, @Nullable com.vaadin.flow.signals.shared.impl.MutableTreeRevision.CommandDispatcher resultCollector)	Applies a single command and passes the results to the provided handler.
void	SignalTree.commitSingleCommand(SignalCommand command)	Applies a single command to this tree without listening for the result.
void	SignalTree.commitSingleCommand(SignalCommand command, @Nullable CommandsAndHandlers.CommandResultHandler resultHandler)	Applies a single command to this tree.
void	StagedTransaction.include(SignalTree tree, SignalCommand command, @Nullable CommandsAndHandlers.CommandResultHandler resultHandler, boolean applyToTree)
void	SignalTree.CommandSubscriber.onCommandProcessed(SignalCommand command, CommandResult result)	Called when a command has been processed.

Method parameters in com.vaadin.flow.signals.shared.impl with type arguments of type SignalCommand

Modifier and Type	Method	Description
void	MutableTreeRevision.apply(List<SignalCommand> commands)	Applies a sequence of commands and ignores the results.
Map<Id,CommandResult>	MutableTreeRevision.applyAndGetResults(List<SignalCommand> commands)	Applies a sequence of commands and collects the results to a map.
void	AsynchronousSignalTree.confirm(List<SignalCommand> commands)	Adds a sequence of commands to the confirmed snapshot.
protected void	SignalTree.notifyProcessedCommandSubscribers(List<SignalCommand> commands, Map<Id,CommandResult> results)	Notifies all subscribers after a command is processed.
void	CommandsAndHandlers.notifyResultHandlers(Map<Id,CommandResult> results, List<SignalCommand> commandOrder)	Notifies and removes result handlers for the given results in the given order.
protected abstract void	AsynchronousSignalTree.submit(List<SignalCommand> commands)	Submits a sequence of commands to the event log.
protected void	LocalAsynchronousSignalTree.submit(List<SignalCommand> commands)

Constructors in com.vaadin.flow.signals.shared.impl with parameters of type SignalCommand

Modifier	Constructor	Description
	CommandsAndHandlers(SignalCommand command, @Nullable CommandsAndHandlers.CommandResultHandler resultHandler)	Creates a new command list with a single command and optional result handler.

Constructor parameters in com.vaadin.flow.signals.shared.impl with type arguments of type SignalCommand

Modifier	Constructor	Description
	CommandsAndHandlers(List<SignalCommand> commands, Map<Id,CommandsAndHandlers.CommandResultHandler> resultHandlers)	Creates a new command list with the given commands and result handlers.