Package com.vaadin.server.communication

Class UidlWriter

  • All Implemented Interfaces:
    java.io.Serializable
    public class UidlWriter
extends java.lang.Object
implements java.io.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.
    Since:
    7.1
    Author:
    Vaadin Ltd
    See Also:
    Serialized Form

    • Constructor Summary

      Constructors 
      Constructor Description
      UidlWriter()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void write​(UI ui, java.io.Writer writer, boolean async)
      Writes 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

      • write

        public void write​(UI ui,
                  java.io.Writer writer,
                  boolean async)
           throws java.io.IOException
        Writes a JSON object containing all pending changes to the given UI.
        Parameters:
        ui - The UI whose changes to write
        writer - The writer to use
        async - True if this message is sent by the server asynchronously, false if it is a response to a client message.
        Throws:
        java.io.IOException - If the writing fails.