Package com.kazforge.jsonapi.diagnostic

Class JsonApiDocumentReadException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

com.kazforge.jsonapi.diagnostic.JsonApiDocumentReadException

All Implemented Interfaces:

Serializable

public final class JsonApiDocumentReadException
extends RuntimeException

Failure while decoding or validating a JSON:API document.

Adapter-produced instances carry a stable CodecFailureCategory, a document-relative RFC 6901 JSON Pointer ("" for the document root), and a payload-safe best-effort SourceLocation. For CodecFailureCategory.LOCAL_VALIDATION and CodecFailureCategory.AGGREGATE_VALIDATION, ruleCode() carries the core ValidationRuleCode; codec failures do not invent one.

This family ends at validated core-document construction. Domain binding, resource mapping, registry, and representation failures use JsonApiMappingException instead.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
JsonApiDocumentReadException(CodecFailureCategory category, String jsonPointer, SourceLocation sourceLocation, @Nullable com.kazforge.jsonapi.core.validation.ValidationRuleCode ruleCode, String message)
JsonApiDocumentReadException(CodecFailureCategory category, String jsonPointer, SourceLocation sourceLocation, @Nullable com.kazforge.jsonapi.core.validation.ValidationRuleCode ruleCode, String message, @Nullable Throwable cause)
JsonApiDocumentReadException(CodecFailureCategory category, String jsonPointer, SourceLocation sourceLocation, String message)

Method Summary

Modifier and Type	Method	Description
CodecFailureCategory	category()	Decoding or validation stage that failed.
String	jsonPointer()	Document-relative JSON Pointer; "" identifies the document root.
@Nullable com.kazforge.jsonapi.core.validation.ValidationRuleCode	ruleCode()	Core validation rule when one was reported, otherwise null.
SourceLocation	sourceLocation()	Best-effort payload-safe source position, or SourceLocation.UNKNOWN.

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Constructor Details

JsonApiDocumentReadException

public JsonApiDocumentReadException(CodecFailureCategory category,
 String jsonPointer,
 SourceLocation sourceLocation,
 String message)

JsonApiDocumentReadException

public JsonApiDocumentReadException(CodecFailureCategory category,
 String jsonPointer,
 SourceLocation sourceLocation,
 @Nullable com.kazforge.jsonapi.core.validation.ValidationRuleCode ruleCode,
 String message)

JsonApiDocumentReadException

public JsonApiDocumentReadException(CodecFailureCategory category,
 String jsonPointer,
 SourceLocation sourceLocation,
 @Nullable com.kazforge.jsonapi.core.validation.ValidationRuleCode ruleCode,
 String message,
 @Nullable Throwable cause)

Method Details

category

public CodecFailureCategory category()

Decoding or validation stage that failed.

jsonPointer

public String jsonPointer()

Document-relative JSON Pointer; "" identifies the document root.

sourceLocation

public SourceLocation sourceLocation()

Best-effort payload-safe source position, or SourceLocation.UNKNOWN.

ruleCode

public @Nullable com.kazforge.jsonapi.core.validation.ValidationRuleCode ruleCode()

Core validation rule when one was reported, otherwise null.