Package com.fasterxml.jackson.module.jakarta.xmlbind

Class JakartaXmlBindAnnotationModule

java.lang.Object

com.fasterxml.jackson.databind.Module

com.fasterxml.jackson.module.jakarta.xmlbind.JakartaXmlBindAnnotationModule

All Implemented Interfaces:

Versioned

public class JakartaXmlBindAnnotationModule
extends Module

Module that can be registered to add support for JAXB annotations. It does basically equivalent of

   objectMapper.setAnnotationIntrospector(...);

with combination of JakartaXmlBindAnnotationIntrospector and existing default introspector(s) (if any), depending on configuration (by default, JAXB annotations are used as JakartaXmlBindAnnotationModule.Priority.PRIMARY annotations).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	JakartaXmlBindAnnotationModule.Priority	Enumeration that defines how we use JAXB Annotations: either as "primary" annotations (before any other already configured introspector -- most likely default JacksonAnnotationIntrospector) or as "secondary" annotations (after any other already configured introspector(s)).

Nested classes/interfaces inherited from class com.fasterxml.jackson.databind.Module

Module.SetupContext

Field Summary

Fields

Modifier and Type	Field	Description
protected JakartaXmlBindAnnotationIntrospector	_introspector	If the introspector is explicitly set or passed, we'll hold on to that until registration.
protected String	_nameUsedForXmlValue	Value to pass to JakartaXmlBindAnnotationIntrospector.setNameUsedForXmlValue(java.lang.String) if introspector constructed by the module.
protected JsonInclude.Include	_nonNillableInclusion	Value to pass to JakartaXmlBindAnnotationIntrospector.setNonNillableInclusion(com.fasterxml.jackson.annotation.JsonInclude.Include) if defined and non-null.
protected JakartaXmlBindAnnotationModule.Priority	_priority	Priority to use when registering annotation introspector: default value is JakartaXmlBindAnnotationModule.Priority.PRIMARY.

Constructor Summary

Constructors

Constructor	Description
JakartaXmlBindAnnotationModule()
JakartaXmlBindAnnotationModule(JakartaXmlBindAnnotationIntrospector intr)

Method Summary

Modifier and Type	Method	Description
String	getModuleName()	Method that returns a display that can be used by Jackson for informational purposes, as well as in associating extensions with module that provides them.
String	getNameUsedForXmlValue()
JsonInclude.Include	getNonNillableInclusion()
JakartaXmlBindAnnotationModule.Priority	getPriority()
JakartaXmlBindAnnotationModule	setNameUsedForXmlValue(String name)
JakartaXmlBindAnnotationModule	setNonNillableInclusion(JsonInclude.Include incl)
JakartaXmlBindAnnotationModule	setPriority(JakartaXmlBindAnnotationModule.Priority p)	Method for defining whether JAXB annotations should be added as primary or secondary annotations (compared to already registered annotations).
void	setupModule(Module.SetupContext context)	Method called by ObjectMapper when module is registered.
Version	version()	Method that returns version of this module.

Methods inherited from class com.fasterxml.jackson.databind.Module

getDependencies, getTypeId

Methods inherited from class java.lang.Object

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

Field Detail

_priority

protected JakartaXmlBindAnnotationModule.Priority _priority

Priority to use when registering annotation introspector: default value is JakartaXmlBindAnnotationModule.Priority.PRIMARY.

_introspector

protected JakartaXmlBindAnnotationIntrospector _introspector

If the introspector is explicitly set or passed, we'll hold on to that until registration.

Since:

2.7

_nonNillableInclusion

protected JsonInclude.Include _nonNillableInclusion

Value to pass to JakartaXmlBindAnnotationIntrospector.setNonNillableInclusion(com.fasterxml.jackson.annotation.JsonInclude.Include) if defined and non-null.

Since:

2.7

_nameUsedForXmlValue

protected String _nameUsedForXmlValue

Value to pass to JakartaXmlBindAnnotationIntrospector.setNameUsedForXmlValue(java.lang.String) if introspector constructed by the module.

Since:

2.12

Constructor Detail

JakartaXmlBindAnnotationModule

public JakartaXmlBindAnnotationModule()

JakartaXmlBindAnnotationModule

public JakartaXmlBindAnnotationModule(JakartaXmlBindAnnotationIntrospector intr)

Since:

2.7

Method Detail

getModuleName

public String getModuleName()

Description copied from class: Module

Method that returns a display that can be used by Jackson for informational purposes, as well as in associating extensions with module that provides them.

Specified by:

getModuleName in class Module

version

public Version version()

Description copied from class: Module

Method that returns version of this module. Can be used by Jackson for informational purposes.

Specified by:

version in interface Versioned

Specified by:

version in class Module

Returns:

Version of the component

setupModule

public void setupModule(Module.SetupContext context)

Description copied from class: Module

Method called by ObjectMapper when module is registered. It is called to let module register functionality it provides, using callback methods passed-in context object exposes.

Specified by:

setupModule in class Module

setPriority

public JakartaXmlBindAnnotationModule setPriority(JakartaXmlBindAnnotationModule.Priority p)

Method for defining whether JAXB annotations should be added as primary or secondary annotations (compared to already registered annotations).

NOTE: method MUST be called before registering the module -- calling afterwards will not have any effect on previous registrations.

getPriority

public JakartaXmlBindAnnotationModule.Priority getPriority()

setNonNillableInclusion

public JakartaXmlBindAnnotationModule setNonNillableInclusion(JsonInclude.Include incl)

Since:

2.7

getNonNillableInclusion

public JsonInclude.Include getNonNillableInclusion()

Since:

2.7

setNameUsedForXmlValue

public JakartaXmlBindAnnotationModule setNameUsedForXmlValue(String name)

Since:

2.12

getNameUsedForXmlValue

public String getNameUsedForXmlValue()