Index

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

A

ABOUT - Static variable in class com.kazforge.jsonapi.core.model.JsonApiMembers
 
additionalMember(String, Object) - Method in class com.kazforge.jsonapi.core.model.ErrorObject.Builder
Adds or replaces one additional error member.
additionalMember(String, Object) - Method in class com.kazforge.jsonapi.core.model.ErrorSource.Builder
Adds or replaces one additional error-source member.
additionalMembers() - Method in class com.kazforge.jsonapi.core.model.Attributes
Returns the immutable pass-through member map in encounter order.
additionalMembers() - Method in record class com.kazforge.jsonapi.core.model.ErrorObject
Returns the value of the additionalMembers record component.
additionalMembers() - Method in record class com.kazforge.jsonapi.core.model.ErrorSource
Returns the value of the additionalMembers record component.
additionalMembers() - Method in record class com.kazforge.jsonapi.core.model.JsonApiDocument
Returns the value of the additionalMembers record component.
additionalMembers() - Method in record class com.kazforge.jsonapi.core.model.JsonApiObject
Returns the value of the additionalMembers record component.
additionalMembers() - Method in record class com.kazforge.jsonapi.core.model.Link.ObjectLink
Returns the value of the additionalMembers record component.
additionalMembers() - Method in class com.kazforge.jsonapi.core.model.Links
Returns the immutable pass-through member map in encounter order.
additionalMembers() - Method in record class com.kazforge.jsonapi.core.model.Relationship
Returns the value of the additionalMembers record component.
additionalMembers() - Method in class com.kazforge.jsonapi.core.model.Relationships
Returns the immutable pass-through member map in encounter order.
additionalMembers() - Method in record class com.kazforge.jsonapi.core.model.ResourceIdentifier
Returns the value of the additionalMembers record component.
additionalMembers() - Method in record class com.kazforge.jsonapi.core.model.ResourceObject
Returns the value of the additionalMembers record component.
additionalMembers(Map<String, ?>) - Method in class com.kazforge.jsonapi.core.model.ErrorObject.Builder
Adds or replaces additional error members.
additionalMembers(Map<String, ?>) - Method in class com.kazforge.jsonapi.core.model.ErrorSource.Builder
Adds or replaces additional error-source members.
allowedExtensionNamespaces() - Method in record class com.kazforge.jsonapi.core.aggregate.ValidationContext
Returns the value of the allowedExtensionNamespaces record component.
allowedProfileMemberNames() - Method in record class com.kazforge.jsonapi.core.aggregate.ValidationContext
Returns the value of the allowedProfileMemberNames record component.
allowedProfileUris() - Method in record class com.kazforge.jsonapi.core.aggregate.ValidationContext
Returns the value of the allowedProfileUris record component.
attributes() - Method in class com.kazforge.jsonapi.core.model.Attributes
Returns the immutable attribute map in encounter order, including explicit-null values.
attributes() - Method in record class com.kazforge.jsonapi.core.model.ResourceObject
Returns the value of the attributes record component.
Attributes - Class in com.kazforge.jsonapi.core.model
Immutable, insertion-ordered attributes object separating attributes from pass-through members.
ATTRIBUTES - Static variable in class com.kazforge.jsonapi.core.model.JsonApiMembers
 

B

build() - Method in class com.kazforge.jsonapi.core.model.ErrorObject.Builder
Builds the immutable error object with the record's existing local validation.
build() - Method in class com.kazforge.jsonapi.core.model.ErrorSource.Builder
Builds the immutable error source with the record's existing local validation.
builder() - Static method in record class com.kazforge.jsonapi.core.model.ErrorObject
Creates a mutable builder for one error object.
builder() - Static method in record class com.kazforge.jsonapi.core.model.ErrorSource
Creates a mutable builder for one error source.

C

code() - Method in record class com.kazforge.jsonapi.core.model.ErrorObject
Returns the value of the code record component.
code(String) - Method in class com.kazforge.jsonapi.core.model.ErrorObject.Builder
Sets the optional opaque application error code, or clears it when null.
CODE - Static variable in class com.kazforge.jsonapi.core.model.JsonApiMembers
 
com.kazforge.jsonapi.core.aggregate - package com.kazforge.jsonapi.core.aggregate
Aggregate JSON:API document validation over completed core model values.
com.kazforge.jsonapi.core.model - package com.kazforge.jsonapi.core.model
Immutable JSON:API v1.1 document model that preserves wire-visible states.
com.kazforge.jsonapi.core.validation - package com.kazforge.jsonapi.core.validation
JSON:API validation diagnostics, member-name grammar, and model-independent validation policy values.
copyRequiredList(List<? extends T>, String) - Static method in class com.kazforge.jsonapi.core.validation.LocalValidation
Defensively copies a required collection, rejecting a null payload and null elements with stable rule codes and indexed paths.
CREATE_REQUEST - Enum constant in enum class com.kazforge.jsonapi.core.validation.DocumentUsage
Base-spec create-resource operation: the validator applies single-resource primary-data shape and primary relationship-data requirements only when composed with an ordinary resource endpoint role (see PrimaryDataContext.RESOURCE) and a primary-data resource occurrence.
CREATE_REQUIRES_SINGLE_RESOURCE - Enum constant in enum class com.kazforge.jsonapi.core.validation.ValidationRuleCode
 

D

data() - Method in record class com.kazforge.jsonapi.core.model.JsonApiDocument
Returns the value of the data record component.
data() - Method in record class com.kazforge.jsonapi.core.model.Relationship
Returns the value of the data record component.
DATA - Static variable in class com.kazforge.jsonapi.core.model.JsonApiMembers
 
DATA_ERRORS_COEXIST - Enum constant in enum class com.kazforge.jsonapi.core.validation.ValidationRuleCode
 
defaults() - Static method in record class com.kazforge.jsonapi.core.aggregate.ValidationContext
Returns base-spec response validation for an ordinary resource endpoint with no allowances.
describedby() - Method in record class com.kazforge.jsonapi.core.model.Link.ObjectLink
Returns the value of the describedby record component.
DESCRIBEDBY - Static variable in class com.kazforge.jsonapi.core.model.JsonApiMembers
 
detail() - Method in record class com.kazforge.jsonapi.core.model.ErrorObject
Returns the value of the detail record component.
detail(String) - Method in class com.kazforge.jsonapi.core.model.ErrorObject.Builder
Sets the optional error detail, or clears it when null.
DETAIL - Static variable in class com.kazforge.jsonapi.core.model.JsonApiMembers
 
DISALLOWED_ADDITIONAL_MEMBER - Enum constant in enum class com.kazforge.jsonapi.core.validation.ValidationRuleCode
 
DocumentData - Interface in com.kazforge.jsonapi.core.model
Sealed primary data preserving explicit null, single, and collection states.
DocumentData.IdentifierCollection - Record Class in com.kazforge.jsonapi.core.model
Primary data containing an immutable snapshot of resource identifiers, including a present-empty collection.
DocumentData.NullData - Record Class in com.kazforge.jsonapi.core.model
Explicit JSON null primary data.
DocumentData.ResourceCollection - Record Class in com.kazforge.jsonapi.core.model
Primary data containing an immutable snapshot of resource objects, including a present-empty collection.
DocumentData.SingleIdentifier - Record Class in com.kazforge.jsonapi.core.model
Primary data containing one resource identifier.
DocumentData.SingleResource - Record Class in com.kazforge.jsonapi.core.model
Primary data containing one resource object.
documentUsage() - Method in record class com.kazforge.jsonapi.core.aggregate.ValidationContext
Returns the value of the documentUsage record component.
DocumentUsage - Enum Class in com.kazforge.jsonapi.core.validation
Declares the document operation for context-sensitive validation.
DUPLICATE_RESOURCE_IDENTITY - Enum constant in enum class com.kazforge.jsonapi.core.validation.ValidationRuleCode
 

E

empty() - Static method in class com.kazforge.jsonapi.core.model.Attributes
Returns an attributes object with neither attributes nor pass-through members.
empty() - Static method in record class com.kazforge.jsonapi.core.model.JsonApiObject
Creates a present-empty jsonapi object, distinct from an absent containing component.
empty() - Static method in class com.kazforge.jsonapi.core.model.Links
Returns a links object with neither link relations nor pass-through members.
empty() - Static method in class com.kazforge.jsonapi.core.model.Meta
Returns present-empty metadata.
empty() - Static method in record class com.kazforge.jsonapi.core.model.RelationshipData.IdentifierCollectionLinkage
Returns present-empty to-many linkage.
empty() - Static method in class com.kazforge.jsonapi.core.model.Relationships
Returns a relationships object with neither relationships nor pass-through members.
ENDPOINT_IDENTITY_MISMATCH - Enum constant in enum class com.kazforge.jsonapi.core.validation.ValidationRuleCode
 
EndpointIdentity - Record Class in com.kazforge.jsonapi.core.validation
Expected identity of the resource an HTTP update endpoint addresses.
EndpointIdentity(String, String) - Constructor for record class com.kazforge.jsonapi.core.validation.EndpointIdentity
Creates an instance of a EndpointIdentity record class.
equals(Object) - Method in record class com.kazforge.jsonapi.core.aggregate.ValidationContext
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in class com.kazforge.jsonapi.core.model.Attributes
 
equals(Object) - Method in record class com.kazforge.jsonapi.core.model.DocumentData.IdentifierCollection
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.kazforge.jsonapi.core.model.DocumentData.NullData
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.kazforge.jsonapi.core.model.DocumentData.ResourceCollection
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.kazforge.jsonapi.core.model.DocumentData.SingleIdentifier
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.kazforge.jsonapi.core.model.DocumentData.SingleResource
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.kazforge.jsonapi.core.model.ErrorObject
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.kazforge.jsonapi.core.model.ErrorSource
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.kazforge.jsonapi.core.model.JsonApiDocument
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.kazforge.jsonapi.core.model.JsonApiObject
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.kazforge.jsonapi.core.model.Link.ObjectLink
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.kazforge.jsonapi.core.model.Link.StringLink
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in class com.kazforge.jsonapi.core.model.Links
 
equals(Object) - Method in class com.kazforge.jsonapi.core.model.Meta
 
equals(Object) - Method in record class com.kazforge.jsonapi.core.model.Relationship
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.kazforge.jsonapi.core.model.RelationshipData.IdentifierCollectionLinkage
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.kazforge.jsonapi.core.model.RelationshipData.NullLinkage
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.kazforge.jsonapi.core.model.RelationshipData.SingleLinkage
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in class com.kazforge.jsonapi.core.model.Relationships
 
equals(Object) - Method in record class com.kazforge.jsonapi.core.model.ResourceIdentifier
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.kazforge.jsonapi.core.model.ResourceIdentity
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.kazforge.jsonapi.core.model.ResourceObject
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.kazforge.jsonapi.core.validation.EndpointIdentity
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.kazforge.jsonapi.core.validation.RelationshipPaginationKey
Indicates whether some other object is "equal to" this one.
ERROR - Enum constant in enum class com.kazforge.jsonapi.core.validation.LinksContext
 
ErrorObject - Record Class in com.kazforge.jsonapi.core.model
JSON:API error object.
ErrorObject(String, Links, String, String, String, String, ErrorSource, Meta, Map<String, Object>) - Constructor for record class com.kazforge.jsonapi.core.model.ErrorObject
Creates an instance of a ErrorObject record class.
ErrorObject.Builder - Class in com.kazforge.jsonapi.core.model
Mutable builder for one ErrorObject.
errors() - Method in record class com.kazforge.jsonapi.core.model.JsonApiDocument
Returns the value of the errors record component.
ERRORS - Static variable in class com.kazforge.jsonapi.core.model.JsonApiMembers
 
ErrorSource - Record Class in com.kazforge.jsonapi.core.model
Error object source members: optional JSON Pointer, parameter name, and header name.
ErrorSource(String, String, String, Map<String, Object>) - Constructor for record class com.kazforge.jsonapi.core.model.ErrorSource
Creates an instance of a ErrorSource record class.
ErrorSource.Builder - Class in com.kazforge.jsonapi.core.model
Mutable builder for one ErrorSource.
expectedEndpointIdentity() - Method in record class com.kazforge.jsonapi.core.aggregate.ValidationContext
Returns the value of the expectedEndpointIdentity record component.
ext() - Method in record class com.kazforge.jsonapi.core.model.JsonApiObject
Returns the value of the ext record component.
EXT - Static variable in class com.kazforge.jsonapi.core.model.JsonApiMembers
 

F

fail(ValidationRuleCode, String, String) - Static method in class com.kazforge.jsonapi.core.validation.LocalValidation
 
FIRST - Static variable in class com.kazforge.jsonapi.core.model.JsonApiMembers
 
flatten() - Method in class com.kazforge.jsonapi.core.model.Attributes
Returns one immutable wire-member map with attributes first and pass-through members second.
flatten() - Method in class com.kazforge.jsonapi.core.model.Links
Returns one immutable wire-member map with link relations first and pass-through members second, retaining explicit-null values.
flatten() - Method in class com.kazforge.jsonapi.core.model.Relationships
Returns one immutable wire-member map with relationships first and pass-through members second.
FULL_LINKAGE_VIOLATION - Enum constant in enum class com.kazforge.jsonapi.core.validation.ValidationRuleCode
 

H

hasDataMember() - Method in record class com.kazforge.jsonapi.core.model.JsonApiDocument
Whether data is present, including explicit null and present-empty collections.
hasDataMember() - Method in record class com.kazforge.jsonapi.core.model.Relationship
Whether data is present, including explicit null and present-empty to-many linkage.
hasErrorsMember() - Method in record class com.kazforge.jsonapi.core.model.JsonApiDocument
Whether errors is present, including a present-empty array.
hashCode() - Method in record class com.kazforge.jsonapi.core.aggregate.ValidationContext
Returns a hash code value for this object.
hashCode() - Method in class com.kazforge.jsonapi.core.model.Attributes
 
hashCode() - Method in record class com.kazforge.jsonapi.core.model.DocumentData.IdentifierCollection
Returns a hash code value for this object.
hashCode() - Method in record class com.kazforge.jsonapi.core.model.DocumentData.NullData
Returns a hash code value for this object.
hashCode() - Method in record class com.kazforge.jsonapi.core.model.DocumentData.ResourceCollection
Returns a hash code value for this object.
hashCode() - Method in record class com.kazforge.jsonapi.core.model.DocumentData.SingleIdentifier
Returns a hash code value for this object.
hashCode() - Method in record class com.kazforge.jsonapi.core.model.DocumentData.SingleResource
Returns a hash code value for this object.
hashCode() - Method in record class com.kazforge.jsonapi.core.model.ErrorObject
Returns a hash code value for this object.
hashCode() - Method in record class com.kazforge.jsonapi.core.model.ErrorSource
Returns a hash code value for this object.
hashCode() - Method in record class com.kazforge.jsonapi.core.model.JsonApiDocument
Returns a hash code value for this object.
hashCode() - Method in record class com.kazforge.jsonapi.core.model.JsonApiObject
Returns a hash code value for this object.
hashCode() - Method in record class com.kazforge.jsonapi.core.model.Link.ObjectLink
Returns a hash code value for this object.
hashCode() - Method in record class com.kazforge.jsonapi.core.model.Link.StringLink
Returns a hash code value for this object.
hashCode() - Method in class com.kazforge.jsonapi.core.model.Links
 
hashCode() - Method in class com.kazforge.jsonapi.core.model.Meta
 
hashCode() - Method in record class com.kazforge.jsonapi.core.model.Relationship
Returns a hash code value for this object.
hashCode() - Method in record class com.kazforge.jsonapi.core.model.RelationshipData.IdentifierCollectionLinkage
Returns a hash code value for this object.
hashCode() - Method in record class com.kazforge.jsonapi.core.model.RelationshipData.NullLinkage
Returns a hash code value for this object.
hashCode() - Method in record class com.kazforge.jsonapi.core.model.RelationshipData.SingleLinkage
Returns a hash code value for this object.
hashCode() - Method in class com.kazforge.jsonapi.core.model.Relationships
 
hashCode() - Method in record class com.kazforge.jsonapi.core.model.ResourceIdentifier
Returns a hash code value for this object.
hashCode() - Method in record class com.kazforge.jsonapi.core.model.ResourceIdentity
Returns a hash code value for this object.
hashCode() - Method in record class com.kazforge.jsonapi.core.model.ResourceObject
Returns a hash code value for this object.
hashCode() - Method in record class com.kazforge.jsonapi.core.validation.EndpointIdentity
Returns a hash code value for this object.
hashCode() - Method in record class com.kazforge.jsonapi.core.validation.RelationshipPaginationKey
Returns a hash code value for this object.
hasId() - Method in record class com.kazforge.jsonapi.core.model.ResourceIdentifier
Whether id is present; empty and whitespace values still count as present.
hasId() - Method in record class com.kazforge.jsonapi.core.model.ResourceObject
Whether the id member is present; empty and whitespace values still count as present.
hasIncludedMember() - Method in record class com.kazforge.jsonapi.core.model.JsonApiDocument
Whether included is present, including a present-empty array.
hasLid() - Method in record class com.kazforge.jsonapi.core.model.ResourceIdentifier
Whether lid is present; empty and whitespace values still count as present.
hasLid() - Method in record class com.kazforge.jsonapi.core.model.ResourceObject
Whether the lid member is present; empty and whitespace values still count as present.
hasStandardMember(String, LinksContext) - Method in class com.kazforge.jsonapi.core.model.Links
Whether name is standard for context; this does not test whether this instance contains the name.
header() - Method in record class com.kazforge.jsonapi.core.model.ErrorSource
Returns the value of the header record component.
header(String) - Method in class com.kazforge.jsonapi.core.model.ErrorSource.Builder
Sets the optional request header name, or clears it when null.
HEADER - Static variable in class com.kazforge.jsonapi.core.model.JsonApiMembers
 
href() - Method in record class com.kazforge.jsonapi.core.model.Link.ObjectLink
Returns the value of the href record component.
href() - Method in record class com.kazforge.jsonapi.core.model.Link.StringLink
Returns the value of the href record component.
HREF - Static variable in class com.kazforge.jsonapi.core.model.JsonApiMembers
 
hreflang() - Method in record class com.kazforge.jsonapi.core.model.Link.ObjectLink
Returns the value of the hreflang record component.
HREFLANG - Static variable in class com.kazforge.jsonapi.core.model.JsonApiMembers
 

I

id() - Method in record class com.kazforge.jsonapi.core.model.ErrorObject
Returns the value of the id record component.
id() - Method in record class com.kazforge.jsonapi.core.model.ResourceIdentifier
Returns the value of the id record component.
id() - Method in record class com.kazforge.jsonapi.core.model.ResourceObject
Returns the value of the id record component.
id() - Method in record class com.kazforge.jsonapi.core.validation.EndpointIdentity
Returns the value of the id record component.
id(String) - Method in class com.kazforge.jsonapi.core.model.ErrorObject.Builder
Sets the optional error identifier, or clears it when null.
ID - Enum constant in enum class com.kazforge.jsonapi.core.model.ResourceIdentity.Kind
 
ID - Static variable in class com.kazforge.jsonapi.core.model.JsonApiMembers
 
identifier() - Method in record class com.kazforge.jsonapi.core.model.DocumentData.SingleIdentifier
Returns the value of the identifier record component.
identifier() - Method in record class com.kazforge.jsonapi.core.model.RelationshipData.SingleLinkage
Returns the value of the identifier record component.
IdentifierCollection(List<ResourceIdentifier>) - Constructor for record class com.kazforge.jsonapi.core.model.DocumentData.IdentifierCollection
Creates an instance of a IdentifierCollection record class.
IdentifierCollectionLinkage(List<ResourceIdentifier>) - Constructor for record class com.kazforge.jsonapi.core.model.RelationshipData.IdentifierCollectionLinkage
Creates an instance of a IdentifierCollectionLinkage record class.
identifiers() - Method in record class com.kazforge.jsonapi.core.model.DocumentData.IdentifierCollection
Returns the value of the identifiers record component.
identifiers() - Method in record class com.kazforge.jsonapi.core.model.RelationshipData.IdentifierCollectionLinkage
Returns the value of the identifiers record component.
identityKey() - Method in record class com.kazforge.jsonapi.core.model.ResourceIdentifier
Returns the id identity when present, otherwise the required lid identity.
identityKey() - Method in record class com.kazforge.jsonapi.core.model.ResourceObject
Returns the type + id identity when id is present, otherwise type + lid, or null for a type-only resource.
included() - Method in record class com.kazforge.jsonapi.core.model.JsonApiDocument
Returns the value of the included record component.
INCLUDED - Static variable in class com.kazforge.jsonapi.core.model.JsonApiMembers
 
INCLUDED_RESOURCE_IDENTITY_REQUIRED - Enum constant in enum class com.kazforge.jsonapi.core.validation.ValidationRuleCode
 
INCLUDED_WITHOUT_DATA - Enum constant in enum class com.kazforge.jsonapi.core.validation.ValidationRuleCode
 
INCONSISTENT_LOCAL_IDENTIFIER - Enum constant in enum class com.kazforge.jsonapi.core.validation.ValidationRuleCode
 
INSTANCE - Static variable in record class com.kazforge.jsonapi.core.model.DocumentData.NullData
 
INSTANCE - Static variable in record class com.kazforge.jsonapi.core.model.RelationshipData.NullLinkage
 
INVALID_EXTENSION_URI - Enum constant in enum class com.kazforge.jsonapi.core.validation.ValidationRuleCode
 
INVALID_JSON_POINTER - Enum constant in enum class com.kazforge.jsonapi.core.validation.ValidationRuleCode
 
INVALID_LANGUAGE_TAG - Enum constant in enum class com.kazforge.jsonapi.core.validation.ValidationRuleCode
 
INVALID_LINK_RELATION - Enum constant in enum class com.kazforge.jsonapi.core.validation.ValidationRuleCode
 
INVALID_LINKS_CONTEXT - Enum constant in enum class com.kazforge.jsonapi.core.validation.ValidationRuleCode
 
INVALID_MEDIA_TYPE - Enum constant in enum class com.kazforge.jsonapi.core.validation.ValidationRuleCode
 
INVALID_MEMBER_NAME - Enum constant in enum class com.kazforge.jsonapi.core.validation.ValidationRuleCode
 
INVALID_OPEN_JSON_VALUE - Enum constant in enum class com.kazforge.jsonapi.core.validation.ValidationRuleCode
 
INVALID_PROFILE_URI - Enum constant in enum class com.kazforge.jsonapi.core.validation.ValidationRuleCode
 
INVALID_URI_REFERENCE - Enum constant in enum class com.kazforge.jsonapi.core.validation.ValidationRuleCode
 
isAtMember(String) - Static method in class com.kazforge.jsonapi.core.validation.MemberNames
 
isEmpty() - Method in class com.kazforge.jsonapi.core.model.Attributes
Whether both attributes and pass-through members are empty.
isEmpty() - Method in class com.kazforge.jsonapi.core.model.Links
Whether both link relations and pass-through members are empty.
isEmpty() - Method in class com.kazforge.jsonapi.core.model.Meta
Whether this present meta object has no members.
isEmpty() - Method in class com.kazforge.jsonapi.core.model.Relationships
Whether both semantic relationships and pass-through members are empty.
isExtensionMember(String) - Static method in class com.kazforge.jsonapi.core.validation.MemberNames
 
isId() - Method in record class com.kazforge.jsonapi.core.model.ResourceIdentity
Whether this key uses the resource id.
isLid() - Method in record class com.kazforge.jsonapi.core.model.ResourceIdentity
Whether this key uses the resource lid.
isValid(String) - Static method in class com.kazforge.jsonapi.core.validation.MemberNames
 

J

jsonapi() - Method in record class com.kazforge.jsonapi.core.model.JsonApiDocument
Returns the value of the jsonapi record component.
JSONAPI - Static variable in class com.kazforge.jsonapi.core.model.JsonApiMembers
 
JsonApiDocument - Record Class in com.kazforge.jsonapi.core.model
Top-level JSON:API document.
JsonApiDocument(DocumentData, List<ErrorObject>, Meta, JsonApiObject, Links, List<ResourceObject>, Map<String, Object>) - Constructor for record class com.kazforge.jsonapi.core.model.JsonApiDocument
Creates an instance of a JsonApiDocument record class.
JsonApiDocumentValidator - Class in com.kazforge.jsonapi.core.aggregate
Validates rules that require complete-document context after local model construction.
JsonApiDocumentValidator() - Constructor for class com.kazforge.jsonapi.core.aggregate.JsonApiDocumentValidator
 
JsonApiMembers - Class in com.kazforge.jsonapi.core.model
Shared JSON:API v1.1 wire member vocabulary.
JsonApiObject - Record Class in com.kazforge.jsonapi.core.model
Top-level jsonapi object whose nullable components represent absent members.
JsonApiObject(String, List<String>, List<String>, Meta, Map<String, Object>) - Constructor for record class com.kazforge.jsonapi.core.model.JsonApiObject
Creates an instance of a JsonApiObject record class.
JsonApiValidationException - Exception Class in com.kazforge.jsonapi.core.validation
Validation failure carrying a stable rule code and JSON Pointer-like path.
JsonApiValidationException(ValidationRuleCode, String, String) - Constructor for exception class com.kazforge.jsonapi.core.validation.JsonApiValidationException
 
jsonPointer() - Method in exception class com.kazforge.jsonapi.core.validation.JsonApiValidationException
Returns the failing member path; an empty string denotes the document root.

K

kind() - Method in record class com.kazforge.jsonapi.core.model.ResourceIdentity
Returns the value of the kind record component.

L

LAST - Static variable in class com.kazforge.jsonapi.core.model.JsonApiMembers
 
lid() - Method in record class com.kazforge.jsonapi.core.model.ResourceIdentifier
Returns the value of the lid record component.
lid() - Method in record class com.kazforge.jsonapi.core.model.ResourceObject
Returns the value of the lid record component.
LID - Enum constant in enum class com.kazforge.jsonapi.core.model.ResourceIdentity.Kind
 
LID - Static variable in class com.kazforge.jsonapi.core.model.JsonApiMembers
 
Link - Interface in com.kazforge.jsonapi.core.model
A JSON:API link as a URI reference string or link object.
Link.ObjectLink - Record Class in com.kazforge.jsonapi.core.model
Link-object form with required href and optional standard or additional members.
Link.StringLink - Record Class in com.kazforge.jsonapi.core.model
String-form link containing one URI reference.
linkOnly(Links) - Static method in record class com.kazforge.jsonapi.core.model.Relationship
Creates a relationship with links and no data member.
links() - Method in record class com.kazforge.jsonapi.core.model.ErrorObject
Returns the value of the links record component.
links() - Method in record class com.kazforge.jsonapi.core.model.JsonApiDocument
Returns the value of the links record component.
links() - Method in class com.kazforge.jsonapi.core.model.Links
Returns the immutable relation map, preserving explicit-null values and encounter order.
links() - Method in record class com.kazforge.jsonapi.core.model.Relationship
Returns the value of the links record component.
links() - Method in record class com.kazforge.jsonapi.core.model.ResourceObject
Returns the value of the links record component.
links(Links) - Method in class com.kazforge.jsonapi.core.model.ErrorObject.Builder
Sets the optional error links, or clears them when null.
Links - Class in com.kazforge.jsonapi.core.model
Immutable, insertion-ordered links object with link relations separate from pass-through members.
LINKS - Static variable in class com.kazforge.jsonapi.core.model.JsonApiMembers
 
LinksContext - Enum Class in com.kazforge.jsonapi.core.validation
Context for validating links in different document locations.
LocalValidation - Class in com.kazforge.jsonapi.core.validation
Local validation helper used by model compact constructors.

M

MEMBER_NAME_COLLISION - Enum constant in enum class com.kazforge.jsonapi.core.validation.ValidationRuleCode
 
MemberNames - Class in com.kazforge.jsonapi.core.validation
JSON:API v1.1 member-name grammar validation.
members() - Method in class com.kazforge.jsonapi.core.model.Meta
Returns the immutable members in encounter order, including explicit-null values.
meta() - Method in record class com.kazforge.jsonapi.core.model.ErrorObject
Returns the value of the meta record component.
meta() - Method in record class com.kazforge.jsonapi.core.model.JsonApiDocument
Returns the value of the meta record component.
meta() - Method in record class com.kazforge.jsonapi.core.model.JsonApiObject
Returns the value of the meta record component.
meta() - Method in record class com.kazforge.jsonapi.core.model.Link.ObjectLink
Returns the value of the meta record component.
meta() - Method in record class com.kazforge.jsonapi.core.model.Relationship
Returns the value of the meta record component.
meta() - Method in record class com.kazforge.jsonapi.core.model.ResourceIdentifier
Returns the value of the meta record component.
meta() - Method in record class com.kazforge.jsonapi.core.model.ResourceObject
Returns the value of the meta record component.
meta(Meta) - Method in class com.kazforge.jsonapi.core.model.ErrorObject.Builder
Sets the optional error meta object, or clears it when null.
Meta - Class in com.kazforge.jsonapi.core.model
Immutable, insertion-ordered JSON-compatible metadata members.
META - Static variable in class com.kazforge.jsonapi.core.model.JsonApiMembers
 
metaOnly(Meta) - Static method in record class com.kazforge.jsonapi.core.model.Relationship
Creates a relationship with meta and no data member.
MISSING_ERROR_MEMBER - Enum constant in enum class com.kazforge.jsonapi.core.validation.ValidationRuleCode
 
MISSING_RELATIONSHIP_MEMBER - Enum constant in enum class com.kazforge.jsonapi.core.validation.ValidationRuleCode
 
MISSING_RESOURCE_ID - Enum constant in enum class com.kazforge.jsonapi.core.validation.ValidationRuleCode
 
MISSING_RESOURCE_TYPE - Enum constant in enum class com.kazforge.jsonapi.core.validation.ValidationRuleCode
 
MISSING_TOP_LEVEL_MEMBER - Enum constant in enum class com.kazforge.jsonapi.core.validation.ValidationRuleCode
 

N

NEXT - Static variable in class com.kazforge.jsonapi.core.model.JsonApiMembers
 
NULL_COLLECTION_ELEMENT - Enum constant in enum class com.kazforge.jsonapi.core.validation.ValidationRuleCode
 
NULL_COLLECTION_PAYLOAD - Enum constant in enum class com.kazforge.jsonapi.core.validation.ValidationRuleCode
 
NULL_RELATIONSHIP_VALUE - Enum constant in enum class com.kazforge.jsonapi.core.validation.ValidationRuleCode
 
NULL_REQUIRED_VALUE - Enum constant in enum class com.kazforge.jsonapi.core.validation.ValidationRuleCode
 
NullData() - Constructor for record class com.kazforge.jsonapi.core.model.DocumentData.NullData
Creates an instance of a NullData record class.
NullLinkage() - Constructor for record class com.kazforge.jsonapi.core.model.RelationshipData.NullLinkage
Creates an instance of a NullLinkage record class.

O

ObjectLink(String, String, Link, String, String, List<String>, Meta, Map<String, Object>) - Constructor for record class com.kazforge.jsonapi.core.model.Link.ObjectLink
Creates an instance of a ObjectLink record class.
of(String, String) - Static method in record class com.kazforge.jsonapi.core.model.ResourceIdentifier
Creates an identifier with type and id.
of(String, String) - Static method in record class com.kazforge.jsonapi.core.model.ResourceObject
Creates a resource with type and id only.
of(String, String) - Static method in record class com.kazforge.jsonapi.core.validation.RelationshipPaginationKey
 
of(Map<String, ?>) - Static method in class com.kazforge.jsonapi.core.model.Meta
Returns a deep immutable snapshot of the supplied open-JSON members, treating null as empty metadata.
of(Map<String, ?>, Map<String, ?>) - Static method in class com.kazforge.jsonapi.core.model.Attributes
Snapshots attributes and pass-through members, preserving explicit-null values and each map's encounter order.
of(Map<String, Link>, Map<String, ?>) - Static method in class com.kazforge.jsonapi.core.model.Links
Snapshots link relations and pass-through members, preserving explicit-null link values and each map's encounter order.
of(Map<String, Relationship>, Map<String, ?>) - Static method in class com.kazforge.jsonapi.core.model.Relationships
Snapshots semantic relationships and pass-through members, preserving each map's encounter order and rejecting names shared by both maps.
ofAttributes(Map<String, ?>) - Static method in class com.kazforge.jsonapi.core.model.Attributes
Snapshots semantic attributes with no pass-through members.
ofHref(String) - Static method in record class com.kazforge.jsonapi.core.model.Link.ObjectLink
Creates the minimal object form containing only href.
ofId(String, String) - Static method in record class com.kazforge.jsonapi.core.model.ResourceIdentity
Creates an identity keyed by the resource id.
ofLid(String, String) - Static method in record class com.kazforge.jsonapi.core.model.ResourceIdentity
Creates an identity keyed by the resource lid.
ofLinks(Map<String, Link>) - Static method in class com.kazforge.jsonapi.core.model.Links
Snapshots link relations, including explicit-null values, with no pass-through members.
ofParameter(String) - Static method in record class com.kazforge.jsonapi.core.model.ErrorSource
Returns a parameter-only error source.
ofRelationships(Map<String, Relationship>) - Static method in class com.kazforge.jsonapi.core.model.Relationships
Snapshots semantic relationships with no pass-through members.
ofTitle(String) - Static method in record class com.kazforge.jsonapi.core.model.ErrorObject
Returns a title-only error object.
ofType(String) - Static method in record class com.kazforge.jsonapi.core.model.ResourceObject
Creates a type-only resource, such as a primary resource awaiting create validation.
ofVersion(String) - Static method in record class com.kazforge.jsonapi.core.model.JsonApiObject
Creates a jsonapi object containing only version.

P

PAGINATION_LINKS - Static variable in class com.kazforge.jsonapi.core.model.JsonApiMembers
Standard pagination link names (first, last, prev, next).
PAGINATION_REQUIRES_COLLECTION - Enum constant in enum class com.kazforge.jsonapi.core.validation.ValidationRuleCode
 
parameter() - Method in record class com.kazforge.jsonapi.core.model.ErrorSource
Returns the value of the parameter record component.
parameter(String) - Method in class com.kazforge.jsonapi.core.model.ErrorSource.Builder
Sets the optional query parameter name, or clears it when null.
PARAMETER - Static variable in class com.kazforge.jsonapi.core.model.JsonApiMembers
 
pointer() - Method in record class com.kazforge.jsonapi.core.model.ErrorSource
Returns the value of the pointer record component.
pointer(String) - Method in class com.kazforge.jsonapi.core.model.ErrorSource.Builder
Sets the optional RFC 6901 JSON Pointer, or clears it when null.
POINTER - Static variable in class com.kazforge.jsonapi.core.model.JsonApiMembers
 
PREV - Static variable in class com.kazforge.jsonapi.core.model.JsonApiMembers
 
PRIMARY_DATA_CONTEXT_MISMATCH - Enum constant in enum class com.kazforge.jsonapi.core.validation.ValidationRuleCode
 
primaryDataContext() - Method in record class com.kazforge.jsonapi.core.aggregate.ValidationContext
Returns the value of the primaryDataContext record component.
PrimaryDataContext - Enum Class in com.kazforge.jsonapi.core.validation
Declares what primary data represents at the endpoint being validated.
profile() - Method in record class com.kazforge.jsonapi.core.model.JsonApiObject
Returns the value of the profile record component.
PROFILE - Static variable in class com.kazforge.jsonapi.core.model.JsonApiMembers
 

R

rel() - Method in record class com.kazforge.jsonapi.core.model.Link.ObjectLink
Returns the value of the rel record component.
REL - Static variable in class com.kazforge.jsonapi.core.model.JsonApiMembers
 
RELATED - Static variable in class com.kazforge.jsonapi.core.model.JsonApiMembers
 
Relationship - Record Class in com.kazforge.jsonapi.core.model
A JSON:API relationship with optional data, links, meta, and additional members.
Relationship(RelationshipData, Links, Meta, Map<String, Object>) - Constructor for record class com.kazforge.jsonapi.core.model.Relationship
Creates an instance of a Relationship record class.
RELATIONSHIP - Enum constant in enum class com.kazforge.jsonapi.core.validation.LinksContext
 
RELATIONSHIP - Enum constant in enum class com.kazforge.jsonapi.core.validation.PrimaryDataContext
Primary data represents resource linkage returned by or sent to a relationship endpoint: explicit null, a single identifier, or an identifier collection.
RELATIONSHIP_DATA_REQUIRED - Enum constant in enum class com.kazforge.jsonapi.core.validation.ValidationRuleCode
 
RelationshipCardinality - Enum Class in com.kazforge.jsonapi.core.validation
Optional cardinality hint for relationship pagination when linkage is absent.
RelationshipData - Interface in com.kazforge.jsonapi.core.model
Sealed relationship linkage preserving explicit null, single, and collection states.
RelationshipData.IdentifierCollectionLinkage - Record Class in com.kazforge.jsonapi.core.model
To-many linkage containing an immutable snapshot of resource identifiers; an empty list remains present-empty to-many linkage.
RelationshipData.NullLinkage - Record Class in com.kazforge.jsonapi.core.model
Explicit JSON null, representing empty to-one linkage.
RelationshipData.SingleLinkage - Record Class in com.kazforge.jsonapi.core.model
To-one linkage containing one resource identifier.
relationshipName() - Method in record class com.kazforge.jsonapi.core.validation.RelationshipPaginationKey
Returns the value of the relationshipName record component.
relationshipPaginationHint(String, String) - Method in record class com.kazforge.jsonapi.core.aggregate.ValidationContext
Returns the explicit cardinality hint for a relationship occurrence, if present.
relationshipPaginationHints() - Method in record class com.kazforge.jsonapi.core.aggregate.ValidationContext
Returns the value of the relationshipPaginationHints record component.
RelationshipPaginationKey - Record Class in com.kazforge.jsonapi.core.validation
Occurrence key for relationship pagination hints: resource type plus relationship name.
RelationshipPaginationKey(String, String) - Constructor for record class com.kazforge.jsonapi.core.validation.RelationshipPaginationKey
Creates an instance of a RelationshipPaginationKey record class.
relationships() - Method in class com.kazforge.jsonapi.core.model.Relationships
Returns the immutable semantic relationship map in encounter order.
relationships() - Method in record class com.kazforge.jsonapi.core.model.ResourceObject
Returns the value of the relationships record component.
Relationships - Class in com.kazforge.jsonapi.core.model
Immutable, insertion-ordered relationships object separating relationships from pass-through members.
RELATIONSHIPS - Static variable in class com.kazforge.jsonapi.core.model.JsonApiMembers
 
requireNonNull(T, String, String) - Static method in class com.kazforge.jsonapi.core.validation.LocalValidation
Rejects a null required value with a stable rule code and JSON Pointer-like path.
RESERVED_FIELD_NAME - Enum constant in enum class com.kazforge.jsonapi.core.validation.ValidationRuleCode
 
resource() - Method in record class com.kazforge.jsonapi.core.model.DocumentData.SingleResource
Returns the value of the resource record component.
RESOURCE - Enum constant in enum class com.kazforge.jsonapi.core.validation.LinksContext
 
RESOURCE - Enum constant in enum class com.kazforge.jsonapi.core.validation.PrimaryDataContext
Primary data represents an ordinary resource or resource collection.
RESOURCE_ID_REQUIRED - Enum constant in enum class com.kazforge.jsonapi.core.validation.ValidationRuleCode
 
ResourceCollection(List<ResourceObject>) - Constructor for record class com.kazforge.jsonapi.core.model.DocumentData.ResourceCollection
Creates an instance of a ResourceCollection record class.
ResourceIdentifier - Record Class in com.kazforge.jsonapi.core.model
Resource identifier with independent id and lid members.
ResourceIdentifier(String, String, String, Meta, Map<String, Object>) - Constructor for record class com.kazforge.jsonapi.core.model.ResourceIdentifier
Creates an instance of a ResourceIdentifier record class.
ResourceIdentity - Record Class in com.kazforge.jsonapi.core.model
Structured resource identity key that keeps id and lid identities distinct.
ResourceIdentity(ResourceIdentity.Kind, String, String) - Constructor for record class com.kazforge.jsonapi.core.model.ResourceIdentity
Creates an instance of a ResourceIdentity record class.
ResourceIdentity.Kind - Enum Class in com.kazforge.jsonapi.core.model
The JSON:API identity member represented by ResourceIdentity.value().
ResourceObject - Record Class in com.kazforge.jsonapi.core.model
A JSON:API resource object.
ResourceObject(String, String, String, Attributes, Relationships, Links, Meta, Map<String, Object>) - Constructor for record class com.kazforge.jsonapi.core.model.ResourceObject
Creates an instance of a ResourceObject record class.
resources() - Method in record class com.kazforge.jsonapi.core.model.DocumentData.ResourceCollection
Returns the value of the resources record component.
resourceType() - Method in record class com.kazforge.jsonapi.core.validation.RelationshipPaginationKey
Returns the value of the resourceType record component.
RESPONSE_OR_OTHER - Enum constant in enum class com.kazforge.jsonapi.core.validation.DocumentUsage
Response or any other document use.
ruleCode() - Method in exception class com.kazforge.jsonapi.core.validation.JsonApiValidationException
Returns the stable machine-readable validation rule.

S

SELF - Static variable in class com.kazforge.jsonapi.core.model.JsonApiMembers
 
SingleIdentifier(ResourceIdentifier) - Constructor for record class com.kazforge.jsonapi.core.model.DocumentData.SingleIdentifier
Creates an instance of a SingleIdentifier record class.
SingleLinkage(ResourceIdentifier) - Constructor for record class com.kazforge.jsonapi.core.model.RelationshipData.SingleLinkage
Creates an instance of a SingleLinkage record class.
SingleResource(ResourceObject) - Constructor for record class com.kazforge.jsonapi.core.model.DocumentData.SingleResource
Creates an instance of a SingleResource record class.
source() - Method in record class com.kazforge.jsonapi.core.model.ErrorObject
Returns the value of the source record component.
source(ErrorSource) - Method in class com.kazforge.jsonapi.core.model.ErrorObject.Builder
Sets the optional error source, or clears it when null.
SOURCE - Static variable in class com.kazforge.jsonapi.core.model.JsonApiMembers
 
sparseFieldsetLinkageExemptions() - Method in record class com.kazforge.jsonapi.core.aggregate.ValidationContext
Returns the value of the sparseFieldsetLinkageExemptions record component.
standardMembers(LinksContext) - Static method in class com.kazforge.jsonapi.core.model.Links
Returns the immutable base-spec link names for a location, before profile or extension policy.
status() - Method in record class com.kazforge.jsonapi.core.model.ErrorObject
Returns the value of the status record component.
status(String) - Method in class com.kazforge.jsonapi.core.model.ErrorObject.Builder
Sets the optional opaque JSON:API status string, or clears it when null.
STATUS - Static variable in class com.kazforge.jsonapi.core.model.JsonApiMembers
 
StringLink(String) - Constructor for record class com.kazforge.jsonapi.core.model.Link.StringLink
Creates an instance of a StringLink record class.

T

title() - Method in record class com.kazforge.jsonapi.core.model.ErrorObject
Returns the value of the title record component.
title() - Method in record class com.kazforge.jsonapi.core.model.Link.ObjectLink
Returns the value of the title record component.
title(String) - Method in class com.kazforge.jsonapi.core.model.ErrorObject.Builder
Sets the optional error title, or clears it when null.
TITLE - Static variable in class com.kazforge.jsonapi.core.model.JsonApiMembers
 
TO_MANY - Enum constant in enum class com.kazforge.jsonapi.core.validation.RelationshipCardinality
 
TO_ONE - Enum constant in enum class com.kazforge.jsonapi.core.validation.RelationshipCardinality
 
toIdentifier() - Method in record class com.kazforge.jsonapi.core.model.ResourceObject
Converts identity, meta, and additional members to a resource identifier.
TOP_LEVEL - Enum constant in enum class com.kazforge.jsonapi.core.validation.LinksContext
 
toString() - Method in record class com.kazforge.jsonapi.core.aggregate.ValidationContext
Returns a string representation of this record class.
toString() - Method in record class com.kazforge.jsonapi.core.model.DocumentData.IdentifierCollection
Returns a string representation of this record class.
toString() - Method in record class com.kazforge.jsonapi.core.model.DocumentData.NullData
Returns a string representation of this record class.
toString() - Method in record class com.kazforge.jsonapi.core.model.DocumentData.ResourceCollection
Returns a string representation of this record class.
toString() - Method in record class com.kazforge.jsonapi.core.model.DocumentData.SingleIdentifier
Returns a string representation of this record class.
toString() - Method in record class com.kazforge.jsonapi.core.model.DocumentData.SingleResource
Returns a string representation of this record class.
toString() - Method in record class com.kazforge.jsonapi.core.model.ErrorObject
Returns a string representation of this record class.
toString() - Method in record class com.kazforge.jsonapi.core.model.ErrorSource
Returns a string representation of this record class.
toString() - Method in record class com.kazforge.jsonapi.core.model.JsonApiDocument
Returns a string representation of this record class.
toString() - Method in record class com.kazforge.jsonapi.core.model.JsonApiObject
Returns a string representation of this record class.
toString() - Method in record class com.kazforge.jsonapi.core.model.Link.ObjectLink
Returns a string representation of this record class.
toString() - Method in record class com.kazforge.jsonapi.core.model.Link.StringLink
Returns a string representation of this record class.
toString() - Method in class com.kazforge.jsonapi.core.model.Meta
 
toString() - Method in record class com.kazforge.jsonapi.core.model.Relationship
Returns a string representation of this record class.
toString() - Method in record class com.kazforge.jsonapi.core.model.RelationshipData.IdentifierCollectionLinkage
Returns a string representation of this record class.
toString() - Method in record class com.kazforge.jsonapi.core.model.RelationshipData.NullLinkage
Returns a string representation of this record class.
toString() - Method in record class com.kazforge.jsonapi.core.model.RelationshipData.SingleLinkage
Returns a string representation of this record class.
toString() - Method in record class com.kazforge.jsonapi.core.model.ResourceIdentifier
Returns a string representation of this record class.
toString() - Method in record class com.kazforge.jsonapi.core.model.ResourceIdentity
Returns a string representation of this record class.
toString() - Method in record class com.kazforge.jsonapi.core.model.ResourceObject
Returns a string representation of this record class.
toString() - Method in record class com.kazforge.jsonapi.core.validation.EndpointIdentity
Returns a string representation of this record class.
toString() - Method in record class com.kazforge.jsonapi.core.validation.RelationshipPaginationKey
Returns a string representation of this record class.
type() - Method in record class com.kazforge.jsonapi.core.model.Link.ObjectLink
Returns the value of the type record component.
type() - Method in record class com.kazforge.jsonapi.core.model.ResourceIdentifier
Returns the value of the type record component.
type() - Method in record class com.kazforge.jsonapi.core.model.ResourceIdentity
Returns the value of the type record component.
type() - Method in record class com.kazforge.jsonapi.core.model.ResourceObject
Returns the value of the type record component.
type() - Method in record class com.kazforge.jsonapi.core.validation.EndpointIdentity
Returns the value of the type record component.
TYPE - Static variable in class com.kazforge.jsonapi.core.model.JsonApiMembers
 

U

UNKNOWN_ADDITIONAL_MEMBER - Enum constant in enum class com.kazforge.jsonapi.core.validation.ValidationRuleCode
 
UPDATE_REQUEST - Enum constant in enum class com.kazforge.jsonapi.core.validation.DocumentUsage
Base-spec update operation: the validator applies single-resource primary-data shape, primary relationship-data requirements, and expected endpoint-identity comparison only when composed with an ordinary resource endpoint role (see PrimaryDataContext.RESOURCE) and a primary-data resource occurrence.
UPDATE_REQUIRES_SINGLE_RESOURCE - Enum constant in enum class com.kazforge.jsonapi.core.validation.ValidationRuleCode
 

V

validate(JsonApiDocument, ValidationContext) - Method in class com.kazforge.jsonapi.core.aggregate.JsonApiDocumentValidator
Validates document under context, throwing a stable rule code and JSON Pointer-like path in JsonApiValidationException at the first aggregate failure.
ValidationContext - Record Class in com.kazforge.jsonapi.core.aggregate
Context for aggregate document validation.
ValidationContext(DocumentUsage, PrimaryDataContext, Set<String>, Set<String>, Set<String>, Set<ResourceIdentity>, Map<RelationshipPaginationKey, RelationshipCardinality>, EndpointIdentity) - Constructor for record class com.kazforge.jsonapi.core.aggregate.ValidationContext
Creates an instance of a ValidationContext record class.
ValidationRuleCode - Enum Class in com.kazforge.jsonapi.core.validation
Stable rule codes for JSON:API validation failures.
value() - Method in record class com.kazforge.jsonapi.core.model.ResourceIdentity
Returns the value of the value record component.
valueOf(String) - Static method in enum class com.kazforge.jsonapi.core.model.ResourceIdentity.Kind
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.kazforge.jsonapi.core.validation.DocumentUsage
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.kazforge.jsonapi.core.validation.LinksContext
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.kazforge.jsonapi.core.validation.PrimaryDataContext
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.kazforge.jsonapi.core.validation.RelationshipCardinality
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.kazforge.jsonapi.core.validation.ValidationRuleCode
Returns the enum constant of this class with the specified name.
values() - Static method in enum class com.kazforge.jsonapi.core.model.ResourceIdentity.Kind
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.core.validation.DocumentUsage
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.core.validation.LinksContext
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.core.validation.PrimaryDataContext
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.core.validation.RelationshipCardinality
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.core.validation.ValidationRuleCode
Returns an array containing the constants of this enum class, in the order they are declared.
version() - Method in record class com.kazforge.jsonapi.core.model.JsonApiObject
Returns the value of the version record component.
VERSION - Static variable in class com.kazforge.jsonapi.core.model.JsonApiMembers
 

W

withAdditionalMembers(Map<String, Object>) - Method in record class com.kazforge.jsonapi.core.model.ResourceObject
Returns a copy replacing (not merging) additional members, preserving JSON-null values.
withAttributes(Attributes) - Method in record class com.kazforge.jsonapi.core.model.ResourceObject
Returns a copy replacing attributes, or omitting them when null.
withData(DocumentData) - Static method in record class com.kazforge.jsonapi.core.model.JsonApiDocument
Creates a document with a present data member, including explicit-null data.
withData(RelationshipData) - Static method in record class com.kazforge.jsonapi.core.model.Relationship
Creates a relationship with a present data member.
withDocumentUsage(DocumentUsage) - Method in record class com.kazforge.jsonapi.core.aggregate.ValidationContext
Returns a context with the selected operation while preserving every other setting.
withError(ErrorObject) - Static method in record class com.kazforge.jsonapi.core.model.JsonApiDocument
Creates a document with one error object in its present errors member.
withErrors(List<ErrorObject>) - Static method in record class com.kazforge.jsonapi.core.model.JsonApiDocument
Creates a document with a present errors member, including a valid present-empty array.
withExpectedEndpointIdentity(EndpointIdentity) - Method in record class com.kazforge.jsonapi.core.aggregate.ValidationContext
Returns a context whose expected endpoint identity is compared against the primary resource of update documents on the ordinary resource endpoint role.
withHreflang(String, String) - Static method in record class com.kazforge.jsonapi.core.model.Link.ObjectLink
Creates an object link whose canonical hreflang value contains one tag.
withHreflang(String, List<String>) - Static method in record class com.kazforge.jsonapi.core.model.Link.ObjectLink
Creates an object link whose canonical hreflang value contains the supplied tags.
withLid(String) - Method in record class com.kazforge.jsonapi.core.model.ResourceObject
Returns a copy with the given local identifier, or without it when null.
withLid(String, String) - Static method in record class com.kazforge.jsonapi.core.model.ResourceIdentifier
Creates an identifier with type and lid.
withLinks(Links) - Method in record class com.kazforge.jsonapi.core.model.ResourceObject
Returns a copy replacing links, or omitting them when null.
withMeta(Meta) - Method in record class com.kazforge.jsonapi.core.model.ResourceIdentifier
Returns a copy replacing metadata, or omitting it when null, preserving identity and additional members.
withMeta(Meta) - Method in record class com.kazforge.jsonapi.core.model.ResourceObject
Returns a copy replacing metadata, or omitting it when null.
withMeta(Meta) - Static method in record class com.kazforge.jsonapi.core.model.JsonApiDocument
Creates a document whose required content member is meta.
withPrimaryDataContext(PrimaryDataContext) - Method in record class com.kazforge.jsonapi.core.aggregate.ValidationContext
Returns a context selecting what primary data represents at the endpoint being validated (ordinary resource data versus relationship linkage) while preserving every other setting.
withRelationships(Relationships) - Method in record class com.kazforge.jsonapi.core.model.ResourceObject
Returns a copy replacing relationships, or omitting them when null.
withSparseFieldsetLinkageExemptions(Set<ResourceIdentity>) - Method in record class com.kazforge.jsonapi.core.aggregate.ValidationContext
Returns a context whose full-linkage validation treats the given included-resource identities as reachable roots (sparse-fieldset linkage exemptions) while preserving every other setting.
A B C D E F H I J K L M N O P R S T U V W 
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form