name.pehl.piriti.json.client

Interface JsonWriter<T>

Type Parameters:

T - The type

All Superinterfaces:

com.google.gwt.event.shared.HasHandlers, HasModelWriteHandler<T>

All Known Implementing Classes:

AbstractJsonWriter

public interface JsonWriter<T>
extends HasModelWriteHandler<T>

Interface for serializing an instance of T or a list of Ts to JSON. All properties of T and superclasses of T are handled by the generated JsonWriter implementation. Null values in T are generated into the resulting JSON data.

The setup of JsonWriter is inspired by the UiBinder and is typically specified as an inner class:

 pubilc RunnableMessageContext
 {
     interface Writer extends JsonWriter<RunnableMessageContext> {}
     public static final Writer JSON_WRITER = GWT.create(Writer.class);
     
     // The properties of this POJO
 }
 

JSON can then be generated by calling

 RunnableMessageContext rmc = new RunnableMessageContext();
 ...
 String json = RunnableMessageContext.JSON_WRITER.toJson(rmc);
 

Version:

$LastChangedRevision: 46 $

Author:

$LastChangedBy: harald.pehl $

Method Summary

Methods

Modifier and Type	Method and Description
String	toJson(List<T> models, String arrayKey) Generates JSON data for the list of Ts according to the annotated properties in T.
String	toJson(T model) Generates JSON data for T according to the annotated properties in T.

Methods inherited from interface name.pehl.piriti.commons.client.HasModelWriteHandler

addModelWriteHandler

Methods inherited from interface com.google.gwt.event.shared.HasHandlers

fireEvent

Method Detail

toJson

String toJson(List<T> models,
            String arrayKey)

Generates JSON data for the list of Ts according to the annotated properties in T. The resulting JSON data contains the instances ot T inside an array with the specified name:

 List<RunnableMessageContext> rmcs = ...;
 String json = RunnableMessageContext.JSON_WRITER.toJson(rmcs, "data");
 // json will be somethig like {"data":[...]}
 

Parameters:

models - the list of Ts to serialize to JSON. May be null.

arrayKey - the array key

Returns:

JSON data for the list of Ts or null if models and/or arrayKey is null.

toJson

String toJson(T model)

Generates JSON data for T according to the annotated properties in T.

Parameters:

model - the instance to serialize to JSON. May be null.

Returns:

JSON data for T or null if model is null.