Index
All Classes and Interfaces|All Packages|Serialized Form
A
- AbstractSignal<T> - Class in com.vaadin.signals
-
Base type for full-featured signals that are backed by a transactional signal tree.
- AbstractSignal(SignalTree, Id, Predicate<SignalCommand>) - Constructor for class com.vaadin.signals.AbstractSignal
-
Creates a new signal instance with the given id and validator for the given signal tree.
- Accept(Map<Id, CommandResult.NodeModification>, Map<Id, SignalCommand.ScopeOwnerCommand>) - Constructor for record class com.vaadin.signals.impl.CommandResult.Accept
-
Creates an instance of a
Acceptrecord class. - accepted() - Method in record class com.vaadin.signals.impl.CommandResult.Accept
- accepted() - Method in interface com.vaadin.signals.impl.CommandResult
-
Tests whether this command result is accepted or rejected.
- accepted() - Method in record class com.vaadin.signals.impl.CommandResult.Reject
- add(CommandsAndHandlers) - Method in class com.vaadin.signals.impl.CommandsAndHandlers
-
Adds another collection of commands and handlers to this one.
- adoptAs(AbstractSignal<?>, String) - Method in class com.vaadin.signals.NodeSignal
-
Adopts the given node as a map child with the given key.
- AdoptAsCommand(Id, Id, Id, String) - Constructor for record class com.vaadin.signals.SignalCommand.AdoptAsCommand
-
Creates an instance of a
AdoptAsCommandrecord class. - adoptAt(AbstractSignal<?>, ListSignal.ListPosition) - Method in class com.vaadin.signals.NodeSignal
-
Adopts the given node as a list child at the given location.
- AdoptAtCommand(Id, Id, Id, ListSignal.ListPosition) - Constructor for record class com.vaadin.signals.SignalCommand.AdoptAtCommand
-
Creates an instance of a
AdoptAtCommandrecord class. - after() - Method in record class com.vaadin.signals.ListSignal.ListPosition
-
Returns the value of the
afterrecord component. - after(AbstractSignal<?>) - Static method in record class com.vaadin.signals.ListSignal.ListPosition
-
Gets the insertion position immediately after the given signal.
- Alias(Id) - Constructor for record class com.vaadin.signals.Node.Alias
-
Creates an instance of a
Aliasrecord class. - ANYTHING_GOES - Static variable in class com.vaadin.signals.AbstractSignal
-
Signal validator that accepts anything.
- apply(SignalCommand, BiConsumer<Id, CommandResult>) - Method in class com.vaadin.signals.impl.MutableTreeRevision
-
Applies a single command and passes the results to the provided handler.
- apply(List<SignalCommand>) - Method in class com.vaadin.signals.impl.MutableTreeRevision
-
Applies a sequence of commands and ignores the results.
- applyAndGetResults(List<SignalCommand>) - Method in class com.vaadin.signals.impl.MutableTreeRevision
-
Applies a sequence of commands and collects the results to a map.
- applyChanges() - Method in interface com.vaadin.signals.impl.SignalTree.PendingCommit
-
Updates the tree state so that all pending changes are considered to be submitted.
- asBase64() - Method in record class com.vaadin.signals.Id
-
Returns this id value as a base64 string.
- asList(Class<T>) - Method in class com.vaadin.signals.NodeSignal
-
Creates a list signal backed by the list children of this node.
- asMap(Class<T>) - Method in class com.vaadin.signals.NodeSignal
-
Creates a map signal backed by the map children of this node.
- asNode() - Method in class com.vaadin.signals.AbstractSignal
-
Converts this signal into a node signal.
- asNode() - Method in class com.vaadin.signals.impl.ComputedSignal
- asNode() - Method in class com.vaadin.signals.ListSignal
- asNode() - Method in class com.vaadin.signals.MapSignal
- asNode() - Method in class com.vaadin.signals.ValueSignal
- asNumber() - Method in class com.vaadin.signals.NodeSignal
-
Creates a number signal backed by the node value of this node.
- asReadonly() - Method in class com.vaadin.signals.ListSignal
-
Wraps this signal to not accept changes.
- asReadonly() - Method in class com.vaadin.signals.MapSignal
-
Wraps this signal to not accept changes.
- asReadonly() - Method in class com.vaadin.signals.NodeSignal
-
Wraps this signal to not accept changes.
- asReadonly() - Method in class com.vaadin.signals.NumberSignal
-
Wraps this signal to not accept changes.
- asReadonly() - Method in class com.vaadin.signals.ValueSignal
- asReadonly() - Method in interface com.vaadin.signals.WritableSignal
-
Wraps this signal to not accept changes.
- assertValidTree() - Method in class com.vaadin.signals.impl.TreeRevision
-
Asserts that the nodes in this revision are internally consistent.
- asValue(Class<T>) - Method in class com.vaadin.signals.NodeSignal
-
Creates a value signal backed by the node value of this node.
- ASYNCHRONOUS - Enum constant in enum class com.vaadin.signals.impl.SignalTree.Type
-
Asynchronous trees can only confirm the status of applied commands asynchronously and can thus not participate in transactions that contain other asynchronous or synchronous trees.
- AsynchronousSignalTree - Class in com.vaadin.signals.impl
-
A signal tree that submits commands to an event log and asynchronously waits for external confirmation before completing handling of the command.
- AsynchronousSignalTree() - Constructor for class com.vaadin.signals.impl.AsynchronousSignalTree
-
Creates a new asynchronous signal tree.
B
- before() - Method in record class com.vaadin.signals.ListSignal.ListPosition
-
Returns the value of the
beforerecord component. - before(AbstractSignal<?>) - Static method in record class com.vaadin.signals.ListSignal.ListPosition
-
Gets the insertion position immediately before the given signal.
- between(AbstractSignal<?>, AbstractSignal<?>) - Static method in record class com.vaadin.signals.ListSignal.ListPosition
-
Gets the insertion position between the given signals, assuming those signals are currently adjacent.
- BindingActiveException - Exception Class in com.vaadin.signals
-
Exception indicating that an operation could not be performed because a binding is active.
- BindingActiveException() - Constructor for exception class com.vaadin.signals.BindingActiveException
-
Creates a new exception with a default message.
- BindingActiveException(String) - Constructor for exception class com.vaadin.signals.BindingActiveException
-
Creates a new exception with a custom message.
C
- cancel() - Method in class com.vaadin.signals.operations.CancelableOperation
-
Cancels this operation.
- CancelableOperation<T> - Class in com.vaadin.signals.operations
-
An operation that can be cancelled.
- CancelableOperation() - Constructor for class com.vaadin.signals.operations.CancelableOperation
-
Creates a new cancelable operation.
- canCommit() - Method in interface com.vaadin.signals.impl.SignalTree.PendingCommit
-
Checks whether the pending changes can be committed.
- childId() - Method in record class com.vaadin.signals.SignalCommand.AdoptAsCommand
-
Returns the value of the
childIdrecord component. - childId() - Method in record class com.vaadin.signals.SignalCommand.AdoptAtCommand
-
Returns the value of the
childIdrecord component. - childId() - Method in record class com.vaadin.signals.SignalCommand.PositionCondition
-
Returns the value of the
childIdrecord component. - clear() - Method in class com.vaadin.signals.AbstractSignal
-
Helper to submit a clear command.
- clear() - Method in class com.vaadin.signals.ListSignal
-
Removes all children from this list.
- clear() - Method in class com.vaadin.signals.MapSignal
-
Removes all entries from this map.
- clear() - Method in class com.vaadin.signals.NodeSignal
-
Removes all list children and map children from this node.
- clear() - Method in interface com.vaadin.signals.SignalFactory
-
Removes all name associations.
- ClearCommand(Id, Id) - Constructor for record class com.vaadin.signals.SignalCommand.ClearCommand
-
Creates an instance of a
ClearCommandrecord class. - ClearOwnerCommand(Id, Id) - Constructor for record class com.vaadin.signals.SignalCommand.ClearOwnerCommand
-
Creates an instance of a
ClearOwnerCommandrecord class. - com.vaadin.signals - package com.vaadin.signals
- com.vaadin.signals.impl - package com.vaadin.signals.impl
- com.vaadin.signals.operations - package com.vaadin.signals.operations
- commandId() - Method in record class com.vaadin.signals.SignalCommand.AdoptAsCommand
-
Returns the value of the
commandIdrecord component. - commandId() - Method in record class com.vaadin.signals.SignalCommand.AdoptAtCommand
-
Returns the value of the
commandIdrecord component. - commandId() - Method in record class com.vaadin.signals.SignalCommand.ClearCommand
-
Returns the value of the
commandIdrecord component. - commandId() - Method in record class com.vaadin.signals.SignalCommand.ClearOwnerCommand
-
Returns the value of the
commandIdrecord component. - commandId() - Method in interface com.vaadin.signals.SignalCommand
-
Gets the unique command id used to track the status of this command.
- commandId() - Method in record class com.vaadin.signals.SignalCommand.IncrementCommand
-
Returns the value of the
commandIdrecord component. - commandId() - Method in record class com.vaadin.signals.SignalCommand.InsertCommand
-
Returns the value of the
commandIdrecord component. - commandId() - Method in record class com.vaadin.signals.SignalCommand.KeyCondition
-
Returns the value of the
commandIdrecord component. - commandId() - Method in record class com.vaadin.signals.SignalCommand.LastUpdateCondition
-
Returns the value of the
commandIdrecord component. - commandId() - Method in record class com.vaadin.signals.SignalCommand.PositionCondition
-
Returns the value of the
commandIdrecord component. - commandId() - Method in record class com.vaadin.signals.SignalCommand.PutCommand
-
Returns the value of the
commandIdrecord component. - commandId() - Method in record class com.vaadin.signals.SignalCommand.PutIfAbsentCommand
-
Returns the value of the
commandIdrecord component. - commandId() - Method in record class com.vaadin.signals.SignalCommand.RemoveByKeyCommand
-
Returns the value of the
commandIdrecord component. - commandId() - Method in record class com.vaadin.signals.SignalCommand.RemoveCommand
-
Returns the value of the
commandIdrecord component. - commandId() - Method in record class com.vaadin.signals.SignalCommand.SetCommand
-
Returns the value of the
commandIdrecord component. - commandId() - Method in record class com.vaadin.signals.SignalCommand.SnapshotCommand
-
Returns the value of the
commandIdrecord component. - commandId() - Method in record class com.vaadin.signals.SignalCommand.TransactionCommand
-
Returns the value of the
commandIdrecord component. - commandId() - Method in record class com.vaadin.signals.SignalCommand.ValueCondition
-
Returns the value of the
commandIdrecord component. - CommandResult - Interface in com.vaadin.signals.impl
-
The result of applying a signal command against a tree revision.
- CommandResult.Accept - Record Class in com.vaadin.signals.impl
-
An accepted command.
- CommandResult.NodeModification - Record Class in com.vaadin.signals.impl
-
A data node update in an accepted command result.
- CommandResult.Reject - Record Class in com.vaadin.signals.impl
-
A rejected command, together with the reason for the rejection.
- commands() - Method in record class com.vaadin.signals.SignalCommand.TransactionCommand
-
Returns the value of the
commandsrecord component. - CommandsAndHandlers - Class in com.vaadin.signals.impl
-
A list of signal commands together with their result handlers.
- CommandsAndHandlers() - Constructor for class com.vaadin.signals.impl.CommandsAndHandlers
-
Creates a new empty command list.
- CommandsAndHandlers(SignalCommand, Consumer<CommandResult>) - Constructor for class com.vaadin.signals.impl.CommandsAndHandlers
-
Creates a new command list with a single command and optional result handler.
- CommandsAndHandlers(List<SignalCommand>, Map<Id, Consumer<CommandResult>>) - Constructor for class com.vaadin.signals.impl.CommandsAndHandlers
-
Creates a new command list with the given commands and result handlers.
- commit(Consumer<SignalOperation.ResultOrError<Void>>) - Method in class com.vaadin.signals.impl.StagedTransaction
- commit(Consumer<SignalOperation.ResultOrError<Void>>) - Method in class com.vaadin.signals.impl.Transaction
-
Commits any staged commands in this transaction.
- commitSingleCommand(SignalCommand) - Method in class com.vaadin.signals.impl.SignalTree
-
Applies a single command to this tree without listening for the result.
- commitSingleCommand(SignalCommand, Consumer<CommandResult>) - Method in class com.vaadin.signals.impl.SignalTree
-
Applies a single command to this tree.
- compareTo(Id) - Method in record class com.vaadin.signals.Id
- computed(Supplier<T>) - Static method in interface com.vaadin.signals.Signal
-
Creates a new computed signal with the given computation callback.
- COMPUTED - Enum constant in enum class com.vaadin.signals.impl.SignalTree.Type
-
Computed trees cannot cause conflicts and can thus participate in any transaction without restrictions.
- ComputedSignal<T> - Class in com.vaadin.signals.impl
-
A signal with a value that is computed based on the value of other signals.
- ComputedSignal(Supplier<T>) - Constructor for class com.vaadin.signals.impl.ComputedSignal
-
Creates a new computed signal with the provided compute callback.
- conditional(boolean, String) - Static method in interface com.vaadin.signals.impl.CommandResult
-
Creates an accepted or rejected result depending on the provided condition.
- confirm(List<SignalCommand>) - Method in class com.vaadin.signals.impl.AsynchronousSignalTree
-
Adds a sequence of commands to the confirmed snapshot.
- confirmed() - Method in class com.vaadin.signals.impl.AsynchronousSignalTree
- confirmed() - Method in class com.vaadin.signals.impl.SignalTree
-
Gets the current snapshot based on all confirmed commands.
- confirmed() - Method in class com.vaadin.signals.impl.SynchronousSignalTree
- createUsage(Transaction) - Method in class com.vaadin.signals.AbstractSignal
-
Creates a usage instance based on the current state of this signal.
- createUsage(Transaction) - Method in class com.vaadin.signals.impl.ComputedSignal
-
Creates a usage instance based on the current state of this signal.
D
- data(Id) - Method in class com.vaadin.signals.impl.TreeRevision
-
Get the data node for the given node id, if present.
- data(Transaction) - Method in class com.vaadin.signals.AbstractSignal
-
Gets the data node for this signal in the given transaction.
- data(TreeRevision) - Method in class com.vaadin.signals.AbstractSignal
-
Gets the data node for this signal in the given tree revision.
- Data(Id, Id, Id, JsonNode, List<Id>, Map<String, Id>) - Constructor for record class com.vaadin.signals.Node.Data
-
Creates a new data node.
- delta() - Method in record class com.vaadin.signals.SignalCommand.IncrementCommand
-
Returns the value of the
deltarecord component. - dispose() - Method in class com.vaadin.signals.impl.Effect
-
Disposes this effect by unregistering all current dependencies and preventing the action from running again.
E
- EDGE - Static variable in record class com.vaadin.signals.Id
-
Id representing the edge of a list.
- effect(Runnable) - Static method in interface com.vaadin.signals.Signal
-
Creates a signal effect with the given action.
- Effect - Class in com.vaadin.signals.impl
-
Applies a side effect based on signal value changes.
- Effect(Runnable) - Constructor for class com.vaadin.signals.impl.Effect
-
Creates a signal effect with the given action and the default dispatcher.
- Effect(Runnable, Executor) - Constructor for class com.vaadin.signals.impl.Effect
-
Creates a signal effect with the given action and a custom dispatcher.
- EMPTY - Static variable in interface com.vaadin.signals.Node
-
An empty data node without parent, scope owner, value or children and the initial last update id.
- equals(Object) - Method in record class com.vaadin.signals.Id
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.vaadin.signals.impl.CommandResult.Accept
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.vaadin.signals.impl.CommandResult.NodeModification
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.vaadin.signals.impl.CommandResult.Reject
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in class com.vaadin.signals.ListSignal
- equals(Object) - Method in record class com.vaadin.signals.ListSignal.ListPosition
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in class com.vaadin.signals.MapSignal
- equals(Object) - Method in record class com.vaadin.signals.Node.Alias
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.vaadin.signals.Node.Data
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in class com.vaadin.signals.NodeSignal
- equals(Object) - Method in class com.vaadin.signals.NumberSignal
- equals(Object) - Method in record class com.vaadin.signals.operations.SignalOperation.Error
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.vaadin.signals.operations.SignalOperation.Result
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.vaadin.signals.SignalCommand.AdoptAsCommand
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.vaadin.signals.SignalCommand.AdoptAtCommand
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.vaadin.signals.SignalCommand.ClearCommand
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.vaadin.signals.SignalCommand.ClearOwnerCommand
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.vaadin.signals.SignalCommand.IncrementCommand
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.vaadin.signals.SignalCommand.InsertCommand
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.vaadin.signals.SignalCommand.KeyCondition
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.vaadin.signals.SignalCommand.LastUpdateCondition
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.vaadin.signals.SignalCommand.PositionCondition
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.vaadin.signals.SignalCommand.PutCommand
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.vaadin.signals.SignalCommand.PutIfAbsentCommand
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.vaadin.signals.SignalCommand.RemoveByKeyCommand
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.vaadin.signals.SignalCommand.RemoveCommand
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.vaadin.signals.SignalCommand.SetCommand
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.vaadin.signals.SignalCommand.SnapshotCommand
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.vaadin.signals.SignalCommand.TransactionCommand
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.vaadin.signals.SignalCommand.ValueCondition
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in class com.vaadin.signals.ValueSignal
- Error(String) - Constructor for record class com.vaadin.signals.operations.SignalOperation.Error
-
Creates an instance of a
Errorrecord class. - expectedChild() - Method in record class com.vaadin.signals.SignalCommand.KeyCondition
-
Returns the value of the
expectedChildrecord component. - expectedLastUpdate() - Method in record class com.vaadin.signals.SignalCommand.LastUpdateCondition
-
Returns the value of the
expectedLastUpdaterecord component. - expectedParentId() - Method in record class com.vaadin.signals.SignalCommand.RemoveCommand
-
Returns the value of the
expectedParentIdrecord component. - expectedValue() - Method in record class com.vaadin.signals.SignalCommand.ValueCondition
-
Returns the value of the
expectedValuerecord component. - extractValue(Node.Data) - Method in class com.vaadin.signals.AbstractSignal
-
Extracts the value for this signal from the given signal data node.
- extractValue(Node.Data) - Method in class com.vaadin.signals.impl.ComputedSignal
- extractValue(Node.Data) - Method in class com.vaadin.signals.ListSignal
- extractValue(Node.Data) - Method in class com.vaadin.signals.MapSignal
- extractValue(Node.Data) - Method in class com.vaadin.signals.NodeSignal
- extractValue(Node.Data) - Method in class com.vaadin.signals.ValueSignal
F
- fail(String) - Static method in interface com.vaadin.signals.impl.CommandResult
-
Creates a new rejected result with the given reason.
- first() - Static method in record class com.vaadin.signals.ListSignal.ListPosition
-
Gets the insertion position that corresponds to the beginning of the list.
- fromJson(JsonNode, Class<T>) - Static method in class com.vaadin.signals.AbstractSignal
-
Helper to convert the given JSON to a Java instance of the given type using the global signal object mapper.
G
- getCommands() - Method in class com.vaadin.signals.impl.CommandsAndHandlers
-
Gets an unmodifiable view of the commands.
- getCurrent() - Static method in class com.vaadin.signals.impl.Transaction
-
Gets the current transaction handler.
- getCurrentResultNotifier() - Static method in class com.vaadin.signals.SignalEnvironment
-
Queries currently active environments for an executor to use for notifying the results of an operation that is currently submitted.
- getDefaultEffectDispatcher() - Static method in class com.vaadin.signals.SignalEnvironment
-
Gets an executor that queries currently active environments for an executor to use for evaluating changes for an effect.
- getEffectDispatcher() - Method in class com.vaadin.signals.SignalEnvironment
-
Gets an executor to use for running the callback of an effect.
- getLock() - Method in class com.vaadin.signals.impl.SignalTree
-
Gets the lock that is used for protecting the integrity of this signal tree.
- getResultHandlers() - Method in class com.vaadin.signals.impl.CommandsAndHandlers
-
Gets an unmodifiable map of the result handlers.
- getResultNotifier() - Method in class com.vaadin.signals.SignalEnvironment
-
Gets an executor to use for asynchronously notifying about operation results.
- getWithLock(Supplier<T>) - Method in class com.vaadin.signals.impl.SignalTree
-
Runs a supplier while holding the lock and returns the provided value.
H
- hasChanges() - Method in interface com.vaadin.signals.impl.UsageTracker.Usage
-
Checks whether the used value has subsequently been changed.
- hashCode() - Method in record class com.vaadin.signals.Id
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.vaadin.signals.impl.CommandResult.Accept
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.vaadin.signals.impl.CommandResult.NodeModification
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.vaadin.signals.impl.CommandResult.Reject
-
Returns a hash code value for this object.
- hashCode() - Method in class com.vaadin.signals.ListSignal
- hashCode() - Method in record class com.vaadin.signals.ListSignal.ListPosition
-
Returns a hash code value for this object.
- hashCode() - Method in class com.vaadin.signals.MapSignal
- hashCode() - Method in record class com.vaadin.signals.Node.Alias
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.vaadin.signals.Node.Data
-
Returns a hash code value for this object.
- hashCode() - Method in class com.vaadin.signals.NodeSignal
- hashCode() - Method in class com.vaadin.signals.NumberSignal
- hashCode() - Method in record class com.vaadin.signals.operations.SignalOperation.Error
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.vaadin.signals.operations.SignalOperation.Result
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.vaadin.signals.SignalCommand.AdoptAsCommand
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.vaadin.signals.SignalCommand.AdoptAtCommand
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.vaadin.signals.SignalCommand.ClearCommand
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.vaadin.signals.SignalCommand.ClearOwnerCommand
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.vaadin.signals.SignalCommand.IncrementCommand
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.vaadin.signals.SignalCommand.InsertCommand
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.vaadin.signals.SignalCommand.KeyCondition
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.vaadin.signals.SignalCommand.LastUpdateCondition
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.vaadin.signals.SignalCommand.PositionCondition
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.vaadin.signals.SignalCommand.PutCommand
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.vaadin.signals.SignalCommand.PutIfAbsentCommand
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.vaadin.signals.SignalCommand.RemoveByKeyCommand
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.vaadin.signals.SignalCommand.RemoveCommand
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.vaadin.signals.SignalCommand.SetCommand
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.vaadin.signals.SignalCommand.SnapshotCommand
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.vaadin.signals.SignalCommand.TransactionCommand
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.vaadin.signals.SignalCommand.ValueCondition
-
Returns a hash code value for this object.
- hashCode() - Method in class com.vaadin.signals.ValueSignal
- hasLock() - Method in class com.vaadin.signals.impl.SignalTree
-
Checks whether the tree lock is currently held.
I
- id() - Method in class com.vaadin.signals.AbstractSignal
-
Gets the unique id of this signal instance.
- id() - Method in class com.vaadin.signals.impl.SignalTree
-
Gets the id of this signal tree.
- Id - Record Class in com.vaadin.signals
-
Generated identifier for signals and other related resources.
- Id(long) - Constructor for record class com.vaadin.signals.Id
-
Creates an instance of a
Idrecord class. - IN_MEMORY_EXCLUSIVE - Static variable in interface com.vaadin.signals.SignalFactory
-
A signal factory that always returns a new instance that is not shared.
- IN_MEMORY_SHARED - Static variable in interface com.vaadin.signals.SignalFactory
-
A signal factory that always returns the same signal for the same name within the same JVM.
- include(SignalTree, SignalCommand, Consumer<CommandResult>) - Method in class com.vaadin.signals.impl.Transaction
-
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.
- include(SignalTree, SignalCommand, Consumer<CommandResult>, boolean) - Method in class com.vaadin.signals.impl.StagedTransaction
- include(SignalTree, SignalCommand, Consumer<CommandResult>, boolean) - Method in class com.vaadin.signals.impl.Transaction
-
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.
- incrementBy(double) - Method in class com.vaadin.signals.NumberSignal
-
Atomically increments the value of this signal by the given delta amount.
- IncrementCommand(Id, Id, double) - Constructor for record class com.vaadin.signals.SignalCommand.IncrementCommand
-
Creates an instance of a
IncrementCommandrecord class. - insertAt(T, ListSignal.ListPosition) - Method in class com.vaadin.signals.ListSignal
-
Inserts a value at the given position in this list.
- insertChild(ListSignal.ListPosition) - Method in class com.vaadin.signals.NodeSignal
-
Inserts a new node with no value as a list node at the given list position.
- insertChildWithValue(Object, ListSignal.ListPosition) - Method in class com.vaadin.signals.NodeSignal
-
Inserts a new node with the given value as a list node at the given list position.
- InsertCommand(Id, Id, Id, JsonNode, ListSignal.ListPosition) - Constructor for record class com.vaadin.signals.SignalCommand.InsertCommand
-
Creates an instance of a
InsertCommandrecord class. - insertFirst(T) - Method in class com.vaadin.signals.ListSignal
-
Inserts a value as the first entry in this list.
- insertLast(T) - Method in class com.vaadin.signals.ListSignal
-
Inserts a value as the last entry in this list.
- InsertOperation<T> - Class in com.vaadin.signals.operations
-
An operation that inserts a new child signal into a list or map.
- InsertOperation(T) - Constructor for class com.vaadin.signals.operations.InsertOperation
-
Creates a new insert operation based on the new signal instance.
- inTransaction() - Static method in class com.vaadin.signals.impl.Transaction
-
Checks whether a transaction is currently active on the current thread.
- invoke(boolean) - Method in interface com.vaadin.signals.impl.TransientListener
-
Invoked when the next event occurs.
- isActive() - Static method in class com.vaadin.signals.impl.UsageTracker
-
Checks whether a usage tracker is currently active.
- isActive() - Method in class com.vaadin.signals.SignalEnvironment
-
Checks whether this environment is active on the current thread.
- isCancelled() - Method in class com.vaadin.signals.operations.CancelableOperation
-
Checks whether this operation has been canceled.
- isEmpty() - Method in class com.vaadin.signals.impl.CommandsAndHandlers
-
Checks whether there are any commands in this list.
- isValid(AbstractSignal<?>, SignalCommand) - Static method in class com.vaadin.signals.SignalUtils
-
Checks whether the given command is considered valid by the validator instance of the provided signal.
K
- key() - Method in record class com.vaadin.signals.SignalCommand.AdoptAsCommand
-
Returns the value of the
keyrecord component. - key() - Method in interface com.vaadin.signals.SignalCommand.KeyCommand
-
Gets the targeted map key.
- key() - Method in record class com.vaadin.signals.SignalCommand.KeyCondition
-
Returns the value of the
keyrecord component. - key() - Method in record class com.vaadin.signals.SignalCommand.PutCommand
-
Returns the value of the
keyrecord component. - key() - Method in record class com.vaadin.signals.SignalCommand.PutIfAbsentCommand
-
Returns the value of the
keyrecord component. - key() - Method in record class com.vaadin.signals.SignalCommand.RemoveByKeyCommand
-
Returns the value of the
keyrecord component. - KeyCondition(Id, Id, String, Id) - Constructor for record class com.vaadin.signals.SignalCommand.KeyCondition
-
Creates an instance of a
KeyConditionrecord class.
L
- last() - Static method in record class com.vaadin.signals.ListSignal.ListPosition
-
Gets the insertion position that corresponds to the end of the list.
- lastUpdate() - Method in record class com.vaadin.signals.Node.Data
-
Returns the value of the
lastUpdaterecord component. - LastUpdateCondition(Id, Id, Id) - Constructor for record class com.vaadin.signals.SignalCommand.LastUpdateCondition
-
Creates an instance of a
LastUpdateConditionrecord class. - list(String, Class<T>) - Method in interface com.vaadin.signals.SignalFactory
-
Gets a list signal with the given element type for the given name.
- listChildren() - Method in record class com.vaadin.signals.Node.Data
-
Returns the value of the
listChildrenrecord component. - listChildren() - Method in class com.vaadin.signals.NodeSignal.NodeSignalState
-
Gets a list with the children accessed by order.
- ListPosition(Id, Id) - Constructor for record class com.vaadin.signals.ListSignal.ListPosition
-
Creates an instance of a
ListPositionrecord class. - ListSignal<T> - Class in com.vaadin.signals
-
A signal containing a list of values.
- ListSignal(SignalTree, Id, Predicate<SignalCommand>, Class<T>) - Constructor for class com.vaadin.signals.ListSignal
-
Creates a new list signal instance with the given id and validator for the given signal tree with the given element type.
- ListSignal(Class<T>) - Constructor for class com.vaadin.signals.ListSignal
-
Creates a new list signal with the given element type.
- ListSignal.ListPosition - Record Class in com.vaadin.signals
-
A list insertion position before and/or after the referenced entries.
M
- map(String, Class<T>) - Method in interface com.vaadin.signals.SignalFactory
-
Gets a map signal with the given element type for the given name.
- map(Function<T, C>) - Method in interface com.vaadin.signals.Signal
-
Creates a simple computed signal based on a mapper function that is passed the value of this signal.
- mapChildren() - Method in record class com.vaadin.signals.Node.Data
-
Returns the value of the
mapChildrenrecord component. - mapChildren() - Method in class com.vaadin.signals.NodeSignal.NodeSignalState
-
Gets a map of the children accessed by key.
- mapIntValue(IntFunction<C>) - Method in class com.vaadin.signals.NumberSignal
-
Creates a computed signal based on an integer mapper function that is passed the value of this signal.
- MapSignal<T> - Class in com.vaadin.signals
-
A signal containing a map of values with string keys.
- MapSignal(SignalTree, Id, Predicate<SignalCommand>, Class<T>) - Constructor for class com.vaadin.signals.MapSignal
-
Creates a new map signal instance with the given id and validator for the given signal tree with the given element type.
- MapSignal(Class<T>) - Constructor for class com.vaadin.signals.MapSignal
-
Creates a new map signal with the given element type.
- markAsAborted() - Method in interface com.vaadin.signals.impl.SignalTree.PendingCommit
-
Sets the result of all pending changes as rejected.
- MAX - Static variable in record class com.vaadin.signals.Id
-
Special id value reserved for internal bookkeeping.
- mergeValidators(Predicate<SignalCommand>) - Method in class com.vaadin.signals.AbstractSignal
-
Merges the validator used by this signal with the given validator.
- modify(Consumer<T>) - Method in class com.vaadin.signals.ReferenceSignal
-
Runs the given callback to apply changes to a mutable referenced value and then notifies dependents.
- moveTo(AbstractSignal<T>, ListSignal.ListPosition) - Method in class com.vaadin.signals.ListSignal
-
Moves the given child signal to the given position in this list.
- MutableTreeRevision - Class in com.vaadin.signals.impl
-
A tree revision that can be mutated by applying signal commands.
- MutableTreeRevision(TreeRevision) - Constructor for class com.vaadin.signals.impl.MutableTreeRevision
-
Creates a new mutable tree revision as a copy of the provided base revision.
N
- newNode() - Method in record class com.vaadin.signals.impl.CommandResult.NodeModification
-
Returns the value of the
newNoderecord component. - NO_USAGE - Static variable in class com.vaadin.signals.impl.UsageTracker
-
A usage that doesn't have any changes and never fires any events.
- node(String) - Method in interface com.vaadin.signals.SignalFactory
-
Gets a node signal for the given name.
- Node - Interface in com.vaadin.signals
-
A node in a signal tree.
- Node.Alias - Record Class in com.vaadin.signals
-
A node alias.
- Node.Data - Record Class in com.vaadin.signals
-
A data node.
- NodeModification(Node, Node) - Constructor for record class com.vaadin.signals.impl.CommandResult.NodeModification
-
Creates an instance of a
NodeModificationrecord class. - nodes() - Method in class com.vaadin.signals.impl.TreeRevision
-
Gets the nodes that make up this revision.
- nodes() - Method in record class com.vaadin.signals.SignalCommand.SnapshotCommand
-
Returns the value of the
nodesrecord component. - NodeSignal - Class in com.vaadin.signals
-
A signal representing a node in a tree structure.
- NodeSignal() - Constructor for class com.vaadin.signals.NodeSignal
-
Creates a new empty node signal that serves as a root for a hierarchical node structure.
- NodeSignal(SignalTree, Id, Predicate<SignalCommand>) - Constructor for class com.vaadin.signals.NodeSignal
-
Creates a new node signal based on the given tree, node id and validator.
- NodeSignal.NodeSignalState - Class in com.vaadin.signals
-
The snapshot of the state of a node signal.
- NodeSignalState(JsonNode, NodeSignal, List<NodeSignal>, Map<String, NodeSignal>) - Constructor for class com.vaadin.signals.NodeSignal.NodeSignalState
-
Creates a new state snapshot based on the given JSON value, list children and map children.
- nodeValue(Node, Class<T>) - Static method in class com.vaadin.signals.AbstractSignal
-
Helper to convert the value of the given node into Java object of the given type.
- not(Signal<Boolean>) - Static method in interface com.vaadin.signals.Signal
-
Crates a new computed signal containing the negation of the provided boolean-valued signal.
- notifyObservers(Snapshot, Snapshot) - Method in class com.vaadin.signals.impl.SignalTree
-
Notify all observers that are affected by changes between two snapshots.
- notifyProcessedCommandSubscribers(List<SignalCommand>, Map<Id, CommandResult>) - Method in class com.vaadin.signals.impl.SignalTree
-
Notifies all subscribers after a command is processed.
- notifyResultHandlers(Map<Id, CommandResult>) - Method in class com.vaadin.signals.impl.CommandsAndHandlers
-
Notifies and removes result handlers for the given results.
- notifyResultHandlers(Map<Id, CommandResult>, List<SignalCommand>) - Method in class com.vaadin.signals.impl.CommandsAndHandlers
-
Notifies and removes result handlers for the given results in the given order.
- number(String) - Method in interface com.vaadin.signals.SignalFactory
-
Gets a number signal for the given name.
- number(String, double) - Method in interface com.vaadin.signals.SignalFactory
-
Gets a number signal for the given name and initializes it with the provided default value if the signal doesn't already have a value.
- NumberSignal - Class in com.vaadin.signals
-
A signal containing a numeric value.
- NumberSignal() - Constructor for class com.vaadin.signals.NumberSignal
-
Creates a new number signal with a zero value.
- NumberSignal(double) - Constructor for class com.vaadin.signals.NumberSignal
-
Creates a new number signal with the given value.
- NumberSignal(SignalTree, Id, Predicate<SignalCommand>) - Constructor for class com.vaadin.signals.NumberSignal
-
Creates a new number signal instance with the given id and validator for the given signal tree.
O
- observeNextChange(Id, TransientListener) - Method in class com.vaadin.signals.impl.SignalTree
-
Registers an observer for a node in this tree.
- ok() - Static method in interface com.vaadin.signals.impl.CommandResult
-
Creates a simple accepted result without modifications or original inserts.
- oldNode() - Method in record class com.vaadin.signals.impl.CommandResult.NodeModification
-
Returns the value of the
oldNoderecord component. - onlyUpdate() - Method in record class com.vaadin.signals.impl.CommandResult.Accept
-
Asserts that this result contains exactly one modification and returns it.
- onNextChange(TransientListener) - Method in interface com.vaadin.signals.impl.UsageTracker.Usage
-
Registers a listener that will be invoked the next time there's a change to the used value.
- originalInserts() - Method in record class com.vaadin.signals.impl.CommandResult.Accept
-
Returns the value of the
originalInsertsrecord component. - originalInserts() - Method in class com.vaadin.signals.impl.TreeRevision
-
Gets a map of signal commands for creating any nodes owned by this tree.
- ownerId() - Method in class com.vaadin.signals.impl.TreeRevision
-
Gets the id of the tree that this revision belongs to.
- ownerId() - Method in record class com.vaadin.signals.SignalCommand.ClearOwnerCommand
-
Returns the value of the
ownerIdrecord component.
P
- parent() - Method in record class com.vaadin.signals.Node.Data
-
Returns the value of the
parentrecord component. - parent() - Method in class com.vaadin.signals.NodeSignal.NodeSignalState
-
Gets the parent node of this signal.
- parse(String) - Static method in record class com.vaadin.signals.Id
-
Parses the given base64 string as an id.
- peek() - Method in class com.vaadin.signals.AbstractSignal
- peek() - Method in class com.vaadin.signals.impl.ComputedSignal
- peek() - Method in class com.vaadin.signals.ReferenceSignal
- peek() - Method in interface com.vaadin.signals.Signal
-
Reads the value without setting up any dependencies.
- peekConfirmed() - Method in class com.vaadin.signals.AbstractSignal
-
Reads the confirmed value without setting up any dependencies.
- peekConfirmed() - Method in class com.vaadin.signals.impl.ComputedSignal
- position() - Method in record class com.vaadin.signals.SignalCommand.AdoptAtCommand
-
Returns the value of the
positionrecord component. - position() - Method in record class com.vaadin.signals.SignalCommand.InsertCommand
-
Returns the value of the
positionrecord component. - position() - Method in record class com.vaadin.signals.SignalCommand.PositionCondition
-
Returns the value of the
positionrecord component. - PositionCondition(Id, Id, Id, ListSignal.ListPosition) - Constructor for record class com.vaadin.signals.SignalCommand.PositionCondition
-
Creates an instance of a
PositionConditionrecord class. - prepareCommit(CommandsAndHandlers) - Method in class com.vaadin.signals.impl.AsynchronousSignalTree
- prepareCommit(CommandsAndHandlers) - Method in class com.vaadin.signals.impl.SignalTree
-
Starts the process of committing a set of changes.
- prepareCommit(CommandsAndHandlers) - Method in class com.vaadin.signals.impl.SynchronousSignalTree
- publishChanges() - Method in interface com.vaadin.signals.impl.SignalTree.PendingCommit
-
Notifies dependents and updates all result listeners based on the pending changes.
- put(String, T) - Method in class com.vaadin.signals.MapSignal
-
Associates the given value with the given key.
- putChildIfAbsent(String) - Method in class com.vaadin.signals.NodeSignal
-
Creates a new node with no value if a map node with the given key doesn't already exist.
- putChildWithValue(String, Object) - Method in class com.vaadin.signals.NodeSignal
-
Associates the given value with the given key.
- PutCommand(Id, Id, String, JsonNode) - Constructor for record class com.vaadin.signals.SignalCommand.PutCommand
-
Creates an instance of a
PutCommandrecord class. - putIfAbsent(String, T) - Method in class com.vaadin.signals.MapSignal
-
Creates a new entry with the given value if an entry with the given key doesn't already exist.
- PutIfAbsentCommand(Id, Id, Id, String, JsonNode) - Constructor for record class com.vaadin.signals.SignalCommand.PutIfAbsentCommand
-
Creates an instance of a
PutIfAbsentCommandrecord class.
R
- random() - Static method in record class com.vaadin.signals.Id
-
Creates a random id.
- read(SignalTree) - Method in class com.vaadin.signals.impl.StagedTransaction
- read(SignalTree) - Method in class com.vaadin.signals.impl.Transaction
-
Gets a revision for reading from the given tree in the context of this transaction.
- reason() - Method in record class com.vaadin.signals.impl.CommandResult.Reject
-
Returns the value of the
reasonrecord component. - reason() - Method in record class com.vaadin.signals.operations.SignalOperation.Error
-
Returns the value of the
reasonrecord component. - ReferenceSignal<T> - Class in com.vaadin.signals
-
A writable signal that holds a reference to an object.
- ReferenceSignal() - Constructor for class com.vaadin.signals.ReferenceSignal
- ReferenceSignal(T) - Constructor for class com.vaadin.signals.ReferenceSignal
- register(SignalEnvironment) - Static method in class com.vaadin.signals.SignalEnvironment
-
Registers a signal environment to consider when processing signal operations.
- registerUsage(UsageTracker.Usage) - Static method in class com.vaadin.signals.impl.UsageTracker
-
Registers a usage with the current usage tracker.
- Reject(String) - Constructor for record class com.vaadin.signals.impl.CommandResult.Reject
-
Creates an instance of a
Rejectrecord class. - rejectAll(Map<Id, CommandResult>, String) - Static method in interface com.vaadin.signals.impl.CommandResult
-
Creates a copy of the given map of command results where all accepted results are replaced with the same rejection.
- remove(AbstractSignal<?>) - Method in class com.vaadin.signals.AbstractSignal
-
Helper to submit a remove command.
- remove(ValueSignal<T>) - Method in class com.vaadin.signals.ListSignal
-
Removes the given child from this list.
- remove(String) - Method in class com.vaadin.signals.MapSignal
-
Removes the mapping for the given key.
- remove(String) - Method in interface com.vaadin.signals.SignalFactory
-
Removes any previous association for the given name.
- RemoveByKeyCommand(Id, Id, String) - Constructor for record class com.vaadin.signals.SignalCommand.RemoveByKeyCommand
-
Creates an instance of a
RemoveByKeyCommandrecord class. - removeChild(NodeSignal) - Method in class com.vaadin.signals.NodeSignal
-
Removes the given child from this node.
- removeChild(String) - Method in class com.vaadin.signals.NodeSignal
-
Removes the map child with the given key.
- RemoveCommand(Id, Id, Id) - Constructor for record class com.vaadin.signals.SignalCommand.RemoveCommand
-
Creates an instance of a
RemoveCommandrecord class. - removeHandledCommands(Collection<Id>) - Method in class com.vaadin.signals.impl.CommandsAndHandlers
-
Removes commands based on a collection of handled commands.
- replace(T, T) - Method in class com.vaadin.signals.ReferenceSignal
-
Sets the value of this signal if and only if the signal has the expected value at the time when the operation is confirmed.
- replace(T, T) - Method in class com.vaadin.signals.ValueSignal
- replace(T, T) - Method in interface com.vaadin.signals.WritableSignal
-
Sets the value of this signal if and only if the signal has the expected value at the time when the operation is confirmed.
- result() - Method in class com.vaadin.signals.operations.SignalOperation
-
Gets the eventual operation result.
- Result(T) - Constructor for record class com.vaadin.signals.operations.SignalOperation.Result
-
Creates an instance of a
Resultrecord class. - returnValue() - Method in class com.vaadin.signals.operations.TransactionOperation
-
Gets the return value from the transaction callback.
- rollback() - Method in class com.vaadin.signals.impl.StagedTransaction
- rollback() - Method in class com.vaadin.signals.impl.Transaction
-
Rolls back any staged commands in this transaction and notifies the result handlers for those commands.
- runInTransaction(Runnable) - Static method in class com.vaadin.signals.impl.Transaction
-
Runs the given task in a regular transaction and returns an operation object without a value.
- runInTransaction(Runnable) - Static method in interface com.vaadin.signals.Signal
-
Runs the provided runnable in a transaction.
- runInTransaction(Runnable, Transaction.Type) - Static method in class com.vaadin.signals.impl.Transaction
-
Runs the given task in a transaction of the given type and returns an operation object without a value.
- runInTransaction(Supplier<T>) - Static method in class com.vaadin.signals.impl.Transaction
-
Runs the given supplier in a regular transaction and returns an operation object that wraps the supplier value.
- runInTransaction(Supplier<T>) - Static method in interface com.vaadin.signals.Signal
-
Runs the provided supplier in a transaction.
- runInTransaction(Supplier<T>, Transaction.Type) - Static method in class com.vaadin.signals.impl.Transaction
-
Runs the given supplier in a transaction of the given type and returns an operation object that wraps the supplier value.
- runWithLock(Runnable) - Method in class com.vaadin.signals.impl.SignalTree
-
Runs an action while holding the lock.
- runWithoutTransaction(Runnable) - Static method in class com.vaadin.signals.impl.Transaction
-
Runs the given task outside any transaction.
- runWithoutTransaction(Runnable) - Static method in interface com.vaadin.signals.Signal
-
Runs the given task outside any transaction.
- runWithoutTransaction(Supplier<T>) - Static method in class com.vaadin.signals.impl.Transaction
-
Runs the given supplier outside any transaction and returns the supplied value.
- runWithoutTransaction(Supplier<T>) - Static method in interface com.vaadin.signals.Signal
-
Runs the given supplier outside any transaction and returns the supplied value.
S
- scopeOwner() - Method in record class com.vaadin.signals.Node.Data
-
Returns the value of the
scopeOwnerrecord component. - scopeOwner() - Method in record class com.vaadin.signals.SignalCommand.InsertCommand
-
Returns the value of the
scopeOwnerrecord component. - scopeOwner() - Method in record class com.vaadin.signals.SignalCommand.PutIfAbsentCommand
-
Returns the value of the
scopeOwnerrecord component. - scopeOwner() - Method in interface com.vaadin.signals.SignalCommand.ScopeOwnerCommand
-
The owner id.
- SetCommand(Id, Id, JsonNode) - Constructor for record class com.vaadin.signals.SignalCommand.SetCommand
-
Creates an instance of a
SetCommandrecord class. - signal() - Method in class com.vaadin.signals.operations.InsertOperation
-
Gets the newly inserted signal instance.
- Signal<T> - Interface in com.vaadin.signals
-
A signal is a reactive value holder with automatic subscription and unsubscription of listeners.
- SignalCommand - Interface in com.vaadin.signals
-
A command triggered from a signal.
- SignalCommand.AdoptAsCommand - Record Class in com.vaadin.signals
-
Adopts the given node as a child with the given key.
- SignalCommand.AdoptAtCommand - Record Class in com.vaadin.signals
-
Adopts the given node as a child at the given insertion position.
- SignalCommand.ClearCommand - Record Class in com.vaadin.signals
-
Removes all children from the target node.
- SignalCommand.ClearOwnerCommand - Record Class in com.vaadin.signals
-
Removes all nodes that have its scope owner set as the given id.
- SignalCommand.ConditionCommand - Interface in com.vaadin.signals
-
A signal command that doesn't apply any change but only performs a test that will be part of determining whether a transaction passes.
- SignalCommand.GlobalCommand - Interface in com.vaadin.signals
-
A signal command that doesn't target a specific node.
- SignalCommand.IncrementCommand - Record Class in com.vaadin.signals
-
Increments the value of the given node by the given delta.
- SignalCommand.InsertCommand - Record Class in com.vaadin.signals
-
Inserts a new node with the given value at the given list insert position.
- SignalCommand.KeyCommand - Interface in com.vaadin.signals
-
A signal command that targets a map entry by key.
- SignalCommand.KeyCondition - Record Class in com.vaadin.signals
-
Tests whether the given node has the expected child for a specific map key.
- SignalCommand.LastUpdateCondition - Record Class in com.vaadin.signals
-
Tests that the given node was last updated by the command with the given id.
- SignalCommand.PositionCondition - Record Class in com.vaadin.signals
-
Tests whether the given node has a given child at a given position.
- SignalCommand.PutCommand - Record Class in com.vaadin.signals
-
Stores the given value in a child node with the given key.
- SignalCommand.PutIfAbsentCommand - Record Class in com.vaadin.signals
-
Stores the given value in a child node with the given key if it doesn't already exist.
- SignalCommand.RemoveByKeyCommand - Record Class in com.vaadin.signals
-
Removes the child with the given key, if present.
- SignalCommand.RemoveCommand - Record Class in com.vaadin.signals
-
Removes the given node from its parent, optionally verifying that the parent is as expected.
- SignalCommand.ScopeOwnerCommand - Interface in com.vaadin.signals
-
A signal command that creates a new signal node that might have an owner.
- SignalCommand.SetCommand - Record Class in com.vaadin.signals
-
Sets the value of the given node.
- SignalCommand.SnapshotCommand - Record Class in com.vaadin.signals
-
Initializes a tree based on a collection of pre-existing nodes.
- SignalCommand.TransactionCommand - Record Class in com.vaadin.signals
-
A sequence of commands that should be applied atomically and only if all commands are individually accepted.
- SignalCommand.ValueCommand - Interface in com.vaadin.signals
-
A signal command that sets the value of a signal.
- SignalCommand.ValueCondition - Record Class in com.vaadin.signals
-
Tests whether the given node has the expected value, based on JSON equality.
- SignalEnvironment - Class in com.vaadin.signals
-
The context in which signal operations are processed.
- SignalEnvironment() - Constructor for class com.vaadin.signals.SignalEnvironment
-
Creates a new signal environment.
- SignalFactory - Interface in com.vaadin.signals
-
Provides a signal instance based on a name.
- SignalOperation<T> - Class in com.vaadin.signals.operations
-
An operation triggered on a signal instance.
- SignalOperation() - Constructor for class com.vaadin.signals.operations.SignalOperation
-
Creates a new signal operation that will get a result later.
- SignalOperation(SignalOperation.ResultOrError<T>) - Constructor for class com.vaadin.signals.operations.SignalOperation
-
Creates a new signal operation that already has a result.
- SignalOperation.Error<T> - Record Class in com.vaadin.signals.operations
-
A failed signal operation result.
- SignalOperation.Result<T> - Record Class in com.vaadin.signals.operations
-
A successful signal operation result.
- SignalOperation.ResultOrError<T> - Interface in com.vaadin.signals.operations
-
The result of a signal operation.
- SignalTree - Class in com.vaadin.signals.impl
-
Provides thread-safe access to a tree of signal nodes and a way of listening for changes to those nodes.
- SignalTree(SignalTree.Type) - Constructor for class com.vaadin.signals.impl.SignalTree
-
Creates a new signal tree with the given type.
- SignalTree.PendingCommit - Interface in com.vaadin.signals.impl
-
Collection of callbacks representing the possible stages when committing a transaction.
- SignalTree.Type - Enum Class in com.vaadin.signals.impl
-
The tree type, used to determine how different tree instances can be combined in a transaction.
- SignalUtils - Class in com.vaadin.signals
-
Utility class for accessing/using signals internal API.
- Snapshot - Class in com.vaadin.signals.impl
-
An immutable tree revision.
- Snapshot(Id, boolean) - Constructor for class com.vaadin.signals.impl.Snapshot
-
Creates an empty snapshot.
- Snapshot(MutableTreeRevision) - Constructor for class com.vaadin.signals.impl.Snapshot
-
Creates a new snapshot from a mutable tree revision.
- SnapshotCommand(Id, Map<Id, Node>) - Constructor for record class com.vaadin.signals.SignalCommand.SnapshotCommand
-
Creates an instance of a
SnapshotCommandrecord class. - STAGED - Enum constant in enum class com.vaadin.signals.impl.Transaction.Type
-
A conventional read-write transaction that stages commands to be submitted as a single commit.
- StagedTransaction - Class in com.vaadin.signals.impl
-
A conventional read-write transaction that stages commands to be submitted as a single commit.
- StagedTransaction(Transaction) - Constructor for class com.vaadin.signals.impl.StagedTransaction
-
Creates a new staged transaction for the given outer transaction.
- submit(SignalCommand) - Method in class com.vaadin.signals.AbstractSignal
-
Submits a command for this signal and updates the created operation without a value once the command result is confirmed.
- submit(SignalCommand, Function<CommandResult.Accept, R>) - Method in class com.vaadin.signals.AbstractSignal
-
Submits a command for this signal and uses the provided result converter to updates the created operation once the command result is confirmed.
- submit(SignalCommand, Function<CommandResult.Accept, R>, O) - Method in class com.vaadin.signals.AbstractSignal
-
Submits a command for this signal and updates the given operation using the given result converter once the command result is confirmed.
- submit(List<SignalCommand>) - Method in class com.vaadin.signals.impl.AsynchronousSignalTree
-
Submits a sequence of commands to the event log.
- submitInsert(SignalCommand, Function<Id, I>) - Method in class com.vaadin.signals.AbstractSignal
-
Submits a command for this signal and creates and insert operation that is updated once the command result is confirmed.
- submitted() - Method in class com.vaadin.signals.impl.AsynchronousSignalTree
- submitted() - Method in class com.vaadin.signals.impl.SignalTree
-
Gets the current snapshot based on all confirmed and submitted commands.
- submitted() - Method in class com.vaadin.signals.impl.SynchronousSignalTree
- submitVoidOperation(SignalCommand, O) - Method in class com.vaadin.signals.AbstractSignal
-
Submits a command for this signal and updates the given operation without a value once the command result is confirmed.
- subscribeToProcessed(BiConsumer<SignalCommand, CommandResult>) - Method in class com.vaadin.signals.impl.SignalTree
-
Registers a callback that is executed after commands are processed (regardless of acceptance or rejection).
- successful() - Method in record class com.vaadin.signals.operations.SignalOperation.Error
- successful() - Method in record class com.vaadin.signals.operations.SignalOperation.Result
- successful() - Method in interface com.vaadin.signals.operations.SignalOperation.ResultOrError
-
Checks whether this instance represents successfully applied signal operation.
- SYNCHRONOUS - Enum constant in enum class com.vaadin.signals.impl.SignalTree.Type
-
Synchronous trees can confirm the status of applied commands while the tree is locked which makes it possible for multiple sync trees to participate in the same transaction.
- SynchronousSignalTree - Class in com.vaadin.signals.impl
-
A signal tree that immediately confirms commands without waiting for an external system to determine command ordering.
- SynchronousSignalTree(boolean) - Constructor for class com.vaadin.signals.impl.SynchronousSignalTree
-
Creates a new synchronous signal tree.
T
- target() - Method in record class com.vaadin.signals.Node.Alias
-
Returns the value of the
targetrecord component. - targetNodeId() - Method in record class com.vaadin.signals.SignalCommand.AdoptAsCommand
-
Returns the value of the
targetNodeIdrecord component. - targetNodeId() - Method in record class com.vaadin.signals.SignalCommand.AdoptAtCommand
-
Returns the value of the
targetNodeIdrecord component. - targetNodeId() - Method in record class com.vaadin.signals.SignalCommand.ClearCommand
-
Returns the value of the
targetNodeIdrecord component. - targetNodeId() - Method in interface com.vaadin.signals.SignalCommand.GlobalCommand
- targetNodeId() - Method in record class com.vaadin.signals.SignalCommand.IncrementCommand
-
Returns the value of the
targetNodeIdrecord component. - targetNodeId() - Method in record class com.vaadin.signals.SignalCommand.InsertCommand
-
Returns the value of the
targetNodeIdrecord component. - targetNodeId() - Method in record class com.vaadin.signals.SignalCommand.KeyCondition
-
Returns the value of the
targetNodeIdrecord component. - targetNodeId() - Method in record class com.vaadin.signals.SignalCommand.LastUpdateCondition
-
Returns the value of the
targetNodeIdrecord component. - targetNodeId() - Method in record class com.vaadin.signals.SignalCommand.PositionCondition
-
Returns the value of the
targetNodeIdrecord component. - targetNodeId() - Method in record class com.vaadin.signals.SignalCommand.PutCommand
-
Returns the value of the
targetNodeIdrecord component. - targetNodeId() - Method in record class com.vaadin.signals.SignalCommand.PutIfAbsentCommand
-
Returns the value of the
targetNodeIdrecord component. - targetNodeId() - Method in record class com.vaadin.signals.SignalCommand.RemoveByKeyCommand
-
Returns the value of the
targetNodeIdrecord component. - targetNodeId() - Method in record class com.vaadin.signals.SignalCommand.RemoveCommand
-
Returns the value of the
targetNodeIdrecord component. - targetNodeId() - Method in record class com.vaadin.signals.SignalCommand.SetCommand
-
Returns the value of the
targetNodeIdrecord component. - targetNodeId() - Method in interface com.vaadin.signals.SignalCommand
-
Gets the id of the signal node that is targeted by this command.
- targetNodeId() - Method in record class com.vaadin.signals.SignalCommand.ValueCondition
-
Returns the value of the
targetNodeIdrecord component. - toJson(Object) - Static method in class com.vaadin.signals.AbstractSignal
-
Helper to convert the given object to JSON using the global signal object mapper.
- toString() - Method in record class com.vaadin.signals.Id
-
Returns a string representation of this record class.
- toString() - Method in record class com.vaadin.signals.impl.CommandResult.Accept
-
Returns a string representation of this record class.
- toString() - Method in record class com.vaadin.signals.impl.CommandResult.NodeModification
-
Returns a string representation of this record class.
- toString() - Method in record class com.vaadin.signals.impl.CommandResult.Reject
-
Returns a string representation of this record class.
- toString() - Method in record class com.vaadin.signals.ListSignal.ListPosition
-
Returns a string representation of this record class.
- toString() - Method in class com.vaadin.signals.ListSignal
- toString() - Method in class com.vaadin.signals.MapSignal
- toString() - Method in record class com.vaadin.signals.Node.Alias
-
Returns a string representation of this record class.
- toString() - Method in record class com.vaadin.signals.Node.Data
-
Returns a string representation of this record class.
- toString() - Method in class com.vaadin.signals.NodeSignal
- toString() - Method in class com.vaadin.signals.NumberSignal
- toString() - Method in record class com.vaadin.signals.operations.SignalOperation.Error
-
Returns a string representation of this record class.
- toString() - Method in record class com.vaadin.signals.operations.SignalOperation.Result
-
Returns a string representation of this record class.
- toString() - Method in record class com.vaadin.signals.SignalCommand.AdoptAsCommand
-
Returns a string representation of this record class.
- toString() - Method in record class com.vaadin.signals.SignalCommand.AdoptAtCommand
-
Returns a string representation of this record class.
- toString() - Method in record class com.vaadin.signals.SignalCommand.ClearCommand
-
Returns a string representation of this record class.
- toString() - Method in record class com.vaadin.signals.SignalCommand.ClearOwnerCommand
-
Returns a string representation of this record class.
- toString() - Method in record class com.vaadin.signals.SignalCommand.IncrementCommand
-
Returns a string representation of this record class.
- toString() - Method in record class com.vaadin.signals.SignalCommand.InsertCommand
-
Returns a string representation of this record class.
- toString() - Method in record class com.vaadin.signals.SignalCommand.KeyCondition
-
Returns a string representation of this record class.
- toString() - Method in record class com.vaadin.signals.SignalCommand.LastUpdateCondition
-
Returns a string representation of this record class.
- toString() - Method in record class com.vaadin.signals.SignalCommand.PositionCondition
-
Returns a string representation of this record class.
- toString() - Method in record class com.vaadin.signals.SignalCommand.PutCommand
-
Returns a string representation of this record class.
- toString() - Method in record class com.vaadin.signals.SignalCommand.PutIfAbsentCommand
-
Returns a string representation of this record class.
- toString() - Method in record class com.vaadin.signals.SignalCommand.RemoveByKeyCommand
-
Returns a string representation of this record class.
- toString() - Method in record class com.vaadin.signals.SignalCommand.RemoveCommand
-
Returns a string representation of this record class.
- toString() - Method in record class com.vaadin.signals.SignalCommand.SetCommand
-
Returns a string representation of this record class.
- toString() - Method in record class com.vaadin.signals.SignalCommand.SnapshotCommand
-
Returns a string representation of this record class.
- toString() - Method in record class com.vaadin.signals.SignalCommand.TransactionCommand
-
Returns a string representation of this record class.
- toString() - Method in record class com.vaadin.signals.SignalCommand.ValueCondition
-
Returns a string representation of this record class.
- toString() - Method in class com.vaadin.signals.ValueSignal
- track(Runnable) - Static method in class com.vaadin.signals.impl.UsageTracker
-
Runs the given task while collecting all cases where a managed value is used.
- track(Runnable, Consumer<UsageTracker.Usage>) - Static method in class com.vaadin.signals.impl.UsageTracker
-
Runs the given task while reacting to all cases where a managed value is used.
- Transaction - Class in com.vaadin.signals.impl
-
A context for running commands that might be related to each other.
- Transaction() - Constructor for class com.vaadin.signals.impl.Transaction
-
Creates a new transaction.
- Transaction.Type - Enum Class in com.vaadin.signals.impl
-
The type of a transaction, determining how it handles reads and writes.
- TransactionCommand(Id, List<SignalCommand>) - Constructor for record class com.vaadin.signals.SignalCommand.TransactionCommand
-
Creates an instance of a
TransactionCommandrecord class. - TransactionOperation<T> - Class in com.vaadin.signals.operations
-
A signal operation representing a transaction and the return value from the transaction callback.
- TransactionOperation(T) - Constructor for class com.vaadin.signals.operations.TransactionOperation
-
Creates a new transaction operation with the provided return value.
- TransientListener - Interface in com.vaadin.signals.impl
-
A listener that is expected to only be invoked the next time some event occurs but not for subsequent events.
- tree() - Method in class com.vaadin.signals.AbstractSignal
-
Gets the signal tree that stores the value for this signal.
- treeOf(AbstractSignal<?>) - Static method in class com.vaadin.signals.SignalUtils
-
Returns the underlying
SignalTreeinstance of the given signal. - TreeRevision - Class in com.vaadin.signals.impl
-
A revision of a signal tree.
- TreeRevision(Id, Map<Id, Node>, Map<Id, SignalCommand.ScopeOwnerCommand>) - Constructor for class com.vaadin.signals.impl.TreeRevision
-
Creates a new revision based on the given owner id, map of signal nodes and map of original inserts.
- type() - Method in class com.vaadin.signals.impl.SignalTree
-
Gets the type of this signal tree.
U
- untracked(Supplier<T>) - Static method in class com.vaadin.signals.impl.UsageTracker
-
Runs the given supplier without tracking usage even if a usage tracker is active.
- untracked(Supplier<T>) - Static method in interface com.vaadin.signals.Signal
-
Runs the given supplier without tracking dependencies for signals that are read within the supplier.
- update(UnaryOperator<T>) - Method in class com.vaadin.signals.ReferenceSignal
-
Updates the signal value based on the given callback.
- update(UnaryOperator<T>) - Method in class com.vaadin.signals.ValueSignal
- update(UnaryOperator<T>) - Method in interface com.vaadin.signals.WritableSignal
-
Updates the signal value based on the given callback.
- updates() - Method in record class com.vaadin.signals.impl.CommandResult.Accept
-
Returns the value of the
updatesrecord component. - usageChangeValue(Node.Data) - Method in class com.vaadin.signals.AbstractSignal
-
Gets a reference value that will be used to determine whether a dependency based on previous usage should be invalidated.
- usageChangeValue(Node.Data) - Method in class com.vaadin.signals.impl.ComputedSignal
- usageChangeValue(Node.Data) - Method in class com.vaadin.signals.ListSignal
- usageChangeValue(Node.Data) - Method in class com.vaadin.signals.MapSignal
- usageChangeValue(Node.Data) - Method in class com.vaadin.signals.NodeSignal
- usageChangeValue(Node.Data) - Method in class com.vaadin.signals.ValueSignal
- UsageTracker - Class in com.vaadin.signals.impl
-
Tracks signal value read operations while a task is run.
- UsageTracker.Usage - Interface in com.vaadin.signals.impl
-
Tracks the state of some used value.
V
- validator() - Method in class com.vaadin.signals.AbstractSignal
-
Gets the validator used by this signal instance.
- value() - Method in class com.vaadin.signals.AbstractSignal
- value() - Method in record class com.vaadin.signals.Id
-
Returns the value of the
valuerecord component. - value() - Method in record class com.vaadin.signals.Node.Data
-
Returns the value of the
valuerecord component. - value() - Method in class com.vaadin.signals.NumberSignal
- value() - Method in record class com.vaadin.signals.operations.SignalOperation.Result
-
Returns the value of the
valuerecord component. - value() - Method in class com.vaadin.signals.ReferenceSignal
- value() - Method in interface com.vaadin.signals.Signal
-
Gets the current value of this signal.
- value() - Method in record class com.vaadin.signals.SignalCommand.InsertCommand
-
Returns the value of the
valuerecord component. - value() - Method in record class com.vaadin.signals.SignalCommand.PutCommand
-
Returns the value of the
valuerecord component. - value() - Method in record class com.vaadin.signals.SignalCommand.PutIfAbsentCommand
-
Returns the value of the
valuerecord component. - value() - Method in record class com.vaadin.signals.SignalCommand.SetCommand
-
Returns the value of the
valuerecord component. - value() - Method in interface com.vaadin.signals.SignalCommand.ValueCommand
-
Gets the JSON node with the value to set.
- value(int) - Method in class com.vaadin.signals.NumberSignal
-
Sets the value of this signal as an integer.
- value(Class<T>) - Method in class com.vaadin.signals.NodeSignal.NodeSignalState
-
Gets the value as the given type.
- value(String, Class<T>) - Method in interface com.vaadin.signals.SignalFactory
-
Gets a value signal of the given type for the given name.
- value(String, Class<T>, T) - Method in interface com.vaadin.signals.SignalFactory
-
Gets a value signal of the given type for the given name and initializes it with the provided default value if the signal doesn't already have a value.
- value(String, T) - Method in interface com.vaadin.signals.SignalFactory
-
Gets a value signal for the given name and initializes it with the provided default value if the signal doesn't already have a value.
- value(T) - Method in class com.vaadin.signals.ReferenceSignal
- value(T) - Method in class com.vaadin.signals.ValueSignal
- value(T) - Method in interface com.vaadin.signals.WritableSignal
-
Sets the value of this signal.
- valueAsInt() - Method in class com.vaadin.signals.NumberSignal
-
Gets the value of this signal as an integer.
- ValueCondition(Id, Id, JsonNode) - Constructor for record class com.vaadin.signals.SignalCommand.ValueCondition
-
Creates an instance of a
ValueConditionrecord class. - valueOf(String) - Static method in enum class com.vaadin.signals.impl.SignalTree.Type
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.vaadin.signals.impl.Transaction.Type
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class com.vaadin.signals.impl.SignalTree.Type
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.vaadin.signals.impl.Transaction.Type
-
Returns an array containing the constants of this enum class, in the order they are declared.
- ValueSignal<T> - Class in com.vaadin.signals
-
A signal containing a value.
- ValueSignal(SignalTree, Id, Predicate<SignalCommand>, Class<T>) - Constructor for class com.vaadin.signals.ValueSignal
-
Creates a new value signal instance with the given id and validator for the given signal tree with the given value type.
- ValueSignal(Class<T>) - Constructor for class com.vaadin.signals.ValueSignal
-
Creates a new value signal of the given type with no value.
- ValueSignal(T) - Constructor for class com.vaadin.signals.ValueSignal
-
Creates a new value signal with the given initial value.
- verifyChild(AbstractSignal<?>) - Method in class com.vaadin.signals.ListSignal
-
Checks that the given signal is a child in this list.
- verifyHasKey(String) - Method in class com.vaadin.signals.MapSignal
-
Checks that there is a mapping for the given key in this map.
- verifyKey(String, AbstractSignal<?>) - Method in class com.vaadin.signals.MapSignal
-
Checks that the given child is mapped to the given key in this map.
- verifyKeyAbsent(String) - Method in class com.vaadin.signals.MapSignal
-
Checks that there is no mapping for the given key in this map.
- verifyPosition(AbstractSignal<?>, ListSignal.ListPosition) - Method in class com.vaadin.signals.ListSignal
-
Checks that the given child is at the given position in this list.
- verifyValue(T) - Method in class com.vaadin.signals.ValueSignal
-
Checks that this signal has the expected value.
W
- withValidator(Predicate<SignalCommand>) - Method in class com.vaadin.signals.ListSignal
-
Wraps this signal with a validator.
- withValidator(Predicate<SignalCommand>) - Method in class com.vaadin.signals.MapSignal
-
Wraps this signal with a validator.
- withValidator(Predicate<SignalCommand>) - Method in class com.vaadin.signals.NodeSignal
-
Wraps this signal with a validator.
- withValidator(Predicate<SignalCommand>) - Method in class com.vaadin.signals.NumberSignal
-
Wraps this signal with a validator.
- withValidator(Predicate<SignalCommand>) - Method in class com.vaadin.signals.ValueSignal
-
Wraps this signal with a validator.
- wrapWithLock(Runnable) - Method in class com.vaadin.signals.impl.SignalTree
-
Wraps the provided action to run it while holding the lock.
- WritableSignal<T> - Interface in com.vaadin.signals
-
A signal to which a new value can be directly written.
- WRITE_THROUGH - Enum constant in enum class com.vaadin.signals.impl.Transaction.Type
-
A transaction that applies commands immediately to the underlying tree while providing repeatable reads that are updated by changes from applied commands.
Z
- ZERO - Static variable in record class com.vaadin.signals.Id
-
Default or initial id in various contexts.
All Classes and Interfaces|All Packages|Serialized Form