org.sdase.commons.server.jackson

Class JacksonConfigurationBundle.Builder

java.lang.Object

org.sdase.commons.server.jackson.JacksonConfigurationBundle.Builder

Enclosing class:

JacksonConfigurationBundle

public static class JacksonConfigurationBundle.Builder
extends java.lang.Object

Method Summary

Modifier and Type	Method and Description
JacksonConfigurationBundle.Builder	alwaysWriteZonedDateTimeWithMillis() Registers a default serializer for ZonedDateTime that renders 3 digits of milliseconds.
JacksonConfigurationBundle.Builder	alwaysWriteZonedDateTimeWithoutMillis() Registers a default serializer for ZonedDateTime that renders no milliseconds.
JacksonConfigurationBundle	build()
JacksonConfigurationBundle.Builder	withCustomization(java.util.function.Consumer<com.fasterxml.jackson.databind.ObjectMapper> customizer) Allows customization of the used ObjectMapper.
JacksonConfigurationBundle.Builder	withoutFieldFilter() Disables the field filter entirely.
JacksonConfigurationBundle.Builder	withoutHalSupport() Skips registration of the HAL module.

Methods inherited from class java.lang.Object

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

Method Detail

withoutHalSupport

public JacksonConfigurationBundle.Builder withoutHalSupport()

Skips registration of the HAL module. This may be used when links and embedded resources are not required or are achieved with other tooling.

Returns:

the builder

withoutFieldFilter

public JacksonConfigurationBundle.Builder withoutFieldFilter()

Disables the field filter entirely. The field filter may be used by clients to request only a subset of the properties of a resource and has to be activated with EnableFieldFilter for each resource.

Returns:

the builder

withCustomization

public JacksonConfigurationBundle.Builder withCustomization(java.util.function.Consumer<com.fasterxml.jackson.databind.ObjectMapper> customizer)

Allows customization of the used ObjectMapper. More customizers may be added by calling this method multiple times.

Parameters:

customizer - receives the used ObjectMapper for customization, e.g. to enable or disable specific features or configure formatting.

Returns:

the builder

alwaysWriteZonedDateTimeWithMillis

public JacksonConfigurationBundle.Builder alwaysWriteZonedDateTimeWithMillis()

Registers a default serializer for ZonedDateTime that renders 3 digits of milliseconds. The same serializer may be configured per field as documented in Iso8601Serializer.WithMillis.

This setting overwrites the default behaviour of Jackson which omits milliseconds if they are zero or adds nanoseconds if they are set.

Returns:

the builder

alwaysWriteZonedDateTimeWithoutMillis

public JacksonConfigurationBundle.Builder alwaysWriteZonedDateTimeWithoutMillis()

Registers a default serializer for ZonedDateTime that renders no milliseconds. The same serializer may be configured per field as documented in Iso8601Serializer.

This setting overwrites the default behaviour of Jackson which omits milliseconds if they are zero or adds nanoseconds if they are set.

Returns:

the builder

build

public JacksonConfigurationBundle build()