Package com.vaadin.server.communication

Class MetadataWriter

java.lang.Object

com.vaadin.server.communication.MetadataWriter

All Implemented Interfaces:

Serializable

public class MetadataWriter
extends Object
implements Serializable

Serializes miscellaneous metadata to JSON.

Since:

7.1

Author:

Vaadin Ltd

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
MetadataWriter()

Method Summary

Modifier and Type	Method	Description
void	write(UI ui, Writer writer, boolean repaintAll, boolean async, SystemMessages messages)	Writes a JSON object containing metadata related to the given UI.

Methods inherited from class java.lang.Object

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

Constructor Detail

MetadataWriter

public MetadataWriter()

Method Detail

write

public void write(UI ui,
                  Writer writer,
                  boolean repaintAll,
                  boolean async,
                  SystemMessages messages)
           throws IOException

Writes a JSON object containing metadata related to the given UI.

Parameters:

ui - The UI whose metadata to write.

writer - The writer used.

repaintAll - Whether the client should repaint everything.

analyzeLayouts - Whether detected layout problems should be reported in client and server console.

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

messages - a SystemMessages containing client-side error messages.

Throws:

IOException - If the serialization fails.