com.vaadin.flow.server.communication

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 and Description
static class	UidlWriter.ResolveContext Provides context information for the resolve operations.

Constructor Summary

Constructors

Constructor and Description
UidlWriter()

Method Summary

Modifier and Type	Method and 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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UidlWriter

public UidlWriter()

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 - The UI whose changes to write

async - True if this message is sent by the server asynchronously, false if it is a response to a client message

resync - 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 - The UI whose changes to write

async - 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