Index (jsonapi-java-jackson3 0.4.0 API)

A B C D E F I J L M P R T W
All Classes and Interfaces|All Packages

A

additionalMembers() - Method in class com.kazforge.jsonapi.jackson3.JsonApiDomainDocument: Additional document members in insertion order; unmodifiable view of a defensive copy.

B

build() - Method in class com.kazforge.jsonapi.jackson3.Jackson3JsonApi.Builder: Builds an immutable runtime.
builder(JsonMapper) - Static method in class com.kazforge.jsonapi.jackson3.JsonApiJackson3: Returns a builder for a Level-1 configured runtime over the given configured mapper.

C

com.kazforge.jsonapi.jackson3 - package com.kazforge.jsonapi.jackson3: Jackson 3 implementation of the major-neutral Level-1 JSON:API application contract and its advanced document, mapping, typed-envelope, and PATCH capabilities.
com.kazforge.jsonapi.jackson3.mapping - package com.kazforge.jsonapi.jackson3.mapping: Public Jackson 3 relationship-linkage mapping contracts.
context() - Method in class com.kazforge.jsonapi.jackson3.JsonApiDocumentReader: Read context bound to this reader.
context() - Method in class com.kazforge.jsonapi.jackson3.JsonApiDocumentWriter: Validation context bound to this writer (before mapped-document provenance composition).

D

data() - Method in class com.kazforge.jsonapi.jackson3.JsonApiDomainDocument: Primary data; null when the data member is absent.
decorators(ResourceDecoratorRegistry) - Method in class com.kazforge.jsonapi.jackson3.Jackson3JsonApi.Builder: Uses the given resource decorator registry for domain writes.
documents() - Method in class com.kazforge.jsonapi.jackson3.Jackson3JsonApi
domainDocumentReader(JsonMapper, DocumentReadContext, ResourceTypeRegistry) - Static method in class com.kazforge.jsonapi.jackson3.JsonApiJackson3: Returns a typed domain envelope reader with default identifier conversion and no custom relationship linkage mappers.
domainDocumentReader(JsonMapper, DocumentReadContext, ResourceTypeRegistry, IdentifierConverter) - Static method in class com.kazforge.jsonapi.jackson3.JsonApiJackson3: Returns a typed domain envelope reader with the given identifier converter and no custom relationship linkage mappers.
domainDocumentReader(JsonMapper, DocumentReadContext, ResourceTypeRegistry, IdentifierConverter, Map<Class<?>, RelationshipLinkageMapper>) - Static method in class com.kazforge.jsonapi.jackson3.JsonApiJackson3: Returns a typed domain envelope reader with the given identifier converter and relationship linkage mappers keyed by relationship target class.

E

errors() - Method in class com.kazforge.jsonapi.jackson3.JsonApiDomainDocument: Error objects; unmodifiable view of a defensive copy.

F

fromDocument(JsonApiDocument) - Method in class com.kazforge.jsonapi.jackson3.JsonApiDomainDocumentReader: Binds an already-validated document into a domain envelope; never re-parses or re-validates.
fromDocument(JsonApiDocument, Class<T>) - Method in class com.kazforge.jsonapi.jackson3.JsonApiPatchCommandReader: Binds an already-validated document without re-parsing or re-validating.
fromDocument(JsonApiDocument, Class<T>) - Method in class com.kazforge.jsonapi.jackson3.JsonApiPatchDtoReader: Binds an already-validated document without re-parsing or re-validating.
fromDocument(JsonApiDocument, JavaType) - Method in class com.kazforge.jsonapi.jackson3.JsonApiPatchCommandReader: Binds an already-validated document without re-parsing or re-validating.
fromDocument(JsonApiDocument, JavaType) - Method in class com.kazforge.jsonapi.jackson3.JsonApiPatchDtoReader: Binds an already-validated document without re-parsing or re-validating, preserving full JavaType parameterization.
fromResource(ResourceObject, Class<T>) - Method in class com.kazforge.jsonapi.jackson3.JsonApiResourceBinder: Binds one resource object to the given DTO type.
fromResource(ResourceObject, JavaType) - Method in class com.kazforge.jsonapi.jackson3.JsonApiResourceBinder: Binds one resource object to the given DTO Java type.
fromResources(List<ResourceObject>, Class<T>) - Method in class com.kazforge.jsonapi.jackson3.JsonApiResourceBinder: Binds a homogeneous collection of resource objects to DTOs of the given type.
fromResources(List<ResourceObject>, JavaType) - Method in class com.kazforge.jsonapi.jackson3.JsonApiResourceBinder: Binds a homogeneous collection of resource objects to DTOs of the given Java type.

I

identifierConverter(IdentifierConverter) - Method in class com.kazforge.jsonapi.jackson3.Jackson3JsonApi.Builder: Uses the given identifier converter for both identity roles.
included() - Method in class com.kazforge.jsonapi.jackson3.JsonApiDomainDocument: Bound included DTOs; null when the included member is absent.

J

Jackson3JsonApi - Class in com.kazforge.jsonapi.jackson3: Configured Jackson 3 implementation of the major-neutral Level-1 JsonApi application contract.
Jackson3JsonApi.Builder - Class in com.kazforge.jsonapi.jackson3: Mutable builder for one immutable Jackson3JsonApi.
jsonapi() - Method in class com.kazforge.jsonapi.jackson3.JsonApiDomainDocument: JSON:API object; the already-decoded core value.
jsonApi(JsonMapper) - Static method in class com.kazforge.jsonapi.jackson3.JsonApiJackson3: Returns a Level-1 configured runtime with documented defaults: default identifier conversion, no custom linkage mappers, the default representation policy, no resource decorators, and no resource-write jsonapi.version default.
JsonApiDocumentReader - Class in com.kazforge.jsonapi.jackson3: Reads JSON:API JSON into a validated JsonApiDocument using an explicit DocumentReadContext.
JsonApiDocumentWriter - Class in com.kazforge.jsonapi.jackson3: Validates a JsonApiDocument against a bound ValidationContext, then writes it with deterministic JSON:API v1.1 wire semantics.
JsonApiDomainDocument - Class in com.kazforge.jsonapi.jackson3: Immutable, validated, domain-facing JSON:API document envelope with flat primary DTOs and independently bound included DTOs.
JsonApiDomainDocumentReader - Class in com.kazforge.jsonapi.jackson3: Reads validated JSON:API documents into an immutable JsonApiDomainDocument with flat primary DTOs and independently bound included DTOs.
JsonApiJackson3 - Class in com.kazforge.jsonapi.jackson3: Factory for Jackson 3 JSON:API document writers, readers, resource mappers, flat DTO binders, and presence-aware PATCH readers.
JsonApiPatchCommandReader - Class in com.kazforge.jsonapi.jackson3: Reads a validated JSON:API resource-update document into an immutable PatchCommand.
JsonApiPatchDtoReader - Class in com.kazforge.jsonapi.jackson3: Reads a validated JSON:API resource-update document directly into an application-owned annotated PATCH DTO.
JsonApiResourceBinder - Class in com.kazforge.jsonapi.jackson3: Binds validated JSON:API ResourceObject values to annotated flat DTO types.
JsonApiResourceMapper - Class in com.kazforge.jsonapi.jackson3: Maps annotated domain objects to JSON:API ResourceObject instances and documents.
jsonApiVersion(String) - Method in class com.kazforge.jsonapi.jackson3.Jackson3JsonApi.Builder: Advertises the given JSON:API version on resource documents written by this runtime when a write does not supply an explicit jsonapi object.

L

linkageMappers(Map<Class<?>, RelationshipLinkageMapper>) - Method in class com.kazforge.jsonapi.jackson3.Jackson3JsonApi.Builder: Uses custom relationship linkage mappers keyed by relationship target class.
links() - Method in class com.kazforge.jsonapi.jackson3.JsonApiDomainDocument: Document-level links; the already-decoded core value.

M

map(RelationshipData, JavaType) - Method in interface com.kazforge.jsonapi.jackson3.mapping.RelationshipLinkageMapper: Converts linkage to a property value, or returns null for an empty to-one value.
meta() - Method in class com.kazforge.jsonapi.jackson3.JsonApiDomainDocument: Document-level metadata; the already-decoded core value.
metaAs(Class<T>) - Method in class com.kazforge.jsonapi.jackson3.JsonApiDomainDocument: Converts JsonApiDomainDocument.meta() members to the given target type using the domain reader's derived binder mapper (the same mapper that bound the document), or returns null when meta is absent.
metaAs(JavaType) - Method in class com.kazforge.jsonapi.jackson3.JsonApiDomainDocument: Converts JsonApiDomainDocument.meta() members to the given Java type using the domain reader's derived binder mapper, or returns null when meta is absent.

P

patchCommandReader(JsonMapper) - Static method in class com.kazforge.jsonapi.jackson3.JsonApiJackson3: Returns a presence-aware PATCH command reader with ValidationContext.defaults(), default identifier conversion, and no custom relationship linkage mappers.
patchCommandReader(JsonMapper, ValidationContext) - Static method in class com.kazforge.jsonapi.jackson3.JsonApiJackson3: Returns a presence-aware PATCH command reader with the given validation context, default identifier conversion, and no custom relationship linkage mappers.
patchCommandReader(JsonMapper, ValidationContext, IdentifierConverter) - Static method in class com.kazforge.jsonapi.jackson3.JsonApiJackson3: Returns a presence-aware PATCH command reader with the given validation context and identifier converter, and no custom relationship linkage mappers.
patchCommandReader(JsonMapper, ValidationContext, IdentifierConverter, Map<Class<?>, RelationshipLinkageMapper>) - Static method in class com.kazforge.jsonapi.jackson3.JsonApiJackson3: Returns a presence-aware PATCH command reader with the given validation context, identifier converter, and relationship linkage mappers keyed by relationship target class.
patchDtoReader(JsonMapper) - Static method in class com.kazforge.jsonapi.jackson3.JsonApiJackson3: Returns a direct typed PATCH DTO reader with ValidationContext.defaults(), default identifier conversion, and no custom relationship linkage mappers.
patchDtoReader(JsonMapper, ValidationContext) - Static method in class com.kazforge.jsonapi.jackson3.JsonApiJackson3: Returns a direct typed PATCH DTO reader with the given validation context, default identifier conversion, and no custom relationship linkage mappers.
patchDtoReader(JsonMapper, ValidationContext, IdentifierConverter) - Static method in class com.kazforge.jsonapi.jackson3.JsonApiJackson3: Returns a direct typed PATCH DTO reader with the given validation context and identifier converter, and no custom relationship linkage mappers.
patchDtoReader(JsonMapper, ValidationContext, IdentifierConverter, Map<Class<?>, RelationshipLinkageMapper>) - Static method in class com.kazforge.jsonapi.jackson3.JsonApiJackson3: Returns a direct typed PATCH DTO reader with the given validation context, identifier converter, and relationship linkage mappers keyed by relationship target class.
patches() - Method in class com.kazforge.jsonapi.jackson3.Jackson3JsonApi

R

reader(JsonMapper, DocumentReadContext) - Static method in class com.kazforge.jsonapi.jackson3.JsonApiJackson3: Returns a reader bound to the given read context.
readValue(byte[]) - Method in class com.kazforge.jsonapi.jackson3.JsonApiDocumentReader: Reads and validates one JSON:API document from UTF-8 JSON bytes.
readValue(byte[]) - Method in class com.kazforge.jsonapi.jackson3.JsonApiDomainDocumentReader: Decodes, validates, and binds the UTF-8 JSON:API document in the given bytes.
readValue(byte[], Class<T>) - Method in class com.kazforge.jsonapi.jackson3.JsonApiPatchCommandReader: Decodes, validates, and binds the UTF-8 JSON:API update document in the given bytes.
readValue(byte[], Class<T>) - Method in class com.kazforge.jsonapi.jackson3.JsonApiPatchDtoReader: Decodes, validates, and binds the UTF-8 JSON:API update document in the given bytes.
readValue(byte[], JavaType) - Method in class com.kazforge.jsonapi.jackson3.JsonApiPatchCommandReader: Byte-array overload of JsonApiPatchCommandReader.readValue(String, JavaType).
readValue(byte[], JavaType) - Method in class com.kazforge.jsonapi.jackson3.JsonApiPatchDtoReader: Byte-array overload of JsonApiPatchDtoReader.readValue(String, JavaType).
readValue(InputStream) - Method in class com.kazforge.jsonapi.jackson3.JsonApiDocumentReader: Reads from a caller-owned UTF-8 stream.
readValue(InputStream) - Method in class com.kazforge.jsonapi.jackson3.JsonApiDomainDocumentReader: Decodes, validates, and binds one JSON:API document from a caller-owned UTF-8 stream.
readValue(InputStream, Class<T>) - Method in class com.kazforge.jsonapi.jackson3.JsonApiPatchCommandReader: Decodes, validates, and binds one JSON:API update document from a caller-owned UTF-8 stream.
readValue(InputStream, Class<T>) - Method in class com.kazforge.jsonapi.jackson3.JsonApiPatchDtoReader: Decodes, validates, and binds one JSON:API update document from a caller-owned UTF-8 stream.
readValue(InputStream, JavaType) - Method in class com.kazforge.jsonapi.jackson3.JsonApiPatchCommandReader: Stream overload of JsonApiPatchCommandReader.readValue(String, JavaType).
readValue(InputStream, JavaType) - Method in class com.kazforge.jsonapi.jackson3.JsonApiPatchDtoReader: Stream overload of JsonApiPatchDtoReader.readValue(String, JavaType).
readValue(String) - Method in class com.kazforge.jsonapi.jackson3.JsonApiDocumentReader: Reads and validates one JSON:API document from JSON text.
readValue(String) - Method in class com.kazforge.jsonapi.jackson3.JsonApiDomainDocumentReader: Decodes, validates, and binds the JSON:API document in the given string.
readValue(String, Class<T>) - Method in class com.kazforge.jsonapi.jackson3.JsonApiPatchCommandReader: Decodes, validates, and binds the JSON:API update document in the given string.
readValue(String, Class<T>) - Method in class com.kazforge.jsonapi.jackson3.JsonApiPatchDtoReader: Decodes, validates, and binds the JSON:API update document in the given string.
readValue(String, JavaType) - Method in class com.kazforge.jsonapi.jackson3.JsonApiPatchCommandReader: Decodes, validates, and binds using a JavaType; PatchCommand.resourceType() is the type's raw class.
readValue(String, JavaType) - Method in class com.kazforge.jsonapi.jackson3.JsonApiPatchDtoReader: Decodes, validates, and binds using a JavaType, preserving full parameterization.
readValue(JsonParser) - Method in class com.kazforge.jsonapi.jackson3.JsonApiDocumentReader: Reads one JSON:API document from a caller-owned parser starting at the current token (or the next token if none is current).
readValue(JsonParser) - Method in class com.kazforge.jsonapi.jackson3.JsonApiDomainDocumentReader: Decodes, validates, and binds one JSON:API document from a caller-owned parser starting at the current token (or the next token if none is current).
readValue(JsonParser, Class<T>) - Method in class com.kazforge.jsonapi.jackson3.JsonApiPatchCommandReader: Decodes, validates, and binds one JSON:API update document from a caller-owned parser.
readValue(JsonParser, Class<T>) - Method in class com.kazforge.jsonapi.jackson3.JsonApiPatchDtoReader: Decodes, validates, and binds one JSON:API update document from a caller-owned parser.
readValue(JsonParser, JavaType) - Method in class com.kazforge.jsonapi.jackson3.JsonApiPatchCommandReader: Parser overload of JsonApiPatchCommandReader.readValue(String, JavaType).
readValue(JsonParser, JavaType) - Method in class com.kazforge.jsonapi.jackson3.JsonApiPatchDtoReader: Parser overload of JsonApiPatchDtoReader.readValue(String, JavaType).
RelationshipLinkageMapper - Interface in com.kazforge.jsonapi.jackson3.mapping: Converts JSON:API relationship linkage into a value for a flat DTO relationship property.
relationships() - Method in class com.kazforge.jsonapi.jackson3.Jackson3JsonApi
representationPolicy(RepresentationPolicy) - Method in class com.kazforge.jsonapi.jackson3.Jackson3JsonApi.Builder: Uses the given representation policy as the application default governing per-operation representation selections.
resourceBinder(JsonMapper) - Static method in class com.kazforge.jsonapi.jackson3.JsonApiJackson3: Returns a flat DTO binder with default identifier conversion and no custom relationship linkage mappers.
resourceBinder(JsonMapper, IdentifierConverter) - Static method in class com.kazforge.jsonapi.jackson3.JsonApiJackson3: Returns a flat DTO binder with the given identifier converter and no custom relationship linkage mappers.
resourceBinder(JsonMapper, IdentifierConverter, Map<Class<?>, RelationshipLinkageMapper>) - Static method in class com.kazforge.jsonapi.jackson3.JsonApiJackson3: Returns a flat DTO binder with the given identifier converter and relationship linkage mappers keyed by relationship target class.
resourceMapper(JsonMapper) - Static method in class com.kazforge.jsonapi.jackson3.JsonApiJackson3: Returns a resource mapper with default identifier conversion.
resourceMapper(JsonMapper, IdentifierConverter) - Static method in class com.kazforge.jsonapi.jackson3.JsonApiJackson3: Returns a resource mapper with the given identifier converter.
resourceMapper(JsonMapper, IdentifierConverter, ResourceDecoratorRegistry) - Static method in class com.kazforge.jsonapi.jackson3.JsonApiJackson3: Returns a resource mapper with the given identifier converter and decoration registry.
resourceMapper(JsonMapper, ResourceDecoratorRegistry) - Static method in class com.kazforge.jsonapi.jackson3.JsonApiJackson3: Returns a resource mapper with default identifier conversion and the given decoration registry.
resources() - Method in class com.kazforge.jsonapi.jackson3.Jackson3JsonApi

T

toCollectionDocument(Iterable<?>) - Method in class com.kazforge.jsonapi.jackson3.JsonApiResourceMapper: Maps domain objects to a resource-collection document without envelope members.
toCollectionDocument(Iterable<?>, DocumentEnvelope) - Method in class com.kazforge.jsonapi.jackson3.JsonApiResourceMapper: Maps domain objects to a resource-collection document with optional envelope members.
toCollectionDocument(Iterable<?>, DocumentEnvelope, RepresentationSelection, RepresentationPolicy) - Method in class com.kazforge.jsonapi.jackson3.JsonApiResourceMapper: Maps a primary collection to a document with optional envelope members and explicit compound inclusion from selection governed by policy.
toCollectionDocument(Iterable<?>, JavaType, DocumentEnvelope) - Method in class com.kazforge.jsonapi.jackson3.JsonApiResourceMapper: Maps a homogeneous collection using a complete declared element type and optional envelope.
toCollectionDocument(Iterable<?>, JavaType, DocumentEnvelope, RepresentationSelection, RepresentationPolicy) - Method in class com.kazforge.jsonapi.jackson3.JsonApiResourceMapper: Maps a homogeneous collection with explicit compound inclusion using the complete declared element type supplied by the caller.
toDocument(Object) - Method in class com.kazforge.jsonapi.jackson3.JsonApiResourceMapper: Maps a domain object to a single-resource document without envelope members.
toDocument(Object, DocumentEnvelope) - Method in class com.kazforge.jsonapi.jackson3.JsonApiResourceMapper: Maps a domain object to a single-resource document with optional envelope members.
toDocument(Object, DocumentEnvelope, RepresentationSelection, RepresentationPolicy) - Method in class com.kazforge.jsonapi.jackson3.JsonApiResourceMapper: Maps a domain object to a document with optional envelope members and explicit compound inclusion from selection governed by policy.
toDocument(Object, JavaType, DocumentEnvelope) - Method in class com.kazforge.jsonapi.jackson3.JsonApiResourceMapper: Maps a domain object to a document using a complete declared type and optional envelope.
toDocument(Object, JavaType, DocumentEnvelope, RepresentationSelection, RepresentationPolicy) - Method in class com.kazforge.jsonapi.jackson3.JsonApiResourceMapper: Maps a domain object to a document with explicit inclusion using the complete declared Jackson type supplied by the caller.
toMappedCollectionDocument(Iterable<?>, DocumentEnvelope, RepresentationSelection, RepresentationPolicy) - Method in class com.kazforge.jsonapi.jackson3.JsonApiResourceMapper: Maps a primary collection with optional envelope members, compound inclusion, and sparse fieldsets from selection governed by policy.
toMappedCollectionDocument(Iterable<?>, JavaType, DocumentEnvelope, RepresentationSelection, RepresentationPolicy) - Method in class com.kazforge.jsonapi.jackson3.JsonApiResourceMapper: Maps a homogeneous collection with inclusion and sparse fieldsets using a complete declared type.
toMappedCreateDocument(Object, DocumentEnvelope, RepresentationSelection, RepresentationPolicy) - Method in class com.kazforge.jsonapi.jackson3.JsonApiResourceMapper: Maps a domain object for create-request authoring with optional envelope members, compound inclusion, and sparse fieldsets from selection governed by policy.
toMappedCreateDocument(Object, JavaType, DocumentEnvelope, RepresentationSelection, RepresentationPolicy) - Method in class com.kazforge.jsonapi.jackson3.JsonApiResourceMapper: Maps a domain object for create-request authoring using a complete declared type.
toMappedDocument(Object, DocumentEnvelope, RepresentationSelection, RepresentationPolicy) - Method in class com.kazforge.jsonapi.jackson3.JsonApiResourceMapper: Maps a domain object with optional envelope members, compound inclusion, and sparse fieldsets from selection governed by policy.
toMappedDocument(Object, JavaType, DocumentEnvelope, RepresentationSelection, RepresentationPolicy) - Method in class com.kazforge.jsonapi.jackson3.JsonApiResourceMapper: Maps a domain object with inclusion and sparse fieldsets using a complete declared type.
toResource(Object) - Method in class com.kazforge.jsonapi.jackson3.JsonApiResourceMapper: Maps a domain object using a Jackson type inferred from its concrete runtime class.
toResource(Object, JavaType) - Method in class com.kazforge.jsonapi.jackson3.JsonApiResourceMapper: Maps a domain object using the complete declared Jackson type supplied by the caller.

W

writer(JsonMapper) - Static method in class com.kazforge.jsonapi.jackson3.JsonApiJackson3: Returns a writer that validates with ValidationContext.defaults() then serializes documents using a derived codec-configured mapper.
writer(JsonMapper, ValidationContext) - Static method in class com.kazforge.jsonapi.jackson3.JsonApiJackson3: Returns a writer that validates with the given context then serializes documents using a derived codec-configured mapper.
writeValue(OutputStream, JsonApiDocument) - Method in class com.kazforge.jsonapi.jackson3.JsonApiDocumentWriter: Validates document against the bound context, then writes it to out.
writeValue(OutputStream, MappedDocument) - Method in class com.kazforge.jsonapi.jackson3.JsonApiDocumentWriter: Validates mapped.document() against the bound context composed with mapped's sparse-fieldset linkage exemptions, then writes it to out.
writeValue(Writer, JsonApiDocument) - Method in class com.kazforge.jsonapi.jackson3.JsonApiDocumentWriter: Validates document against the bound context, then writes it to out.
writeValue(Writer, MappedDocument) - Method in class com.kazforge.jsonapi.jackson3.JsonApiDocumentWriter: Validates mapped.document() against the bound context composed with mapped's sparse-fieldset linkage exemptions, then writes it to out.
writeValue(JsonGenerator, JsonApiDocument) - Method in class com.kazforge.jsonapi.jackson3.JsonApiDocumentWriter: Validates document against the bound context, then writes it through generator.
writeValue(JsonGenerator, MappedDocument) - Method in class com.kazforge.jsonapi.jackson3.JsonApiDocumentWriter: Validates mapped.document() against the bound context composed with mapped's sparse-fieldset linkage exemptions, then writes it through generator.
writeValueAsBytes(JsonApiDocument) - Method in class com.kazforge.jsonapi.jackson3.JsonApiDocumentWriter: Validates a plain document against the bound context, then returns its UTF-8 JSON bytes.
writeValueAsBytes(MappedDocument) - Method in class com.kazforge.jsonapi.jackson3.JsonApiDocumentWriter: Validates mapped.document() against the bound context composed with mapped's sparse-fieldset linkage exemptions, then returns the UTF-8 JSON bytes.
writeValueAsString(JsonApiDocument) - Method in class com.kazforge.jsonapi.jackson3.JsonApiDocumentWriter: Validates a plain document against the bound context, then returns its JSON string.
writeValueAsString(MappedDocument) - Method in class com.kazforge.jsonapi.jackson3.JsonApiDocumentWriter: Validates mapped.document() against the bound context composed with mapped's sparse-fieldset linkage exemptions, then returns the JSON string.

A B C D E F I J L M P R T W
All Classes and Interfaces|All Packages