Interface StreamError

All Known Implementing Classes:
StreamError.Empty, StreamError.NotJson, StreamError.ReadFailed, StreamError.TrailingContent
public sealed interface StreamError permits StreamError.Empty, StreamError.ReadFailed, StreamError.NotJson, StreamError.TrailingContent

An error of a JacksonStream: the parser could not give a JSON text.

Error Cause
StreamError.Empty the input has no value
StreamError.ReadFailed the parser failed, for example on text that is not JSON or at the end of the input inside a value
StreamError.NotJson the parser gave a token that is not a JSON value, for example an embedded binary object
StreamError.TrailingContent JacksonStream.readFully(JsonParser) found more tokens after the root value

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static final record 
    StreamError.Empty
    The input has no value.
    static final record 
    StreamError.NotJson
    The parser gave a token that is not a JSON value.
    static final record 
    StreamError.ReadFailed
    The parser failed.
    static final record 
    StreamError.TrailingContent
    The input has more tokens after the root value.

  • Method Summary

    Modifier and Type
    Method
    Description
    default String
    message()
    Returns a description of the error for people.

  • Method Details

    • message

      default String message()
      Returns a description of the error for people.
      Returns:
      the description