Package com.fasterxml.jackson.jakarta.rs.yaml

Class JacksonXmlBindYAMLProvider

java.lang.Object
com.fasterxml.jackson.jakarta.rs.base.ProviderBase<JacksonYAMLProvider,com.fasterxml.jackson.dataformat.yaml.YAMLMapper,YAMLEndpointConfig,YAMLMapperConfigurator>
com.fasterxml.jackson.jakarta.rs.yaml.JacksonYAMLProvider
com.fasterxml.jackson.jakarta.rs.yaml.JacksonXmlBindYAMLProvider
All Implemented Interfaces:
com.fasterxml.jackson.core.Versioned, jakarta.ws.rs.ext.MessageBodyReader<Object>, jakarta.ws.rs.ext.MessageBodyWriter<Object>
@Provider @Consumes("*/*") @Produces({"application/yaml","*/*"}) public class JacksonXmlBindYAMLProvider extends JacksonYAMLProvider
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

    Fields
    Modifier and Type
    Field
    Description
    static final com.fasterxml.jackson.jakarta.rs.cfg.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.

    Fields inherited from class com.fasterxml.jackson.jakarta.rs.yaml.JacksonYAMLProvider

    _providers, BASIC_ANNOTATIONS

    Fields inherited from class com.fasterxml.jackson.jakarta.rs.base.ProviderBase

    _cfgCheckCanDeserialize, _cfgCheckCanSerialize, _cfgCustomUntouchables, _defaultReadView, _defaultWriteView, _jakartaRSFeatures, _mapperConfig, _readers, _unreadableClasses, _untouchables, _unwritableClasses, _writers, DEFAULT_UNREADABLES, DEFAULT_UNTOUCHABLES, DEFAULT_UNWRITABLES, HEADER_CONTENT_TYPE_OPTIONS, JAKARTA_RS_FEATURE_DEFAULTS

  • Constructor Summary

    Constructors
    Constructor
    Description
    JacksonXmlBindYAMLProvider()
    Default constructor, usually used when provider is automatically configured to be used with Jakarta-RS implementation.
    JacksonXmlBindYAMLProvider(com.fasterxml.jackson.dataformat.yaml.YAMLMapper mapper, com.fasterxml.jackson.jakarta.rs.cfg.Annotations[] annotationsToUse)
    Constructor to use when a custom mapper (usually components like serializer/deserializer factories that have been configured) is to be used.
    JacksonXmlBindYAMLProvider(com.fasterxml.jackson.jakarta.rs.cfg.Annotations... annotationsToUse)
     

  • Method Summary

    Methods inherited from class com.fasterxml.jackson.jakarta.rs.yaml.JacksonYAMLProvider

    _configForReading, _configForWriting, _createParser, _locateMapperViaProvider, hasMatchingMediaType, version

    Methods inherited from class com.fasterxml.jackson.jakarta.rs.base.ProviderBase

    _addSuperTypes, _configForReading, _configForWriting, _containedIn, _createGenerator, _createNoContentException, _endpointForReading, _endpointForWriting, _findCustomUntouchable, _isIgnorableForReading, _isIgnorableForWriting, _isSpecialReadable, _locateMapperViaProvider, _modifyHeaders, addUntouchable, checkCanDeserialize, checkCanSerialize, configure, configure, configure, configure, configure, disable, disable, disable, disable, disable, disable, enable, enable, enable, enable, enable, enable, findEncoding, findSuperTypes, findSuperTypes, getSize, hasMatchingMediaTypeForReading, hasMatchingMediaTypeForWriting, isEnabled, isReadable, isWriteable, locateMapper, readFrom, removeUntouchable, setAnnotationsToUse, setDefaultReadView, setDefaultView, setDefaultWriteView, setMapper, writeTo

    Methods inherited from class java.lang.Object

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

  • Field Details

    • DEFAULT_ANNOTATIONS

      public static final com.fasterxml.jackson.jakarta.rs.cfg.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 Details

    • JacksonXmlBindYAMLProvider

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

    • JacksonXmlBindYAMLProvider

      public JacksonXmlBindYAMLProvider(com.fasterxml.jackson.jakarta.rs.cfg.Annotations... annotationsToUse)
      Parameters:
      annotationsToUse - Annotation set(s) to use for configuring data binding

    • JacksonXmlBindYAMLProvider

      public JacksonXmlBindYAMLProvider(com.fasterxml.jackson.dataformat.yaml.YAMLMapper mapper, com.fasterxml.jackson.jakarta.rs.cfg.Annotations[] annotationsToUse)
      Constructor to use when a custom mapper (usually components like serializer/deserializer factories that have been configured) is to be used.