Package com.kazforge.jsonapi.jackson3

Class Jackson3JsonApi.Builder

java.lang.Object
com.kazforge.jsonapi.jackson3.Jackson3JsonApi.Builder
Enclosing class:
Jackson3JsonApi
public static final class Jackson3JsonApi.Builder extends Object
Mutable builder for one immutable Jackson3JsonApi. Every setting except the mapper is optional and selects the same documented default as the corresponding capability factory.

  • Method Details

    • identifierConverter

      public Jackson3JsonApi.Builder identifierConverter(com.kazforge.jsonapi.mapping.IdentifierConverter identifierConverter)
      Uses the given identifier converter for both identity roles.

    • linkageMappers

      public Jackson3JsonApi.Builder linkageMappers(Map<Class<?>,RelationshipLinkageMapper> linkageMappers)
      Uses custom relationship linkage mappers keyed by relationship target class. The map is snapshotted on build().

    • representationPolicy

      public Jackson3JsonApi.Builder representationPolicy(com.kazforge.jsonapi.representation.RepresentationPolicy representationPolicy)
      Uses the given representation policy as the application default governing per-operation representation selections. Default writes inherit this policy; per-call overrides remain advanced.

    • decorators

      public Jackson3JsonApi.Builder decorators(com.kazforge.jsonapi.mapping.ResourceDecoratorRegistry decorators)
      Uses the given resource decorator registry for domain writes.

    • jsonApiVersion

      public Jackson3JsonApi.Builder jsonApiVersion(String jsonApiVersion)
      Advertises the given JSON:API version on resource documents written by this runtime when a write does not supply an explicit jsonapi object. This setting describes the document jsonapi.version; it is not HTTP API or business versioning and does not negotiate media type extensions or profiles.

      The supplied value is preserved as-is and must not be null.

    • build

      public Jackson3JsonApi build()
      Builds an immutable runtime.