Class JacksonMixinModuleEntries

java.lang.Object

org.springframework.boot.jackson.JacksonMixinModuleEntries

public final class JacksonMixinModuleEntries
extends Object

Provides the mapping of Jackson mixin classes to consider.

Since:

4.0.0

Author:

Stephane Nicoll

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	JacksonMixinModuleEntries.Builder	Builder for JacksonMixinModuleEntries.

Method Summary

Modifier and Type	Method	Description
static JacksonMixinModuleEntries	create(Consumer<JacksonMixinModuleEntries.Builder> mixins)	Create an instance using the specified JacksonMixinModuleEntries.Builder.
void	doWithEntry(@Nullable ClassLoader classLoader, BiConsumer<Class<?>,Class<?>> action)	Perform an action on each entry defined by this instance.
static JacksonMixinModuleEntries	scan(ApplicationContext context, Collection<String> basePackages)	Scan the classpath for @JacksonMixin in the specified basePackages.

Methods inherited from class Object

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

Method Details

create

public static JacksonMixinModuleEntries create(Consumer<JacksonMixinModuleEntries.Builder> mixins)

Create an instance using the specified JacksonMixinModuleEntries.Builder.

Parameters:

mixins - a consumer of the builder

Returns:

an instance with the state of the customized builder.

scan

public static JacksonMixinModuleEntries scan(ApplicationContext context,
 Collection<String> basePackages)

Scan the classpath for @JacksonMixin in the specified basePackages.

Parameters:

context - the application context to use

basePackages - the base packages to consider

Returns:

an instance with the result of the scanning

doWithEntry

public void doWithEntry(@Nullable ClassLoader classLoader,
 BiConsumer<Class<?>,Class<?>> action)

Perform an action on each entry defined by this instance. If a class needs to be resolved from its class name, the specified ClassLoader is used.

Parameters:

classLoader - the classloader to use to resolve class name if necessary

action - the action to invoke on each type to mixin class entry