Class UidlWriter
- java.lang.Object
-
- com.vaadin.flow.server.communication.UidlWriter
-
- All Implemented Interfaces:
Serializable
public class UidlWriter extends Object implements Serializable
Serializes pending server-side changes to UI state to JSON. This includes shared state, client RPC invocations, connector hierarchy changes, connector type information among others.For internal use only. May be renamed or removed in a future release.
- Since:
- 1.0
- Author:
- Vaadin Ltd
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
UidlWriter.ResolveContext
Provides context information for the resolve operations.
-
Constructor Summary
Constructors Constructor Description UidlWriter()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description elemental.json.JsonObject
createUidl(UI ui, boolean async)
Creates a JSON object containing all pending changes to the given UI.elemental.json.JsonObject
createUidl(UI ui, boolean async, boolean resync)
Creates a JSON object containing all pending changes to the given UI.
-
-
-
Method Detail
-
createUidl
public elemental.json.JsonObject createUidl(UI ui, boolean async, boolean resync)
Creates a JSON object containing all pending changes to the given UI.- Parameters:
ui
- TheUI
whose changes to writeasync
- True if this message is sent by the server asynchronously, false if it is a response to a client messageresync
- True iff the client should be asked to resynchronize- Returns:
- JSON object containing the UIDL response
-
createUidl
public elemental.json.JsonObject createUidl(UI ui, boolean async)
Creates a JSON object containing all pending changes to the given UI.- Parameters:
ui
- TheUI
whose changes to writeasync
- True if this message is sent by the server asynchronously, false if it is a response to a client message.- Returns:
- JSON object containing the UIDL response
-
-