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 Priority#PRIMARY annotations).

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static enum	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)).

Field Summary

Modifier and Type	Field and 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` if introspector constructed by the module.
protected JsonInclude.Include	_nonNillableInclusion Value to pass to `JakartaXmlBindAnnotationIntrospector#setNonNillableInclusion` if defined and non-null.
protected JakartaXmlBindAnnotationModule.Priority	_priority Priority to use when registering annotation introspector: default value is `Priority#PRIMARY`.

Constructor Summary

Access	Constructor and Description
public	JakartaXmlBindAnnotationModule()
public	JakartaXmlBindAnnotationModule(JakartaXmlBindAnnotationIntrospector intr)

Method Summary

Modifier and Type	Method and Description
public String	getModuleName() Implements abstract com.fasterxml.jackson.databind.Module.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.
public String	getNameUsedForXmlValue()
public JsonInclude.Include	getNonNillableInclusion()
public JakartaXmlBindAnnotationModule.Priority	getPriority()
public JakartaXmlBindAnnotationModule	setNameUsedForXmlValue(String name)
public JakartaXmlBindAnnotationModule	setNonNillableInclusion(JsonInclude.Include incl)
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).
public void	setupModule(Module.SetupContext context) Implements abstract com.fasterxml.jackson.databind.Module.setupModule. Method called by `ObjectMapper` when module is registered.
public Version	version() Implements abstract com.fasterxml.jackson.databind.Module.version. Implements com.fasterxml.jackson.core.Versioned.version. Method that returns version of this module.

Inherited from com.fasterxml.jackson.databind.Module:: getDependencies getTypeId

Field Detail

_introspector	back to summary
protected JakartaXmlBindAnnotationIntrospector _introspector If the introspector is explicitly set or passed, we'll hold on to that until registration. Since 2.7

_introspector

back to summary

protected JakartaXmlBindAnnotationIntrospector _introspector

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

Since: 2.7

_nameUsedForXmlValue back to summary

_nameUsedForXmlValue	back to summary
protected String _nameUsedForXmlValue Value to pass to `JakartaXmlBindAnnotationIntrospector#setNameUsedForXmlValue` if introspector constructed by the module. Since 2.12

protected String _nameUsedForXmlValue

Value to pass to JakartaXmlBindAnnotationIntrospector#setNameUsedForXmlValue if introspector constructed by the module.

Since: 2.12

_nonNillableInclusion back to summary

_nonNillableInclusion	back to summary
protected JsonInclude.Include _nonNillableInclusion Value to pass to `JakartaXmlBindAnnotationIntrospector#setNonNillableInclusion` if defined and non-null. Since 2.7

protected JsonInclude.Include _nonNillableInclusion

Value to pass to JakartaXmlBindAnnotationIntrospector#setNonNillableInclusion if defined and non-null.

Since: 2.7

_priority	back to summary
protected JakartaXmlBindAnnotationModule.Priority _priority Priority to use when registering annotation introspector: default value is `Priority#PRIMARY`.

Constructor Detail

JakartaXmlBindAnnotationModule	back to summary
public JakartaXmlBindAnnotationModule()

JakartaXmlBindAnnotationModule	back to summary
public JakartaXmlBindAnnotationModule(JakartaXmlBindAnnotationIntrospector intr) Since 2.7

Method Detail

getModuleName	back to summary
public String getModuleName() Implements abstract com.fasterxml.jackson.databind.Module.getModuleName. Doc from com.fasterxml.jackson.databind.Module.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. Annotations @Override

getModuleName

back to summary

public String getModuleName()

Implements abstract com.fasterxml.jackson.databind.Module.getModuleName.

Doc from com.fasterxml.jackson.databind.Module.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.

Annotations

@Override

getNameUsedForXmlValue	back to summary
public String getNameUsedForXmlValue()

getNonNillableInclusion	back to summary
public JsonInclude.Include getNonNillableInclusion() Since 2.7

getPriority	back to summary
public JakartaXmlBindAnnotationModule.Priority getPriority()

setNameUsedForXmlValue	back to summary
public JakartaXmlBindAnnotationModule setNameUsedForXmlValue(String name) Since 2.12

setNonNillableInclusion	back to summary
public JakartaXmlBindAnnotationModule setNonNillableInclusion(JsonInclude.Include incl) Since 2.7

setPriority	back to summary
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.

setupModule back to summary

setupModule	back to summary
public void setupModule(Module.SetupContext context) Implements abstract com.fasterxml.jackson.databind.Module.setupModule. Doc from com.fasterxml.jackson.databind.Module.setupModule. 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. Annotations @Override

public void setupModule(Module.SetupContext context)

Implements abstract com.fasterxml.jackson.databind.Module.setupModule.

Doc from com.fasterxml.jackson.databind.Module.setupModule.

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.

Annotations

@Override

version	back to summary
public Version version() Implements abstract com.fasterxml.jackson.databind.Module.version. Implements com.fasterxml.jackson.core.Versioned.version. Doc from com.fasterxml.jackson.databind.Module.version. Method that returns version of this module. Can be used by Jackson for informational purposes. Returns:Version Doc from com.fasterxml.jackson.core.Versioned.version. Version of the component Annotations @Override

version

back to summary

public Version version()

Implements abstract com.fasterxml.jackson.databind.Module.version.

Implements com.fasterxml.jackson.core.Versioned.version.

Doc from com.fasterxml.jackson.databind.Module.version.

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

Returns:Version

Doc from com.fasterxml.jackson.core.Versioned.version.

Version of the component

Annotations

@Override

com.fasterxml.jackson.module.jakarta.xmlbind back to summary

public final Enum JakartaXmlBindAnnotationModule.Priority

Class Inheritance

extends Enum<JakartaXmlBindAnnotationModule.Priority>

java.lang.Object
java.lang.Enum
com.fasterxml.jackson.module.jakarta.xmlbind.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)).

Default choice is PRIMARY

Note that if you want to use JAXB annotations as the only annotations, you must directly set annotation introspector by calling com.fasterxml.jackson.databind.ObjectMapper#setAnnotationIntrospector.

Field Summary

Modifier and Type	Field and Description
public static final JakartaXmlBindAnnotationModule.Priority	PRIMARY
public static final JakartaXmlBindAnnotationModule.Priority	SECONDARY

Constructor Summary

Access	Constructor and Description
private	Priority()

Method Summary

Modifier and Type	Method and Description
public static JakartaXmlBindAnnotationModule.Priority	valueOf(String name)
public static JakartaXmlBindAnnotationModule.Priority[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

PRIMARY	back to summary
public static final JakartaXmlBindAnnotationModule.Priority PRIMARY

SECONDARY	back to summary
public static final JakartaXmlBindAnnotationModule.Priority SECONDARY

Constructor Detail

Priority	back to summary
private Priority()

Method Detail

valueOf	back to summary
public static JakartaXmlBindAnnotationModule.Priority valueOf(String name)

values	back to summary
public static JakartaXmlBindAnnotationModule.Priority[] values()

public Class JakartaXmlBindAnnotationModule

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Enum JakartaXmlBindAnnotationModule.Priority

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail