Top Description Fields Constructors Methods
com.fasterxml.jackson.jakarta.rs.yaml

public Class JacksonXmlBindYAMLProvider

extends JacksonYAMLProvider
Class Inheritance
Annotations
@Provider
@Consumes:*/*
@Produces:application/yaml, */*
Imports
com.fasterxml.jackson.dataformat.yaml.YAMLMapper, com.fasterxml.jackson.jakarta.rs.cfg.Annotations, jakarta.ws.rs.Consumes, .Produces, jakarta.ws.rs.core.MediaType, jakarta.ws.rs.ext.Provider

JSON content type provider automatically configured to use both Jackson and Jakarta XmlBind annotations (in that order of priority). Otherwise functionally same as JacksonYAMLProvider.

Typical usage pattern is to just instantiate instance of this provider for Jakarta-RS and use as is: this will use both Jackson and Jakarta XmlBind annotations (with Jackson annotations having priority).

Note

class annotations are duplicated from super class, since it is not clear whether Jakarta-RS implementations are required to check settings of super-classes. It is important to keep annotations in sync if changed.

Field Summary

Modifier and TypeField and Description
public static final Annotations[]
DEFAULT_ANNOTATIONS

Default annotation sets to use, if not explicitly defined during construction: use Jackson annotations if found; if not, use XmlBind annotations as fallback.

Inherited from com.fasterxml.jackson.jakarta.rs.yaml.JacksonYAMLProvider:
_providersBASIC_ANNOTATIONS

Constructor Summary

AccessConstructor and Description
public
JacksonXmlBindYAMLProvider()

Default constructor, usually used when provider is automatically configured to be used with Jakarta-RS implementation.

public
JacksonXmlBindYAMLProvider(Annotations...
Annotation set(s) to use for configuring data binding
annotationsToUse
)

public
JacksonXmlBindYAMLProvider(YAMLMapper mapper, Annotations[] annotationsToUse)

Constructor to use when a custom mapper (usually components like serializer/deserializer factories that have been configured) is to be used.

Method Summary

Inherited from com.fasterxml.jackson.jakarta.rs.yaml.JacksonYAMLProvider:
_configForReading_configForWriting_createParser_locateMapperViaProviderhasMatchingMediaTypeversion

Field Detail

DEFAULT_ANNOTATIONSback to summary
public static final Annotations[] DEFAULT_ANNOTATIONS

Default annotation sets to use, if not explicitly defined during construction: use Jackson annotations if found; if not, use XmlBind annotations as fallback.

Constructor Detail

JacksonXmlBindYAMLProviderback to summary
public JacksonXmlBindYAMLProvider()

Default constructor, usually used when provider is automatically configured to be used with Jakarta-RS implementation.

JacksonXmlBindYAMLProviderback to summary
public JacksonXmlBindYAMLProvider(Annotations... annotationsToUse)
Parameters
annotationsToUse:Annotations[]

Annotation set(s) to use for configuring data binding

JacksonXmlBindYAMLProviderback to summary
public JacksonXmlBindYAMLProvider(YAMLMapper mapper, Annotations[] annotationsToUse)

Constructor to use when a custom mapper (usually components like serializer/deserializer factories that have been configured) is to be used.