org.jooby.json

Class Gzon

java.lang.Object

org.jooby.json.Gzon

All Implemented Interfaces:

Jooby.Module

public class Gzon
extends Object
implements Jooby.Module

JSON support via Gson library.

exposes

• A Gson
• A Parser
• A Renderer

usage

 {
   use(new Gzon());

   // sending
   get("/my-api", req  -> new MyObject());

   // receiving a json body
   post("/my-api", req  -> {
     MyObject obj = req.body(MyObject.class);
     return obj;
   });

   // direct access to Gson
   get("/access", req  -> {
     Gson gson = req.require(Gson.class);
     // ...
   });
 }
 

configuration

If you need a special setting or configuration for your Gson:

 {
   use(new Gzon().doWith(builder  -> {
     builder.setPrettyPrint();
     // ...
   });
 }
 

Since:

0.6.0

Author:

edgar

Constructor Summary

Constructors

Constructor and Description
Gzon() Creates a new Gson and set type to: MediaType.json.
Gzon(MediaType type) Creates a new Gson.

Method Summary

Modifier and Type	Method and Description
void	configure(Env env, com.typesafe.config.Config config, com.google.inject.Binder binder)
Gzon	doWith(BiConsumer<com.google.gson.GsonBuilder,com.typesafe.config.Config> configurer) Configurer callback.
Gzon	doWith(Consumer<com.google.gson.GsonBuilder> configurer) Configurer callback.
Gzon	raw() Add support raw string json responses:

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jooby.Jooby.Module

config

Constructor Detail

Gzon

public Gzon(MediaType type)

Creates a new Gson.

Parameters:

type - MediaType to use.

Gzon

public Gzon()

Creates a new Gson and set type to: MediaType.json.

Method Detail

doWith

public Gzon doWith(BiConsumer<com.google.gson.GsonBuilder,com.typesafe.config.Config> configurer)

Configurer callback.

 {
   use(new Gzon().doWith(builder  -> {
     builder.setPrettyPrint();
     // ...
   });
 }
 

Parameters:

configurer - A callback.

Returns:

This instance.

doWith

public Gzon doWith(Consumer<com.google.gson.GsonBuilder> configurer)

Configurer callback.

 {
   use(new Gzon().doWith((builder, config)  -> {
     builder.setPrettyPrint();
     // ...
   });
 }
 

Parameters:

configurer - A callback.

Returns:

This instance.

configure

public void configure(Env env,
                      com.typesafe.config.Config config,
                      com.google.inject.Binder binder)

Specified by:

configure in interface Jooby.Module

raw

public Gzon raw()

Add support raw string json responses:

 {
   get("/raw", () -> {
     return "{\"raw\": \"json\"}";
   });
 }
 

Returns:

This module.