com.vaadin.flow.internal.nodefeature.ServerSideFeature API 24.6.4 | Vaadin

com.vaadin.flow.internal.nodefeature.

java.lang.Object

com.vaadin.flow.internal.nodefeature.NodeFeature

com.vaadin.flow.internal.nodefeature.ServerSideFeature

All Implemented Interfaces:

Direct Known Subclasses:

AttachExistingElementFeature, ComponentMapping, InertData, ReturnChannelMap, ShadowRootHost

public abstract class ServerSideFeature extends NodeFeature

Abstract node feature that is only present on the server. A server side feature does not produce any node changes and it can't contain child nodes.

For internal use only. May be renamed or removed in a future release.

Since:

1.0

Author:

Vaadin Ltd

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor

Description

ServerSideFeature(StateNode node)

Creates a new feature for the given node.
Method Summary

Modifier and Type

Method

Description

void

collectChanges(Consumer<NodeChange> collector)

Collects all changes that are recorded for this feature.

void

forEachChild(Consumer<StateNode> action)

Passes each child node instance to the given consumer.

void

generateChangesFromEmpty()

Generates all changes that would be needed to take this node from its initial empty state to its current state.

Methods inherited from class com.vaadin.flow.internal.nodefeature.NodeFeature
allowsChanges, attachPotentialChild, detatchPotentialChild, getNode, onAttach, onDetach

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details
- ServerSideFeature
  
  public ServerSideFeature(StateNode node)
  
  Creates a new feature for the given node.
  
  Parameters:
  
  node - the node which supports the feature
Method Details
- collectChanges
  
  public void collectChanges(Consumer<NodeChange> collector)
  
  Description copied from class: NodeFeature
  
  Collects all changes that are recorded for this feature.
  
  Specified by:
  
  collectChanges in class NodeFeature
  
  Parameters:
  
  collector - a consumer accepting node changes
- generateChangesFromEmpty
  
  public void generateChangesFromEmpty()
  
  Description copied from class: NodeFeature
  
  Generates all changes that would be needed to take this node from its initial empty state to its current state.
  
  Specified by:
  
  generateChangesFromEmpty in class NodeFeature
- forEachChild
  
  public void forEachChild(Consumer<StateNode> action)
  
  Description copied from class: NodeFeature
  
  Passes each child node instance to the given consumer.
  
  Specified by:
  
  forEachChild in class NodeFeature
  
  Parameters:
  
  action - the consumer that accepts each child