ratpack.jackson

Class JacksonModule.Config

java.lang.Object

ratpack.jackson.JacksonModule.Config

Enclosing class:

JacksonModule

public static class JacksonModule.Config
extends java.lang.Object

The configuration object for JacksonModule.

Constructor Summary

Constructors

Constructor and Description
Config()

Method Summary

Modifier and Type	Method and Description
java.util.List<Module>	getModules() The Jackson modules to register with the object mapper.
boolean	isPrettyPrint() Whether JSON should be pretty printed.
JacksonModule.Config	modules(java.lang.Iterable<Module> modules) Add the given modules to the modules to be registered with the created object mapper.
JacksonModule.Config	modules(Module... modules) Add the given modules to the modules to be registered with the created object mapper.
JacksonModule.Config	prettyPrint(boolean prettyPrint) Sets whether JSON should be pretty printed.
JacksonModule.Config	withMapper(java.util.function.Consumer<? super ObjectMapper> configurer) Adds configuration actions to be executed against the object mapper created by this Guice module before it is used.

Methods inherited from class java.lang.Object

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

Constructor Detail

Config

public Config()

Method Detail

isPrettyPrint

public boolean isPrettyPrint()

Whether JSON should be pretty printed.

true by default.

Returns:

whether JSON should be pretty printed.

prettyPrint

public JacksonModule.Config prettyPrint(boolean prettyPrint)

Sets whether JSON should be pretty printed.

This value affects the ObjectWriter instance provided by this Guice module. If this binding is overridden, calling this method may have no effect.

Parameters:

prettyPrint - whether JSON should be pretty printed

Returns:

this

getModules

public java.util.List<Module> getModules()

The Jackson modules to register with the object mapper.

Jackson modules extend Jackson to handle extra data types.

Returns:

the Jackson modules to register with the object mapper

See Also:

modules(Iterable), modules(Module...)

modules

public JacksonModule.Config modules(java.lang.Iterable<Module> modules)

Add the given modules to the modules to be registered with the created object mapper.

This affects the ObjectMapper instance provided by this Guice module. If this binding is overridden, calling this method may have no effect.

Parameters:

modules - the Jackson modules

Returns:

this

See Also:

modules(Module...)

modules

public JacksonModule.Config modules(Module... modules)

Add the given modules to the modules to be registered with the created object mapper.

This affects the ObjectMapper instance provided by this Guice module. If this binding is overridden, calling this method may have no effect.

Parameters:

modules - the Jackson modules

Returns:

this

See Also:

modules(Iterable)

withMapper

public JacksonModule.Config withMapper(java.util.function.Consumer<? super ObjectMapper> configurer)

Adds configuration actions to be executed against the object mapper created by this Guice module before it is used.

This method is cumulative, with configure actions being executed in order. They are executed after applying other relevant configuration to the mapper (e.g. registering modules).

This affects the ObjectMapper instance provided by this Guice module. If this binding is overridden, calling this method may have no effect.

Parameters:

configurer - configuration for the object mapper

Returns:

this