Index (jsonapi-java-api 0.4.0 API)

A B C D E F H I J L M N O P R S T U V W
All Classes and Interfaces|All Packages|Serialized Form

A

AGGREGATE_VALIDATION - Enum constant in enum class com.kazforge.jsonapi.diagnostic.CodecFailureCategory: JsonApiDocumentValidator rejected the document.
allowAll() - Static method in class com.kazforge.jsonapi.representation.FieldPolicy: Permits every mapped fieldset field name.
allowAll() - Static method in class com.kazforge.jsonapi.representation.IncludePolicy: Permits every mapped relationship for inclusion traversal.
allowing(Set<FieldAllowance>) - Static method in class com.kazforge.jsonapi.representation.FieldPolicy: Permits only the given owner-type + field allowances.
allowing(Set<RelationshipAllowance>) - Static method in class com.kazforge.jsonapi.representation.IncludePolicy: Permits only the given owner-type + relationship allowances.
allows(String, String) - Method in class com.kazforge.jsonapi.representation.FieldPolicy: Returns whether a present fieldset may include fieldName on a resource whose JSON:API type is resourceType.
allows(String, String) - Method in class com.kazforge.jsonapi.representation.IncludePolicy: Returns whether inclusion traversal may follow relationshipName on a resource whose JSON:API type is ownerResourceType.
append(MappingLocation) - Method in class com.kazforge.jsonapi.diagnostic.MappingLocation: Structurally joins a relative location under this location: a document prefix such as /data/2 plus a resource-relative suffix such as /attributes/title yields /data/2/attributes/title.
append(String) - Method in class com.kazforge.jsonapi.diagnostic.MappingLocation: Returns a location addressing segment inside this location, escaping the segment.
asMap() - Method in class com.kazforge.jsonapi.mapping.ResourceDecoratorRegistry: Returns an unmodifiable view of the underlying map.
Atomic(Object) - Constructor for record class com.kazforge.jsonapi.patch.StructuredMemberState.Atomic: Creates an atomic supplied value.
AttributeChange(String, String, Object) - Constructor for record class com.kazforge.jsonapi.patch.PatchChange.AttributeChange: Creates an instance of a AttributeChange record class.

B

bindCommand(JsonApiDocument, Class<T>) - Method in interface com.kazforge.jsonapi.api.JsonApiPatches: Binds an already-validated update document into a PatchCommand without re-parsing or re-validating.
bindCommand(JsonApiDocument, Type) - Method in interface com.kazforge.jsonapi.api.JsonApiPatches: Binds an already-validated update document into a PatchCommand described by a full generic type without re-parsing or re-validating.
bindPatch(JsonApiDocument, Class<T>) - Method in interface com.kazforge.jsonapi.api.JsonApiPatches: Binds an already-validated update document into the caller's PATCH DTO without re-parsing or re-validating.
bindPatch(JsonApiDocument, Type) - Method in interface com.kazforge.jsonapi.api.JsonApiPatches: Binds an already-validated update document into a PATCH DTO described by a full generic type without re-parsing or re-validating.
build() - Method in class com.kazforge.jsonapi.mapping.ResourceDecoration.Builder: Builds an immutable decoration.
build() - Method in class com.kazforge.jsonapi.mapping.ResourceDecoratorRegistry.Builder: Builds an immutable registry.
build() - Method in class com.kazforge.jsonapi.mapping.ResourceTypeRegistry.Builder: Builds the registry, rejecting duplicate wire types.
build() - Method in class com.kazforge.jsonapi.representation.RepresentationSelection.Builder: Builds an immutable representation selection.
builder() - Static method in class com.kazforge.jsonapi.mapping.ResourceDecoration: Creates a builder for one immutable decoration.
builder() - Static method in class com.kazforge.jsonapi.mapping.ResourceDecoratorRegistry: Creates a builder for one immutable registry.
builder() - Static method in class com.kazforge.jsonapi.mapping.ResourceTypeRegistry: Returns an empty registry builder.
builder() - Static method in class com.kazforge.jsonapi.representation.RepresentationSelection: Creates a builder for one immutable selection.
Builder() - Constructor for class com.kazforge.jsonapi.mapping.ResourceTypeRegistry.Builder
byteOffset() - Method in record class com.kazforge.jsonapi.diagnostic.SourceLocation: Returns the value of the byteOffset record component.

C

category() - Method in exception class com.kazforge.jsonapi.diagnostic.JsonApiDocumentReadException: Decoding or validation stage that failed.
changes() - Method in record class com.kazforge.jsonapi.patch.PatchCommand: Returns the value of the changes record component.
charOffset() - Method in record class com.kazforge.jsonapi.diagnostic.SourceLocation: Returns the value of the charOffset record component.
CodecFailureCategory - Enum Class in com.kazforge.jsonapi.diagnostic: Stable decoding or validation stage for a JsonApiDocumentReadException.
columnNumber() - Method in record class com.kazforge.jsonapi.diagnostic.SourceLocation: Returns the value of the columnNumber record component.
com.kazforge.jsonapi.api - package com.kazforge.jsonapi.api: Backend-independent Level-1 JSON:API application operations.
com.kazforge.jsonapi.diagnostic - package com.kazforge.jsonapi.diagnostic: Stable backend-independent document-read and mapping diagnostic families.
com.kazforge.jsonapi.document - package com.kazforge.jsonapi.document: Backend-independent JSON:API document read/write contract values.
com.kazforge.jsonapi.mapping - package com.kazforge.jsonapi.mapping: Backend-independent application/domain mapping contracts and values.
com.kazforge.jsonapi.patch - package com.kazforge.jsonapi.patch: Backend-independent presence and requested-change contracts for resource PATCH.
com.kazforge.jsonapi.representation - package com.kazforge.jsonapi.representation: Backend-independent representation shaping and inclusion/fieldset contracts.
CONFLICTING_INCLUDED_REPRESENTATION - Enum constant in enum class com.kazforge.jsonapi.diagnostic.MappingDiagnostic
CONFLICTING_TYPE_REGISTRATION - Enum constant in enum class com.kazforge.jsonapi.diagnostic.MappingDiagnostic
convert(Object) - Method in interface com.kazforge.jsonapi.mapping.IdentifierConverter: Converts a raw identifier value to its string form.

D

decorate(T) - Method in interface com.kazforge.jsonapi.mapping.ResourceDecorator: Returns decoration for the given resource instance, or ResourceDecoration.empty() when no links are needed.
decoratorFor(Class<T>) - Method in class com.kazforge.jsonapi.mapping.ResourceDecoratorRegistry: Returns the decorator for the given raw domain class, if any, via an exact match on raw class.
defaults() - Static method in record class com.kazforge.jsonapi.api.ResourceWriteOptions: Returns options with no envelope members and no selection.
defaults() - Static method in interface com.kazforge.jsonapi.mapping.IdentifierConverter: Returns the built-in converter that delegates to Object.toString().
defaults() - Static method in record class com.kazforge.jsonapi.representation.RepresentationPolicy: Returns the default include and sparse-fieldset policy.
DENIED_FIELDSET_FIELD - Enum constant in enum class com.kazforge.jsonapi.diagnostic.MappingDiagnostic
DENIED_RELATIONSHIP_INCLUDE - Enum constant in enum class com.kazforge.jsonapi.diagnostic.MappingDiagnostic
denyAll() - Static method in class com.kazforge.jsonapi.representation.FieldPolicy: Rejects every fieldset field name.
denyAll() - Static method in class com.kazforge.jsonapi.representation.IncludePolicy: Rejects every relationship for inclusion traversal.
diagnostic() - Method in exception class com.kazforge.jsonapi.diagnostic.JsonApiMappingException
document() - Method in record class com.kazforge.jsonapi.mapping.MappedDocument: Returns the value of the document record component.
DocumentEnvelope - Record Class in com.kazforge.jsonapi.document: Optional top-level links, meta, and JSON:API object attached during domain mapping.
DocumentEnvelope(Links, Meta, JsonApiObject) - Constructor for record class com.kazforge.jsonapi.document.DocumentEnvelope: Creates an instance of a DocumentEnvelope record class.
DocumentReadContext - Record Class in com.kazforge.jsonapi.document: Immutable document-read contract with independent validation and decoding axes.
DocumentReadContext(ValidationContext, PrimaryDataKind) - Constructor for record class com.kazforge.jsonapi.document.DocumentReadContext: Creates an instance of a DocumentReadContext record class.
documents() - Method in interface com.kazforge.jsonapi.api.JsonApi: Raw/general document operations with explicit semantic context.
DomainData - Interface in com.kazforge.jsonapi.mapping: Primary data of a domain document envelope, preserving explicit null, single, and collection states.
DomainData.IdentifierCollection - Record Class in com.kazforge.jsonapi.mapping: A collection of core identifiers in wire order; defensive copy with unmodifiable view.
DomainData.NullData - Record Class in com.kazforge.jsonapi.mapping
DomainData.ResourceCollection - Record Class in com.kazforge.jsonapi.mapping: A collection of bound resource DTOs in wire order; defensive copy with unmodifiable view.
DomainData.SingleIdentifier - Record Class in com.kazforge.jsonapi.mapping: One core identifier as primary data; never DTO-bound.
DomainData.SingleResource - Record Class in com.kazforge.jsonapi.mapping: One bound resource DTO as primary data.
dotted() - Method in record class com.kazforge.jsonapi.representation.IncludePath: Returns the dotted JSON:API form of this path (for diagnostics).
dottedThrough(int) - Method in record class com.kazforge.jsonapi.representation.IncludePath: Returns the dotted form of the path prefix through segmentIndex (inclusive).
DUPLICATE_MEMBER - Enum constant in enum class com.kazforge.jsonapi.diagnostic.CodecFailureCategory: A JSON object repeated the same member name.
DUPLICATE_ROLE - Enum constant in enum class com.kazforge.jsonapi.diagnostic.MappingDiagnostic

E

empty() - Static method in record class com.kazforge.jsonapi.document.DocumentEnvelope: Returns an envelope with every member absent, not present-empty.
empty() - Static method in record class com.kazforge.jsonapi.mapping.RelationshipDecoration: Returns an empty relationship decoration (no links).
empty() - Static method in class com.kazforge.jsonapi.mapping.ResourceDecoration: Returns an empty decoration (no resource links, no relationship decorations).
empty() - Static method in class com.kazforge.jsonapi.mapping.ResourceDecoratorRegistry: Returns an empty registry (no decorators).
envelope() - Method in record class com.kazforge.jsonapi.api.ResourceWriteOptions: Returns the value of the envelope record component.
equals(Object) - Method in record class com.kazforge.jsonapi.api.ResourceCollectionDocument: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.kazforge.jsonapi.api.ResourceDocument: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.kazforge.jsonapi.api.ResourceWriteOptions: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in class com.kazforge.jsonapi.diagnostic.MappingLocation
equals(Object) - Method in record class com.kazforge.jsonapi.diagnostic.SourceLocation: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.kazforge.jsonapi.document.DocumentEnvelope: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.kazforge.jsonapi.document.DocumentReadContext: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.kazforge.jsonapi.mapping.DomainData.IdentifierCollection: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.kazforge.jsonapi.mapping.DomainData.NullData: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.kazforge.jsonapi.mapping.DomainData.ResourceCollection: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.kazforge.jsonapi.mapping.DomainData.SingleIdentifier: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.kazforge.jsonapi.mapping.DomainData.SingleResource: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.kazforge.jsonapi.mapping.MappedDocument: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.kazforge.jsonapi.mapping.RelationshipDecoration: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.kazforge.jsonapi.mapping.RelationshipLinkage: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in class com.kazforge.jsonapi.mapping.ResourceDecoration
equals(Object) - Method in record class com.kazforge.jsonapi.mapping.ResourceTypeRegistry.Registration: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.kazforge.jsonapi.patch.PatchChange.AttributeChange: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.kazforge.jsonapi.patch.PatchChange.RelationshipChange: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.kazforge.jsonapi.patch.PatchChange.RelationshipMetaChange: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.kazforge.jsonapi.patch.PatchChange.ResourceMetaChange: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.kazforge.jsonapi.patch.PatchCommand: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.kazforge.jsonapi.patch.PatchPresence.Omitted: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.kazforge.jsonapi.patch.PatchPresence.Present: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.kazforge.jsonapi.patch.StructuredMember: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.kazforge.jsonapi.patch.StructuredMemberState.Atomic: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.kazforge.jsonapi.patch.StructuredMemberState.Structured: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.kazforge.jsonapi.patch.StructuredPatch: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.kazforge.jsonapi.representation.FieldAllowance: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in class com.kazforge.jsonapi.representation.FieldPolicy
equals(Object) - Method in record class com.kazforge.jsonapi.representation.IncludePath: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in class com.kazforge.jsonapi.representation.IncludePolicy
equals(Object) - Method in record class com.kazforge.jsonapi.representation.RelationshipAllowance: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.kazforge.jsonapi.representation.RepresentationPolicy: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in class com.kazforge.jsonapi.representation.RepresentationSelection

F

FieldAllowance - Record Class in com.kazforge.jsonapi.representation: Allowance key for field-policy checks: owner JSON:API resource type plus attribute or relationship member name.
FieldAllowance(String, String) - Constructor for record class com.kazforge.jsonapi.representation.FieldAllowance: Creates an instance of a FieldAllowance record class.
fieldName() - Method in record class com.kazforge.jsonapi.representation.FieldAllowance: Returns the value of the fieldName record component.
fieldPolicy() - Method in record class com.kazforge.jsonapi.representation.RepresentationPolicy: Returns the value of the fieldPolicy record component.
FieldPolicy - Class in com.kazforge.jsonapi.representation: Application allow-list over (resourceType, fieldName) pairs for sparse fieldsets.
fields(String, String...) - Method in class com.kazforge.jsonapi.representation.RepresentationSelection.Builder: Selects fields for one resource type.
fields(String, List<String>) - Method in class com.kazforge.jsonapi.representation.RepresentationSelection.Builder: Selects fields for one resource type.
fieldsets() - Method in class com.kazforge.jsonapi.representation.RepresentationSelection: Sparse field names by JSON:API resource type, including explicitly empty fieldsets.
FIELDSETS_REQUIRE_MAPPED_DOCUMENT - Enum constant in enum class com.kazforge.jsonapi.diagnostic.MappingDiagnostic
find(ResourceIdentity) - Method in class com.kazforge.jsonapi.mapping.IncludedResources: Returns the bound DTO indexed under the given identity, if any.

H

hashCode() - Method in record class com.kazforge.jsonapi.api.ResourceCollectionDocument: Returns a hash code value for this object.
hashCode() - Method in record class com.kazforge.jsonapi.api.ResourceDocument: Returns a hash code value for this object.
hashCode() - Method in record class com.kazforge.jsonapi.api.ResourceWriteOptions: Returns a hash code value for this object.
hashCode() - Method in class com.kazforge.jsonapi.diagnostic.MappingLocation
hashCode() - Method in record class com.kazforge.jsonapi.diagnostic.SourceLocation: Returns a hash code value for this object.
hashCode() - Method in record class com.kazforge.jsonapi.document.DocumentEnvelope: Returns a hash code value for this object.
hashCode() - Method in record class com.kazforge.jsonapi.document.DocumentReadContext: Returns a hash code value for this object.
hashCode() - Method in record class com.kazforge.jsonapi.mapping.DomainData.IdentifierCollection: Returns a hash code value for this object.
hashCode() - Method in record class com.kazforge.jsonapi.mapping.DomainData.NullData: Returns a hash code value for this object.
hashCode() - Method in record class com.kazforge.jsonapi.mapping.DomainData.ResourceCollection: Returns a hash code value for this object.
hashCode() - Method in record class com.kazforge.jsonapi.mapping.DomainData.SingleIdentifier: Returns a hash code value for this object.
hashCode() - Method in record class com.kazforge.jsonapi.mapping.DomainData.SingleResource: Returns a hash code value for this object.
hashCode() - Method in record class com.kazforge.jsonapi.mapping.MappedDocument: Returns a hash code value for this object.
hashCode() - Method in record class com.kazforge.jsonapi.mapping.RelationshipDecoration: Returns a hash code value for this object.
hashCode() - Method in record class com.kazforge.jsonapi.mapping.RelationshipLinkage: Returns a hash code value for this object.
hashCode() - Method in class com.kazforge.jsonapi.mapping.ResourceDecoration
hashCode() - Method in record class com.kazforge.jsonapi.mapping.ResourceTypeRegistry.Registration: Returns a hash code value for this object.
hashCode() - Method in record class com.kazforge.jsonapi.patch.PatchChange.AttributeChange: Returns a hash code value for this object.
hashCode() - Method in record class com.kazforge.jsonapi.patch.PatchChange.RelationshipChange: Returns a hash code value for this object.
hashCode() - Method in record class com.kazforge.jsonapi.patch.PatchChange.RelationshipMetaChange: Returns a hash code value for this object.
hashCode() - Method in record class com.kazforge.jsonapi.patch.PatchChange.ResourceMetaChange: Returns a hash code value for this object.
hashCode() - Method in record class com.kazforge.jsonapi.patch.PatchCommand: Returns a hash code value for this object.
hashCode() - Method in record class com.kazforge.jsonapi.patch.PatchPresence.Omitted: Returns a hash code value for this object.
hashCode() - Method in record class com.kazforge.jsonapi.patch.PatchPresence.Present: Returns a hash code value for this object.
hashCode() - Method in record class com.kazforge.jsonapi.patch.StructuredMember: Returns a hash code value for this object.
hashCode() - Method in record class com.kazforge.jsonapi.patch.StructuredMemberState.Atomic: Returns a hash code value for this object.
hashCode() - Method in record class com.kazforge.jsonapi.patch.StructuredMemberState.Structured: Returns a hash code value for this object.
hashCode() - Method in record class com.kazforge.jsonapi.patch.StructuredPatch: Returns a hash code value for this object.
hashCode() - Method in record class com.kazforge.jsonapi.representation.FieldAllowance: Returns a hash code value for this object.
hashCode() - Method in class com.kazforge.jsonapi.representation.FieldPolicy
hashCode() - Method in record class com.kazforge.jsonapi.representation.IncludePath: Returns a hash code value for this object.
hashCode() - Method in class com.kazforge.jsonapi.representation.IncludePolicy
hashCode() - Method in record class com.kazforge.jsonapi.representation.RelationshipAllowance: Returns a hash code value for this object.
hashCode() - Method in record class com.kazforge.jsonapi.representation.RepresentationPolicy: Returns a hash code value for this object.
hashCode() - Method in class com.kazforge.jsonapi.representation.RepresentationSelection

I

identifier() - Method in record class com.kazforge.jsonapi.mapping.DomainData.SingleIdentifier: Returns the value of the identifier record component.
IDENTIFIER_CONVERSION_FAILED - Enum constant in enum class com.kazforge.jsonapi.diagnostic.MappingDiagnostic
IdentifierCollection(List<ResourceIdentifier>) - Constructor for record class com.kazforge.jsonapi.mapping.DomainData.IdentifierCollection: Creates an instance of a IdentifierCollection record class.
IdentifierConverter - Interface in com.kazforge.jsonapi.mapping: Converts a domain identifier value to its JSON:API string representation, and back.
identifierDefaults() - Static method in record class com.kazforge.jsonapi.document.DocumentReadContext: Identifier decoding with ValidationContext.defaults(); the endpoint role stays resource.
identifiers() - Method in record class com.kazforge.jsonapi.mapping.DomainData.IdentifierCollection: Returns the value of the identifiers record component.
identity() - Method in record class com.kazforge.jsonapi.patch.PatchCommand: Returns the value of the identity record component.
include(IncludePath) - Method in class com.kazforge.jsonapi.representation.RepresentationSelection.Builder: Adds one already-validated include path.
include(String) - Method in class com.kazforge.jsonapi.representation.RepresentationSelection.Builder: Parses and adds one dotted include path using IncludePath's validation.
INCLUDE_COUNT_EXCEEDED - Enum constant in enum class com.kazforge.jsonapi.diagnostic.MappingDiagnostic
INCLUDE_DEPTH_EXCEEDED - Enum constant in enum class com.kazforge.jsonapi.diagnostic.MappingDiagnostic
included() - Method in record class com.kazforge.jsonapi.api.ResourceCollectionDocument: Returns the value of the included record component.
included() - Method in record class com.kazforge.jsonapi.api.ResourceDocument: Returns the value of the included record component.
IncludedResources - Class in com.kazforge.jsonapi.mapping: Independently bound included resources of a domain document envelope.
IncludePath - Record Class in com.kazforge.jsonapi.representation: An ordered include path of JSON:API relationship names.
IncludePath(List<String>) - Constructor for record class com.kazforge.jsonapi.representation.IncludePath: Creates an instance of a IncludePath record class.
includePaths() - Method in class com.kazforge.jsonapi.representation.RepresentationSelection: Ordered include paths requested for compound-document traversal.
includePolicy() - Method in record class com.kazforge.jsonapi.representation.RepresentationPolicy: Returns the value of the includePolicy record component.
IncludePolicy - Class in com.kazforge.jsonapi.representation: Decides which relationships may be traversed for compound-document inclusion.
includeRequested() - Method in class com.kazforge.jsonapi.representation.RepresentationSelection.Builder: Records an explicit include request without adding an include path.
includeRequested() - Method in class com.kazforge.jsonapi.representation.RepresentationSelection: Returns whether the request explicitly supplied an include parameter.
INSTANCE - Static variable in record class com.kazforge.jsonapi.mapping.DomainData.NullData
INVALID_ATTRIBUTE_NAME - Enum constant in enum class com.kazforge.jsonapi.diagnostic.MappingDiagnostic
INVALID_DECORATION_STATE - Enum constant in enum class com.kazforge.jsonapi.diagnostic.MappingDiagnostic
INVALID_DECORATION_TARGET - Enum constant in enum class com.kazforge.jsonapi.diagnostic.MappingDiagnostic
INVALID_FIELDSET_FIELD - Enum constant in enum class com.kazforge.jsonapi.diagnostic.MappingDiagnostic
INVALID_IDENTIFIER_META_TARGET - Enum constant in enum class com.kazforge.jsonapi.diagnostic.MappingDiagnostic
INVALID_INCLUDE_PATH - Enum constant in enum class com.kazforge.jsonapi.diagnostic.MappingDiagnostic
INVALID_META_TARGET - Enum constant in enum class com.kazforge.jsonapi.diagnostic.MappingDiagnostic
INVALID_PATCH_PROPERTY_TYPE - Enum constant in enum class com.kazforge.jsonapi.diagnostic.MappingDiagnostic
INVALID_RELATIONSHIP_META_TARGET - Enum constant in enum class com.kazforge.jsonapi.diagnostic.MappingDiagnostic
INVALID_RELATIONSHIP_NAME - Enum constant in enum class com.kazforge.jsonapi.diagnostic.MappingDiagnostic
INVALID_RESOURCE_TYPE - Enum constant in enum class com.kazforge.jsonapi.diagnostic.MappingDiagnostic
isEmpty() - Method in record class com.kazforge.jsonapi.mapping.RelationshipDecoration: Returns true when this decoration carries no links.
isEmpty() - Method in class com.kazforge.jsonapi.mapping.ResourceDecoration: Returns true when this decoration carries neither resource nor relationship links.
isEmpty() - Method in class com.kazforge.jsonapi.mapping.ResourceDecoratorRegistry: Returns true when no decorators are registered.
isKnown() - Method in record class com.kazforge.jsonapi.diagnostic.SourceLocation: Returns whether at least one position component is available.
isOmitted() - Method in interface com.kazforge.jsonapi.patch.PatchPresence: Returns true when this state is PatchPresence.Omitted.

J

jsonapi() - Method in record class com.kazforge.jsonapi.api.ResourceCollectionDocument: Returns the value of the jsonapi record component.
jsonapi() - Method in record class com.kazforge.jsonapi.api.ResourceDocument: Returns the value of the jsonapi record component.
jsonapi() - Method in record class com.kazforge.jsonapi.document.DocumentEnvelope: Returns the value of the jsonapi record component.
JsonApi - Interface in com.kazforge.jsonapi.api: Backend-independent Level-1 JSON:API application entry point, currently implemented by the configured Jackson 3 runtime.
JsonApiDocumentReadException - Exception Class in com.kazforge.jsonapi.diagnostic: Failure while decoding or validating a JSON:API document.
JsonApiDocumentReadException(CodecFailureCategory, String, SourceLocation, ValidationRuleCode, String) - Constructor for exception class com.kazforge.jsonapi.diagnostic.JsonApiDocumentReadException
JsonApiDocumentReadException(CodecFailureCategory, String, SourceLocation, ValidationRuleCode, String, Throwable) - Constructor for exception class com.kazforge.jsonapi.diagnostic.JsonApiDocumentReadException
JsonApiDocumentReadException(CodecFailureCategory, String, SourceLocation, String) - Constructor for exception class com.kazforge.jsonapi.diagnostic.JsonApiDocumentReadException
JsonApiDocuments - Interface in com.kazforge.jsonapi.api: Level-1 raw/general JSON:API document operations.
JsonApiMappingException - Exception Class in com.kazforge.jsonapi.diagnostic: Backend-independent domain mapping, binding, registry, decoration, or representation failure.
JsonApiMappingException(MappingDiagnostic, Class<?>, MappingLocation) - Constructor for exception class com.kazforge.jsonapi.diagnostic.JsonApiMappingException
JsonApiMappingException(MappingDiagnostic, Class<?>, MappingLocation, String) - Constructor for exception class com.kazforge.jsonapi.diagnostic.JsonApiMappingException
JsonApiMappingException(MappingDiagnostic, Class<?>, MappingLocation, String, Throwable) - Constructor for exception class com.kazforge.jsonapi.diagnostic.JsonApiMappingException
JsonApiMappingException(MappingDiagnostic, String) - Constructor for exception class com.kazforge.jsonapi.diagnostic.JsonApiMappingException: Convenience constructor for failures with neither a resource class nor a member location.
jsonapiName() - Method in record class com.kazforge.jsonapi.patch.PatchChange.AttributeChange: Returns the value of the jsonapiName record component.
jsonapiName() - Method in interface com.kazforge.jsonapi.patch.PatchChange: Final JSON:API member name (including attribute/relationship renames).
jsonapiName() - Method in record class com.kazforge.jsonapi.patch.PatchChange.RelationshipChange: Returns the value of the jsonapiName record component.
jsonapiName() - Method in record class com.kazforge.jsonapi.patch.PatchChange.RelationshipMetaChange: Returns the value of the jsonapiName record component.
jsonapiName() - Method in record class com.kazforge.jsonapi.patch.PatchChange.ResourceMetaChange: Returns the value of the jsonapiName record component.
JsonApiPatches - Interface in com.kazforge.jsonapi.api: Level-1 presence-aware PATCH operations.
JsonApiRelationships - Interface in com.kazforge.jsonapi.api: Level-1 relationship-linkage document operations in both directions.
JsonApiResources - Interface in com.kazforge.jsonapi.api: Backend-independent Level-1 ordinary resource operations: strict homogeneous reads, single/collection writes, and create/update document authoring.
jsonApiType() - Method in record class com.kazforge.jsonapi.mapping.ResourceTypeRegistry.Registration: Returns the value of the jsonApiType record component.
jsonPointer() - Method in exception class com.kazforge.jsonapi.diagnostic.JsonApiDocumentReadException: Document-relative JSON Pointer; "" identifies the document root.

L

lineNumber() - Method in record class com.kazforge.jsonapi.diagnostic.SourceLocation: Returns the value of the lineNumber record component.
LINKAGE_MAPPING_FAILED - Enum constant in enum class com.kazforge.jsonapi.diagnostic.MappingDiagnostic
links() - Method in record class com.kazforge.jsonapi.api.ResourceCollectionDocument: Returns the value of the links record component.
links() - Method in record class com.kazforge.jsonapi.api.ResourceDocument: Returns the value of the links record component.
links() - Method in record class com.kazforge.jsonapi.document.DocumentEnvelope: Returns the value of the links record component.
links() - Method in record class com.kazforge.jsonapi.mapping.RelationshipDecoration: Returns the value of the links record component.
links() - Method in class com.kazforge.jsonapi.mapping.ResourceDecoration: Resource links to add, or null when none.
links(Links) - Static method in record class com.kazforge.jsonapi.mapping.RelationshipDecoration: Alias for RelationshipDecoration.of(Links) that reads fluently when decorating relationships.
links(Links) - Method in class com.kazforge.jsonapi.mapping.ResourceDecoration.Builder: Sets resource links (replaces any previous value).
LOCAL_VALIDATION - Enum constant in enum class com.kazforge.jsonapi.diagnostic.CodecFailureCategory: A public core constructor rejected the value (local validation).
location() - Method in exception class com.kazforge.jsonapi.diagnostic.JsonApiMappingException: The mapping location: a valid resource-relative or document-relative JSON Pointer when the failure has a meaningful member location, otherwise null.
logicalName() - Method in record class com.kazforge.jsonapi.patch.PatchChange.AttributeChange: Returns the value of the logicalName record component.
logicalName() - Method in interface com.kazforge.jsonapi.patch.PatchChange: Logical application-property identity on the annotated DTO (Java field, record component, or JavaBean name).
logicalName() - Method in record class com.kazforge.jsonapi.patch.PatchChange.RelationshipChange: Returns the value of the logicalName record component.
logicalName() - Method in record class com.kazforge.jsonapi.patch.PatchChange.RelationshipMetaChange: Returns the value of the logicalName record component.
logicalName() - Method in record class com.kazforge.jsonapi.patch.PatchChange.ResourceMetaChange: Returns the value of the logicalName record component.
logicalName() - Method in record class com.kazforge.jsonapi.patch.StructuredMember: Returns the value of the logicalName record component.

M

MALFORMED_JSON - Enum constant in enum class com.kazforge.jsonapi.diagnostic.CodecFailureCategory: Input is not well-formed JSON.
MappedDocument - Record Class in com.kazforge.jsonapi.mapping: Domain-mapping result that carries the produced document plus the identities of included resources whose inbound linkage was removed by an applied sparse fieldset during that mapping call.
MappedDocument(JsonApiDocument, Set<ResourceIdentity>) - Constructor for record class com.kazforge.jsonapi.mapping.MappedDocument: Creates an instance of a MappedDocument record class.
MappingDiagnostic - Enum Class in com.kazforge.jsonapi.diagnostic: Stable semantic codes for mapping, binding, registry, decoration, and representation failures.
MappingLocation - Class in com.kazforge.jsonapi.diagnostic: A validated mapping-diagnostic location: a JSON Pointer (RFC 6901) that is absent (null) on the owning JsonApiMappingException when no member location applies.
maxIncludeDepth() - Method in record class com.kazforge.jsonapi.representation.RepresentationPolicy: Returns the value of the maxIncludeDepth record component.
maxIncludedResources() - Method in record class com.kazforge.jsonapi.representation.RepresentationPolicy: Returns the value of the maxIncludedResources record component.
members() - Method in record class com.kazforge.jsonapi.patch.StructuredMemberState.Structured: Returns the value of the members record component.
members() - Method in record class com.kazforge.jsonapi.patch.StructuredPatch: Returns the value of the members record component.
meta() - Method in record class com.kazforge.jsonapi.api.ResourceCollectionDocument: Returns the value of the meta record component.
meta() - Method in record class com.kazforge.jsonapi.api.ResourceDocument: Returns the value of the meta record component.
meta() - Method in record class com.kazforge.jsonapi.document.DocumentEnvelope: Returns the value of the meta record component.
meta() - Method in record class com.kazforge.jsonapi.mapping.RelationshipLinkage: Returns the value of the meta record component.
MISSING_ACCESSOR - Enum constant in enum class com.kazforge.jsonapi.diagnostic.MappingDiagnostic
MISSING_CREATOR_INPUT - Enum constant in enum class com.kazforge.jsonapi.diagnostic.MappingDiagnostic
MISSING_IDENTIFIER - Enum constant in enum class com.kazforge.jsonapi.diagnostic.MappingDiagnostic
MISSING_RESOURCE_ANNOTATION - Enum constant in enum class com.kazforge.jsonapi.diagnostic.MappingDiagnostic

N

NAME_COLLISION - Enum constant in enum class com.kazforge.jsonapi.diagnostic.MappingDiagnostic
NON_DESERIALIZABLE_PROPERTY - Enum constant in enum class com.kazforge.jsonapi.diagnostic.MappingDiagnostic
none() - Static method in class com.kazforge.jsonapi.representation.RepresentationSelection: Returns the selection that requests neither inclusion nor sparse fieldsets.
NullData() - Constructor for record class com.kazforge.jsonapi.mapping.DomainData.NullData: Creates an instance of a NullData record class.

O

of(ValidationContext, PrimaryDataKind) - Static method in record class com.kazforge.jsonapi.document.DocumentReadContext
of(Links) - Static method in record class com.kazforge.jsonapi.mapping.RelationshipDecoration: Creates a decoration with the given links.
of(String) - Static method in record class com.kazforge.jsonapi.representation.IncludePath: Parses a dotted include path.
of(String, String) - Static method in record class com.kazforge.jsonapi.representation.FieldAllowance
of(String, String) - Static method in record class com.kazforge.jsonapi.representation.RelationshipAllowance
of(String, String...) - Static method in class com.kazforge.jsonapi.diagnostic.MappingLocation: Creates a location from one or more raw segments, escaping each segment per RFC 6901 before composition.
of(List<Object>, List<Set<ResourceIdentity>>) - Static method in class com.kazforge.jsonapi.mapping.IncludedResources: Creates an instance from wire-ordered bound DTOs and the identities declared for each wire-order position.
of(Map<Class<?>, ResourceDecorator<?>>) - Static method in class com.kazforge.jsonapi.mapping.ResourceDecoratorRegistry: Returns a registry copied from the given map (defensive copy, unmodifiable).
ofJsonApi(JsonApiObject) - Static method in record class com.kazforge.jsonapi.document.DocumentEnvelope: Returns an envelope containing only a jsonapi object, or no members when null.
ofLinks(Links) - Static method in record class com.kazforge.jsonapi.document.DocumentEnvelope: Returns an envelope containing only links, or no members when null.
ofLinks(Links) - Static method in class com.kazforge.jsonapi.mapping.ResourceDecoration: Returns a decoration that contributes only resource links.
ofMeta(Meta) - Static method in record class com.kazforge.jsonapi.document.DocumentEnvelope: Returns an envelope containing only metadata, or no members when null.
omitted() - Static method in interface com.kazforge.jsonapi.patch.PatchPresence: Returns an PatchPresence.Omitted instance for T.
Omitted() - Constructor for record class com.kazforge.jsonapi.patch.PatchPresence.Omitted: Creates an instance of a Omitted record class.

P

parse(String) - Method in interface com.kazforge.jsonapi.mapping.IdentifierConverter: Parses a JSON:API identifier string back into a value for the identifier property.
parse(String) - Static method in class com.kazforge.jsonapi.diagnostic.MappingLocation: Parses an already-escaped pointer string.
PatchChange - Interface in com.kazforge.jsonapi.patch: Backend-independent requested change in a PatchCommand: a supplied mapped attribute, relationship, or resource-side meta location.
PatchChange.AttributeChange - Record Class in com.kazforge.jsonapi.patch: A supplied mapped attribute change.
PatchChange.RelationshipChange - Record Class in com.kazforge.jsonapi.patch: A supplied mapped relationship linkage replacement.
PatchChange.RelationshipMetaChange - Record Class in com.kazforge.jsonapi.patch: A supplied relationship meta change for a specific mapped relationship.
PatchChange.ResourceMetaChange - Record Class in com.kazforge.jsonapi.patch: A supplied resource-side meta change.
PatchCommand<T> - Record Class in com.kazforge.jsonapi.patch: Immutable presence-aware resource-update command parameterized by the annotated DTO type T.
PatchCommand(Class<T>, Object, List<PatchChange>) - Constructor for record class com.kazforge.jsonapi.patch.PatchCommand: Creates an instance of a PatchCommand record class.
patches() - Method in interface com.kazforge.jsonapi.api.JsonApi: Presence-aware PATCH binding: typed DTOs and low-level commands.
PatchPresence<T> - Interface in com.kazforge.jsonapi.patch: Backend-independent tri-state presence for a single patchable PATCH DTO member.
PatchPresence.Omitted<T> - Record Class in com.kazforge.jsonapi.patch: The member was omitted from the update document; no requested change.
PatchPresence.Present<T> - Record Class in com.kazforge.jsonapi.patch: The member was supplied.
pointer() - Method in class com.kazforge.jsonapi.diagnostic.MappingLocation: Returns the canonical pointer text; never empty, always starting with /.
present(T) - Static method in interface com.kazforge.jsonapi.patch.PatchPresence: Returns a PatchPresence.Present instance for T; value may be null.
Present(T) - Constructor for record class com.kazforge.jsonapi.patch.PatchPresence.Present: Creates an instance of a Present record class.
primaryDataKind() - Method in record class com.kazforge.jsonapi.document.DocumentReadContext: Returns the value of the primaryDataKind record component.
PrimaryDataKind - Enum Class in com.kazforge.jsonapi.document: Explicit interpretation of top-level primary data objects and arrays.
propertyPath() - Method in exception class com.kazforge.jsonapi.diagnostic.JsonApiMappingException: The pointer text of JsonApiMappingException.location() when present, otherwise null.

R

read(InputStream, DocumentReadContext) - Method in interface com.kazforge.jsonapi.api.JsonApiDocuments: Stream variant of JsonApiDocuments.read(String, DocumentReadContext).
read(String, DocumentReadContext) - Method in interface com.kazforge.jsonapi.api.JsonApiDocuments: Decodes and validates one document under the given read context.
readCommand(InputStream, Class<T>) - Method in interface com.kazforge.jsonapi.api.JsonApiPatches: Stream variant of JsonApiPatches.readCommand(String, Class).
readCommand(InputStream, Type) - Method in interface com.kazforge.jsonapi.api.JsonApiPatches: Stream variant of JsonApiPatches.readCommand(String, Type).
readCommand(String, Class<T>) - Method in interface com.kazforge.jsonapi.api.JsonApiPatches: Decodes, validates as an update request, and binds only the supplied changes into a PatchCommand.
readCommand(String, Type) - Method in interface com.kazforge.jsonapi.api.JsonApiPatches: Decodes, validates as an update request, and binds only the supplied changes into a PatchCommand described by a full generic type.
readCreate(InputStream, Class<T>) - Method in interface com.kazforge.jsonapi.api.JsonApiResources: Stream variant of JsonApiResources.readCreate(String, Class).
readCreate(InputStream, Type) - Method in interface com.kazforge.jsonapi.api.JsonApiResources: Stream variant of JsonApiResources.readCreate(String, Type).
readCreate(String, Class<T>) - Method in interface com.kazforge.jsonapi.api.JsonApiResources: Reads exactly one primary resource DTO using core CREATE_REQUEST validation.
readCreate(String, Type) - Method in interface com.kazforge.jsonapi.api.JsonApiResources: Generic-target variant of JsonApiResources.readCreate(String, Class).
readMany(InputStream, Class<T>) - Method in interface com.kazforge.jsonapi.api.JsonApiResources: Stream variant of JsonApiResources.readMany(String, Class).
readMany(InputStream, Type) - Method in interface com.kazforge.jsonapi.api.JsonApiResources: Stream variant of JsonApiResources.readMany(String, Type).
readMany(String, Class<T>) - Method in interface com.kazforge.jsonapi.api.JsonApiResources: Reads a resource collection.
readMany(String, Type) - Method in interface com.kazforge.jsonapi.api.JsonApiResources: Reads a resource collection using a full generic element type.
readManyDocument(InputStream, Class<T>) - Method in interface com.kazforge.jsonapi.api.JsonApiResources: Stream variant of JsonApiResources.readManyDocument(String, Class).
readManyDocument(String, Class<T>) - Method in interface com.kazforge.jsonapi.api.JsonApiResources: Reads a resource collection together with top-level document state.
readOne(InputStream, Class<T>) - Method in interface com.kazforge.jsonapi.api.JsonApiResources: Stream variant of JsonApiResources.readOne(String, Class).
readOne(InputStream, Type) - Method in interface com.kazforge.jsonapi.api.JsonApiResources: Stream variant of JsonApiResources.readOne(String, Type).
readOne(String, Class<T>) - Method in interface com.kazforge.jsonapi.api.JsonApiResources: Reads exactly one resource DTO.
readOne(String, Type) - Method in interface com.kazforge.jsonapi.api.JsonApiResources: Reads exactly one resource DTO using a full generic type.
readOneDocument(InputStream, Class<T>) - Method in interface com.kazforge.jsonapi.api.JsonApiResources: Stream variant of JsonApiResources.readOneDocument(String, Class).
readOneDocument(String, Class<T>) - Method in interface com.kazforge.jsonapi.api.JsonApiResources: Reads one resource DTO together with top-level document state.
readPatch(InputStream, Class<T>) - Method in interface com.kazforge.jsonapi.api.JsonApiPatches: Stream variant of JsonApiPatches.readPatch(String, Class).
readPatch(InputStream, Type) - Method in interface com.kazforge.jsonapi.api.JsonApiPatches: Stream variant of JsonApiPatches.readPatch(String, Type).
readPatch(String, Class<T>) - Method in interface com.kazforge.jsonapi.api.JsonApiPatches: Decodes, validates as an update request, and binds the document directly into the caller's PATCH DTO.
readPatch(String, Type) - Method in interface com.kazforge.jsonapi.api.JsonApiPatches: Decodes, validates as an update request, and binds the document into a PATCH DTO described by a full generic type.
readToMany(InputStream) - Method in interface com.kazforge.jsonapi.api.JsonApiRelationships: Stream variant of JsonApiRelationships.readToMany(String).
readToMany(String) - Method in interface com.kazforge.jsonapi.api.JsonApiRelationships: Reads a to-many linkage document, including the empty collection.
readToOne(InputStream) - Method in interface com.kazforge.jsonapi.api.JsonApiRelationships: Stream variant of JsonApiRelationships.readToOne(String).
readToOne(String) - Method in interface com.kazforge.jsonapi.api.JsonApiRelationships: Reads a to-one linkage document.
register(Class<T>, ResourceDecorator<? super T>) - Method in class com.kazforge.jsonapi.mapping.ResourceDecoratorRegistry.Builder: Registers a decorator for the given domain class.
register(String, Class<?>) - Method in class com.kazforge.jsonapi.mapping.ResourceTypeRegistry.Builder: Registers a raw Java class under the explicitly supplied wire type.
register(String, Type) - Method in class com.kazforge.jsonapi.mapping.ResourceTypeRegistry.Builder: Registers any Java reflection type, including parameterized types.
Registration(String, Type) - Constructor for record class com.kazforge.jsonapi.mapping.ResourceTypeRegistry.Registration: Creates an instance of a Registration record class.
registrations() - Method in class com.kazforge.jsonapi.mapping.ResourceTypeRegistry: Returns registrations in their deterministic insertion order.
relationship(String, Links) - Method in class com.kazforge.jsonapi.mapping.ResourceDecoration.Builder: Convenience that builds a RelationshipDecoration from the given links.
relationship(String, RelationshipDecoration) - Method in class com.kazforge.jsonapi.mapping.ResourceDecoration.Builder: Adds decoration for one mapped relationship property identity (logical name).
RELATIONSHIP_CARDINALITY_MISMATCH - Enum constant in enum class com.kazforge.jsonapi.diagnostic.MappingDiagnostic
RelationshipAllowance - Record Class in com.kazforge.jsonapi.representation: Allowance key for include-policy checks: owner JSON:API resource type plus relationship name.
RelationshipAllowance(String, String) - Constructor for record class com.kazforge.jsonapi.representation.RelationshipAllowance: Creates an instance of a RelationshipAllowance record class.
RelationshipChange(String, String, Object) - Constructor for record class com.kazforge.jsonapi.patch.PatchChange.RelationshipChange: Creates an instance of a RelationshipChange record class.
RelationshipDecoration - Record Class in com.kazforge.jsonapi.mapping: Additive relationship-level decoration for domain writes.
RelationshipDecoration(Links) - Constructor for record class com.kazforge.jsonapi.mapping.RelationshipDecoration: Creates an instance of a RelationshipDecoration record class.
RelationshipLinkage<T,M> - Record Class in com.kazforge.jsonapi.mapping: Opt-in application-owned wrapper for one relationship linkage occurrence that carries identifier meta.
RelationshipLinkage(T, M) - Constructor for record class com.kazforge.jsonapi.mapping.RelationshipLinkage: Creates an instance of a RelationshipLinkage record class.
RelationshipMetaChange(String, String, Object) - Constructor for record class com.kazforge.jsonapi.patch.PatchChange.RelationshipMetaChange: Creates an instance of a RelationshipMetaChange record class.
relationshipName() - Method in record class com.kazforge.jsonapi.representation.RelationshipAllowance: Returns the value of the relationshipName record component.
relationships() - Method in interface com.kazforge.jsonapi.api.JsonApi: Relationship-linkage document reads and writes.
relationships() - Method in class com.kazforge.jsonapi.mapping.ResourceDecoration: Relationship decorations by mapped property identity (logical name), unmodifiable.
RepresentationPolicy - Record Class in com.kazforge.jsonapi.representation: Immutable application/runtime policy applied to a per-operation RepresentationSelection.
RepresentationPolicy(IncludePolicy, FieldPolicy, int, int) - Constructor for record class com.kazforge.jsonapi.representation.RepresentationPolicy: Creates an instance of a RepresentationPolicy record class.
RepresentationSelection - Class in com.kazforge.jsonapi.representation: Backend-independent immutable per-operation selection of include paths and sparse fieldsets.
RepresentationSelection.Builder - Class in com.kazforge.jsonapi.representation: Mutable builder whose RepresentationSelection.Builder.build() result defensively copies all supplied values.
resolve(String) - Method in class com.kazforge.jsonapi.mapping.ResourceTypeRegistry: Resolves a wire type, or returns null when it is not registered.
resource() - Method in record class com.kazforge.jsonapi.api.ResourceDocument: Returns the value of the resource record component.
resource() - Method in record class com.kazforge.jsonapi.mapping.DomainData.SingleResource: Returns the value of the resource record component.
RESOURCE - Enum constant in enum class com.kazforge.jsonapi.document.PrimaryDataKind: Decode primary data as ResourceObject / resource collections.
RESOURCE_IDENTIFIER - Enum constant in enum class com.kazforge.jsonapi.document.PrimaryDataKind: Decode primary data as ResourceIdentifier / identifier collections.
RESOURCE_TYPE_MISMATCH - Enum constant in enum class com.kazforge.jsonapi.diagnostic.MappingDiagnostic
resourceClass() - Method in exception class com.kazforge.jsonapi.diagnostic.JsonApiMappingException
ResourceCollection(List<Object>) - Constructor for record class com.kazforge.jsonapi.mapping.DomainData.ResourceCollection: Creates an instance of a ResourceCollection record class.
ResourceCollectionDocument<T> - Record Class in com.kazforge.jsonapi.api: Level-1 typed read result for a resource collection plus selected document-level state.
ResourceCollectionDocument(List<T>, Meta, Links, JsonApiObject, List<ResourceObject>) - Constructor for record class com.kazforge.jsonapi.api.ResourceCollectionDocument: Creates an instance of a ResourceCollectionDocument record class.
ResourceDecoration - Class in com.kazforge.jsonapi.mapping: Backend-independent additive resource-level decoration for domain writes.
ResourceDecoration.Builder - Class in com.kazforge.jsonapi.mapping: Mutable builder whose ResourceDecoration.Builder.build() result defensively copies supplied values.
ResourceDecorator<T> - Interface in com.kazforge.jsonapi.mapping: Backend-independent application-provided decoration for JSON:API resource links during domain writes.
ResourceDecoratorRegistry - Class in com.kazforge.jsonapi.mapping: Immutable registry of ResourceDecorator instances keyed by application domain type.
ResourceDecoratorRegistry.Builder - Class in com.kazforge.jsonapi.mapping: Mutable builder whose ResourceDecoratorRegistry.Builder.build() result defensively copies supplied values.
resourceDefaults() - Static method in record class com.kazforge.jsonapi.document.DocumentReadContext: Resource decoding with ValidationContext.defaults().
ResourceDocument<T> - Record Class in com.kazforge.jsonapi.api: Level-1 typed read result for one resource plus selected document-level state.
ResourceDocument(T, Meta, Links, JsonApiObject, List<ResourceObject>) - Constructor for record class com.kazforge.jsonapi.api.ResourceDocument: Creates an instance of a ResourceDocument record class.
ResourceMetaChange(String, String, Object) - Constructor for record class com.kazforge.jsonapi.patch.PatchChange.ResourceMetaChange: Creates an instance of a ResourceMetaChange record class.
resources() - Method in interface com.kazforge.jsonapi.api.JsonApi: Ordinary resource reads, writes, and create/update authoring.
resources() - Method in record class com.kazforge.jsonapi.api.ResourceCollectionDocument: Returns the value of the resources record component.
resources() - Method in record class com.kazforge.jsonapi.mapping.DomainData.ResourceCollection: Returns the value of the resources record component.
resources() - Method in class com.kazforge.jsonapi.mapping.IncludedResources: Bound DTOs in wire order; unmodifiable.
resourceType() - Method in record class com.kazforge.jsonapi.patch.PatchCommand: Returns the value of the resourceType record component.
resourceType() - Method in record class com.kazforge.jsonapi.representation.FieldAllowance: Returns the value of the resourceType record component.
resourceType() - Method in record class com.kazforge.jsonapi.representation.RelationshipAllowance: Returns the value of the resourceType record component.
ResourceTypeRegistry - Class in com.kazforge.jsonapi.mapping: Immutable, explicit mapping from JSON:API resource types to Java target types.
ResourceTypeRegistry.Builder - Class in com.kazforge.jsonapi.mapping: Builder for one immutable registry.
ResourceTypeRegistry.Registration - Record Class in com.kazforge.jsonapi.mapping: One explicit wire-type to Java-type registration.
ResourceWriteOptions - Record Class in com.kazforge.jsonapi.api: Backend-independent ordinary resource-write options composing existing neutral semantics.
ResourceWriteOptions(DocumentEnvelope, RepresentationSelection) - Constructor for record class com.kazforge.jsonapi.api.ResourceWriteOptions: Creates an instance of a ResourceWriteOptions record class.
ruleCode() - Method in exception class com.kazforge.jsonapi.diagnostic.JsonApiDocumentReadException: Core validation rule when one was reported, otherwise null.

S

segments() - Method in record class com.kazforge.jsonapi.representation.IncludePath: Returns the value of the segments record component.
selection() - Method in record class com.kazforge.jsonapi.api.ResourceWriteOptions: Returns the value of the selection record component.
SingleIdentifier(ResourceIdentifier) - Constructor for record class com.kazforge.jsonapi.mapping.DomainData.SingleIdentifier: Creates an instance of a SingleIdentifier record class.
SingleResource(Object) - Constructor for record class com.kazforge.jsonapi.mapping.DomainData.SingleResource: Creates an instance of a SingleResource record class.
size() - Method in class com.kazforge.jsonapi.mapping.ResourceDecoratorRegistry: Returns the number of registered decorators.
sourceLocation() - Method in exception class com.kazforge.jsonapi.diagnostic.JsonApiDocumentReadException: Best-effort payload-safe source position, or SourceLocation.UNKNOWN.
SourceLocation - Record Class in com.kazforge.jsonapi.diagnostic: Backend-independent payload-safe source position for a document-read diagnostic.
SourceLocation(int, int, long, long) - Constructor for record class com.kazforge.jsonapi.diagnostic.SourceLocation: Creates an instance of a SourceLocation record class.
sparseFieldsetLinkageExemptions() - Method in record class com.kazforge.jsonapi.mapping.MappedDocument: Returns the value of the sparseFieldsetLinkageExemptions record component.
state() - Method in record class com.kazforge.jsonapi.patch.StructuredMember: Returns the value of the state record component.
Structured(List<StructuredMember>) - Constructor for record class com.kazforge.jsonapi.patch.StructuredMemberState.Structured: Creates an instance of a Structured record class.
StructuredMember - Record Class in com.kazforge.jsonapi.patch: Backend-independent supplied nested member of a StructuredPatch.
StructuredMember(String, String, StructuredMemberState) - Constructor for record class com.kazforge.jsonapi.patch.StructuredMember: Creates an instance of a StructuredMember record class.
StructuredMemberState - Interface in com.kazforge.jsonapi.patch: Sealed state algebra for one supplied nested StructuredMember of a StructuredPatch.
StructuredMemberState.Atomic - Record Class in com.kazforge.jsonapi.patch: A supplied atomic nested value.
StructuredMemberState.Structured - Record Class in com.kazforge.jsonapi.patch: A supplied structured nested value; an empty list is a supplied empty structured object.
StructuredPatch - Record Class in com.kazforge.jsonapi.patch: Backend-independent low-level requested-change payload for a supplied structured value.
StructuredPatch(List<StructuredMember>) - Constructor for record class com.kazforge.jsonapi.patch.StructuredPatch: Creates an instance of a StructuredPatch record class.

T

target() - Method in record class com.kazforge.jsonapi.mapping.RelationshipLinkage: Returns the value of the target record component.
targetType() - Method in record class com.kazforge.jsonapi.mapping.ResourceTypeRegistry.Registration: Returns the value of the targetType record component.
toString() - Method in record class com.kazforge.jsonapi.api.ResourceCollectionDocument: Returns a string representation of this record class.
toString() - Method in record class com.kazforge.jsonapi.api.ResourceDocument: Returns a string representation of this record class.
toString() - Method in record class com.kazforge.jsonapi.api.ResourceWriteOptions: Returns a string representation of this record class.
toString() - Method in class com.kazforge.jsonapi.diagnostic.MappingLocation
toString() - Method in record class com.kazforge.jsonapi.diagnostic.SourceLocation: Returns a string representation of this record class.
toString() - Method in record class com.kazforge.jsonapi.document.DocumentEnvelope: Returns a string representation of this record class.
toString() - Method in record class com.kazforge.jsonapi.document.DocumentReadContext: Returns a string representation of this record class.
toString() - Method in record class com.kazforge.jsonapi.mapping.DomainData.IdentifierCollection: Returns a string representation of this record class.
toString() - Method in record class com.kazforge.jsonapi.mapping.DomainData.NullData: Returns a string representation of this record class.
toString() - Method in record class com.kazforge.jsonapi.mapping.DomainData.ResourceCollection: Returns a string representation of this record class.
toString() - Method in record class com.kazforge.jsonapi.mapping.DomainData.SingleIdentifier: Returns a string representation of this record class.
toString() - Method in record class com.kazforge.jsonapi.mapping.DomainData.SingleResource: Returns a string representation of this record class.
toString() - Method in record class com.kazforge.jsonapi.mapping.MappedDocument: Returns a string representation of this record class.
toString() - Method in record class com.kazforge.jsonapi.mapping.RelationshipDecoration: Returns a string representation of this record class.
toString() - Method in record class com.kazforge.jsonapi.mapping.RelationshipLinkage: Returns a string representation of this record class.
toString() - Method in class com.kazforge.jsonapi.mapping.ResourceDecoration
toString() - Method in record class com.kazforge.jsonapi.mapping.ResourceTypeRegistry.Registration: Returns a string representation of this record class.
toString() - Method in record class com.kazforge.jsonapi.patch.PatchChange.AttributeChange: Returns a string representation of this record class.
toString() - Method in record class com.kazforge.jsonapi.patch.PatchChange.RelationshipChange: Returns a string representation of this record class.
toString() - Method in record class com.kazforge.jsonapi.patch.PatchChange.RelationshipMetaChange: Returns a string representation of this record class.
toString() - Method in record class com.kazforge.jsonapi.patch.PatchChange.ResourceMetaChange: Returns a string representation of this record class.
toString() - Method in record class com.kazforge.jsonapi.patch.PatchCommand: Returns a string representation of this record class.
toString() - Method in record class com.kazforge.jsonapi.patch.PatchPresence.Omitted: Returns a string representation of this record class.
toString() - Method in record class com.kazforge.jsonapi.patch.PatchPresence.Present: Returns a string representation of this record class.
toString() - Method in record class com.kazforge.jsonapi.patch.StructuredMember: Returns a string representation of this record class.
toString() - Method in record class com.kazforge.jsonapi.patch.StructuredMemberState.Atomic: Returns a string representation of this record class.
toString() - Method in record class com.kazforge.jsonapi.patch.StructuredMemberState.Structured: Returns a string representation of this record class.
toString() - Method in record class com.kazforge.jsonapi.patch.StructuredPatch: Returns a string representation of this record class.
toString() - Method in record class com.kazforge.jsonapi.representation.FieldAllowance: Returns a string representation of this record class.
toString() - Method in record class com.kazforge.jsonapi.representation.IncludePath: Returns a string representation of this record class.
toString() - Method in record class com.kazforge.jsonapi.representation.RelationshipAllowance: Returns a string representation of this record class.
toString() - Method in record class com.kazforge.jsonapi.representation.RepresentationPolicy: Returns a string representation of this record class.

U

UNEXPECTED_TOKEN - Enum constant in enum class com.kazforge.jsonapi.diagnostic.CodecFailureCategory: A JSON token was present where a different token kind was required.
UNKNOWN - Static variable in record class com.kazforge.jsonapi.diagnostic.SourceLocation: Location when the current backend did not report a usable position.
UNKNOWN_PATCH_MEMBER - Enum constant in enum class com.kazforge.jsonapi.diagnostic.MappingDiagnostic
UNREGISTERED_RESOURCE_TYPE - Enum constant in enum class com.kazforge.jsonapi.diagnostic.MappingDiagnostic
UNRESOLVED_GENERIC_TYPE - Enum constant in enum class com.kazforge.jsonapi.diagnostic.MappingDiagnostic
UNRESOLVED_RELATIONSHIP_META - Enum constant in enum class com.kazforge.jsonapi.diagnostic.MappingDiagnostic
UNSUPPORTED_ATTRIBUTE_VALUE - Enum constant in enum class com.kazforge.jsonapi.diagnostic.MappingDiagnostic
UNSUPPORTED_RELATIONSHIP_COLLECTION_TYPE - Enum constant in enum class com.kazforge.jsonapi.diagnostic.MappingDiagnostic
UNSUPPORTED_RELATIONSHIP_TARGET - Enum constant in enum class com.kazforge.jsonapi.diagnostic.MappingDiagnostic
UNSUPPORTED_RELATIONSHIP_VALUE - Enum constant in enum class com.kazforge.jsonapi.diagnostic.MappingDiagnostic

V

validationContext() - Method in record class com.kazforge.jsonapi.document.DocumentReadContext: Returns the value of the validationContext record component.
value() - Method in record class com.kazforge.jsonapi.patch.PatchChange.AttributeChange: Returns the value of the value record component.
value() - Method in record class com.kazforge.jsonapi.patch.PatchChange.RelationshipChange: Returns the value of the value record component.
value() - Method in record class com.kazforge.jsonapi.patch.PatchChange.RelationshipMetaChange: Returns the value of the value record component.
value() - Method in record class com.kazforge.jsonapi.patch.PatchChange.ResourceMetaChange: Returns the value of the value record component.
value() - Method in interface com.kazforge.jsonapi.patch.PatchChange: Converted property value; null means explicit null / null linkage, not omission.
value() - Method in record class com.kazforge.jsonapi.patch.PatchPresence.Present: Returns the value of the value record component.
value() - Method in record class com.kazforge.jsonapi.patch.StructuredMemberState.Atomic: Returns the value of the value record component.
valueOf(String) - Static method in enum class com.kazforge.jsonapi.diagnostic.CodecFailureCategory: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.kazforge.jsonapi.diagnostic.MappingDiagnostic: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.kazforge.jsonapi.document.PrimaryDataKind: Returns the enum constant of this class with the specified name.
values() - Static method in enum class com.kazforge.jsonapi.diagnostic.CodecFailureCategory: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.kazforge.jsonapi.diagnostic.MappingDiagnostic: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.kazforge.jsonapi.document.PrimaryDataKind: Returns an array containing the constants of this enum class, in the order they are declared.

W

wireName() - Method in record class com.kazforge.jsonapi.patch.StructuredMember: Returns the value of the wireName record component.
withEnvelope(DocumentEnvelope) - Method in record class com.kazforge.jsonapi.api.ResourceWriteOptions: Returns options with the given envelope and this selection.
withFieldPolicy(FieldPolicy) - Method in record class com.kazforge.jsonapi.representation.RepresentationPolicy
withIncludePolicy(IncludePolicy) - Method in record class com.kazforge.jsonapi.representation.RepresentationPolicy
withJsonApi(JsonApiObject) - Method in record class com.kazforge.jsonapi.document.DocumentEnvelope: Returns a copy replacing the jsonapi object, or omitting it when null.
withLinks(Links) - Method in record class com.kazforge.jsonapi.document.DocumentEnvelope: Returns a copy replacing links, or omitting them when null.
withMaxIncludeDepth(int) - Method in record class com.kazforge.jsonapi.representation.RepresentationPolicy
withMaxIncludedResources(int) - Method in record class com.kazforge.jsonapi.representation.RepresentationPolicy
withMeta(Meta) - Method in record class com.kazforge.jsonapi.document.DocumentEnvelope: Returns a copy replacing metadata, or omitting it when null.
withoutLocation(MappingDiagnostic, Class<?>, String) - Static method in exception class com.kazforge.jsonapi.diagnostic.JsonApiMappingException: Factory for failures that explicitly carry no member location (for example missing annotations or registry conflicts); identifying names belong in the message per the class contract.
withPrimaryDataKind(PrimaryDataKind) - Method in record class com.kazforge.jsonapi.document.DocumentReadContext: Returns a copy with the given primary-data decoding kind and the same validation policy.
withSelection(RepresentationSelection) - Method in record class com.kazforge.jsonapi.api.ResourceWriteOptions: Returns options with the given selection and this envelope.
withValidationContext(ValidationContext) - Method in record class com.kazforge.jsonapi.document.DocumentReadContext: Returns a copy with the given validation policy and the same primary-data decoding kind.
write(JsonApiDocument) - Method in interface com.kazforge.jsonapi.api.JsonApiDocuments: Validates a document as response/other usage, then returns its JSON.
write(JsonApiDocument, OutputStream) - Method in interface com.kazforge.jsonapi.api.JsonApiDocuments: Validates a document as response/other usage, then writes it to the given stream.
write(MappedDocument) - Method in interface com.kazforge.jsonapi.api.JsonApiDocuments: Validates a mapped document as response/other usage against the bound context composed with its sparse-fieldset linkage provenance, then returns its JSON.
write(MappedDocument, OutputStream) - Method in interface com.kazforge.jsonapi.api.JsonApiDocuments: Validates a mapped document as response/other usage against the bound context composed with its sparse-fieldset linkage provenance, then writes it to the given stream.
writeCreateDocument(Object) - Method in interface com.kazforge.jsonapi.api.JsonApiResources: Authors a create-request document for one resource with default options and returns its JSON.
writeCreateDocument(Object, ResourceWriteOptions) - Method in interface com.kazforge.jsonapi.api.JsonApiResources: Authors a create-request document for one resource with the given options and returns its JSON.
writeCreateDocument(Object, ResourceWriteOptions, OutputStream) - Method in interface com.kazforge.jsonapi.api.JsonApiResources: Authors a create-request document for one resource with the given options to the given stream.
writeCreateDocument(Object, OutputStream) - Method in interface com.kazforge.jsonapi.api.JsonApiResources: Authors a create-request document for one resource with default options to the given stream.
writeMany(Iterable<?>) - Method in interface com.kazforge.jsonapi.api.JsonApiResources: Writes a resource collection with default options and returns the JSON document.
writeMany(Iterable<?>, ResourceWriteOptions) - Method in interface com.kazforge.jsonapi.api.JsonApiResources: Writes a resource collection with the given options and returns the JSON document.
writeMany(Iterable<?>, ResourceWriteOptions, OutputStream) - Method in interface com.kazforge.jsonapi.api.JsonApiResources: Writes a resource collection with the given options to the given stream.
writeMany(Iterable<?>, OutputStream) - Method in interface com.kazforge.jsonapi.api.JsonApiResources: Writes a resource collection with default options to the given stream.
writeOne(Object) - Method in interface com.kazforge.jsonapi.api.JsonApiResources: Writes one resource with default options and returns the JSON document.
writeOne(Object, ResourceWriteOptions) - Method in interface com.kazforge.jsonapi.api.JsonApiResources: Writes one resource with the given options and returns the JSON document.
writeOne(Object, ResourceWriteOptions, OutputStream) - Method in interface com.kazforge.jsonapi.api.JsonApiResources: Writes one resource with the given options to the given stream.
writeOne(Object, OutputStream) - Method in interface com.kazforge.jsonapi.api.JsonApiResources: Writes one resource with default options to the given stream.
writeToMany(List<? extends ResourceIdentifier>) - Method in interface com.kazforge.jsonapi.api.JsonApiRelationships: Writes a to-many linkage document and returns its JSON.
writeToMany(List<? extends ResourceIdentifier>, OutputStream) - Method in interface com.kazforge.jsonapi.api.JsonApiRelationships: Writes a to-many linkage document to the given stream.
writeToOne(ResourceIdentifier) - Method in interface com.kazforge.jsonapi.api.JsonApiRelationships: Writes a to-one linkage document and returns its JSON.
writeToOne(ResourceIdentifier, OutputStream) - Method in interface com.kazforge.jsonapi.api.JsonApiRelationships: Writes a to-one linkage document to the given stream.
writeUpdateDocument(Object, EndpointIdentity) - Method in interface com.kazforge.jsonapi.api.JsonApiResources: Authors an update-request document for one resource with default options and returns its JSON.
writeUpdateDocument(Object, EndpointIdentity, ResourceWriteOptions) - Method in interface com.kazforge.jsonapi.api.JsonApiResources: Authors an update-request document for one resource with the given options and returns its JSON.
writeUpdateDocument(Object, EndpointIdentity, ResourceWriteOptions, OutputStream) - Method in interface com.kazforge.jsonapi.api.JsonApiResources: Authors an update-request document for one resource with the given options to the given stream.
writeUpdateDocument(Object, EndpointIdentity, OutputStream) - Method in interface com.kazforge.jsonapi.api.JsonApiResources: Authors an update-request document for one resource with default options to the given stream.

A B C D E F H I J L M N O P R S T U V W
All Classes and Interfaces|All Packages|Serialized Form