Package discord4j.common

Class JacksonResources

java.lang.Object

discord4j.common.JacksonResources

public class JacksonResources
extends Object

Provides a centralized Jackson 2.10 ObjectMapper allowing customization and reuse across the application.

Field Summary

Fields

Modifier and Type	Field	Description
static final Function<ObjectMapper,ObjectMapper>	HANDLE_UNKNOWN_PROPERTIES	A mapper of ObjectMapper to handle unknown properties without throwing errors.
static final Function<ObjectMapper,ObjectMapper>	INITIALIZER	A mapper of ObjectMapper with all the required options for Discord4J operations.

Constructor Summary

Constructors

Constructor	Description
JacksonResources()	Deprecated. use create()
JacksonResources(ObjectMapper objectMapper)	Deprecated. use createFromObjectMapper(ObjectMapper) instead, but consider all Discord4J-related transformations are applied on the given ObjectMapper
JacksonResources(Function<ObjectMapper,ObjectMapper> mapper)	Deprecated. use one of the static factories and then call withMapperFunction(Function)

Method Summary

Modifier and Type	Method	Description
static JacksonResources	create()	Create with a pre-configured ObjectMapper for all Discord4J related operations.
static JacksonResources	createFromObjectMapper(ObjectMapper objectMapper)	Create based on ObjectMapper applying on it all changes required for Discord4J related operations.
ObjectMapper	getObjectMapper()	Get the ObjectMapper configured by this provider.
JacksonResources	withMapperFunction(Function<ObjectMapper,ObjectMapper> transformer)	Return a new JacksonResources based on this current ObjectMapper but applying the given function.

Methods inherited from class java.lang.Object

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

Field Details

INITIALIZER

public static final Function<ObjectMapper,ObjectMapper> INITIALIZER

A mapper of ObjectMapper with all the required options for Discord4J operations.

HANDLE_UNKNOWN_PROPERTIES

public static final Function<ObjectMapper,ObjectMapper> HANDLE_UNKNOWN_PROPERTIES

A mapper of ObjectMapper to handle unknown properties without throwing errors.

Constructor Details

JacksonResources

@Deprecated
public JacksonResources()

Deprecated.

use create()

Create a default ObjectMapper that allows any field visibility, registers modules to handle Discord4J specific mappings and ignores unknown properties.

JacksonResources

@Deprecated
public JacksonResources(Function<ObjectMapper,ObjectMapper> mapper)

Deprecated.

use one of the static factories and then call withMapperFunction(Function)

Create a custom ObjectMapper, based on the defaults given by JacksonResources().

Parameters:

mapper - a Function to customize the ObjectMapper to be created

JacksonResources

@Deprecated
public JacksonResources(ObjectMapper objectMapper)

Deprecated.

use createFromObjectMapper(ObjectMapper) instead, but consider all Discord4J-related transformations are applied on the given ObjectMapper

Create with a pre-configured ObjectMapper. Using this will replace the recommended default and can lead to unexpected behavior and errors.

Parameters:

objectMapper - a pre-configured ObjectMapper to use

Method Details

create

public static JacksonResources create()

Create with a pre-configured ObjectMapper for all Discord4J related operations.

createFromObjectMapper

public static JacksonResources createFromObjectMapper(ObjectMapper objectMapper)

Create based on ObjectMapper applying on it all changes required for Discord4J related operations.

withMapperFunction

public JacksonResources withMapperFunction(Function<ObjectMapper,ObjectMapper> transformer)

Return a new JacksonResources based on this current ObjectMapper but applying the given function.

Parameters:

transformer - a mapper to enrich the current ObjectMapper

Returns:

a new instance with the transformer applied

getObjectMapper

public ObjectMapper getObjectMapper()

Get the ObjectMapper configured by this provider.

Returns:

a Jackson ObjectMapper used to map POJOs to and from JSON format