Package com.vaadin.flow.signals.shared

Class SharedNodeSignal.SharedNodeSignalState

java.lang.Object
com.vaadin.flow.signals.shared.SharedNodeSignal.SharedNodeSignalState
All Implemented Interfaces:
Serializable
Enclosing class:
SharedNodeSignal
public static class SharedNodeSignal.SharedNodeSignalState extends Object implements Serializable
The snapshot of the state of a node signal. Gives access to the value and child nodes.
See Also:

  • Constructor Details

    • SharedNodeSignalState

      public SharedNodeSignalState(@Nullable tools.jackson.databind.JsonNode value, @Nullable SharedNodeSignal parent, List<SharedNodeSignal> listChildren, Map<String,SharedNodeSignal> mapChildren)
      Creates a new state snapshot based on the given JSON value, list children and map children.
      Parameters:
      value - the JSON value, or null if there is no value
      parent - the parent node, or null for the value of the root node
      listChildren - a list of children accessed by order, or an empty list if there are no list children. Not null.
      mapChildren - a map of children access by key, or an empty map if there are no map children. Not null.

  • Method Details

    • value

      public <T> @Nullable T value(Class<T> valueType)
      Gets the value as the given type.
      Type Parameters:
      T - the value type
      Parameters:
      valueType - the value type, not null
      Returns:
      the value, or null if there is no value

    • parent

      public @Nullable SharedNodeSignal parent()
      Gets the parent node of this signal.
      Returns:
      the parent node, or null for the root node

    • listChildren

      public List<SharedNodeSignal> listChildren()
      Gets a list with the children accessed by order.
      Returns:
      a list of children, not null

    • mapChildren

      public Map<String,SharedNodeSignal> mapChildren()
      Gets a map of the children accessed by key.
      Returns:
      a map of children, not null