Package io.avaje.jsonb

Interface JsonReader

All Superinterfaces:
AutoCloseable, Closeable
public interface JsonReader extends Closeable
Reads json content as a stream of JSON tokens and content.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static enum 
    JsonReader.Token
    A structure, name, or value type in a JSON-encoded string.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    beginArray()
    Read array begin.
    void
    beginObject()
    Read begin object.
    void
    close()
    Close the resources of the reader.
    void
    endArray()
    Read array end.
    void
    endObject()
    Read end object.
    boolean
    hasNextElement()
    Return true if there is a next element.
    boolean
    hasNextField()
    Return true if there is a next field to be read.
    BigInteger
    nextBigInteger()
    Read and return the next value as a BigInteger.
    boolean
    nextBoolean()
    Read and return the next value as a boolean.
    BigDecimal
    nextDecimal()
    Read and return the next value as a BigDecimal.
    double
    nextDouble()
    Read and return the next value as a double.
    String
    nextField()
    Return the next field.
    int
    nextInt()
    Read and return the next value as an int.
    long
    nextLong()
    Read and return the next value as a long.
    <T> T
    nextNull()
    Return the next value as a null.
    String
    nextString()
    Read and return the next value as String.
    String
    path()
    Return the current path.
    JsonReader.Token
    peek()
    Return the current Token.
    boolean
    peekIsNull()
    Return true if the next value is a null.
    void
    skipValue()
    Skip the next value.
    void
    unmappedField(String fieldName)
    Reading json with an unmapped field, throw an Exception if failOnUnmapped is true.

  • Method Details

    • beginArray

      void beginArray()
      Read array begin.

    • endArray

      void endArray()
      Read array end.

    • hasNextElement

      boolean hasNextElement()
      Return true if there is a next element.

    • beginObject

      void beginObject()
      Read begin object.

    • endObject

      void endObject()
      Read end object.

    • hasNextField

      boolean hasNextField()
      Return true if there is a next field to be read.

    • nextField

      String nextField()
      Return the next field.

    • nextBoolean

      boolean nextBoolean()
      Read and return the next value as a boolean.

    • nextInt

      int nextInt()
      Read and return the next value as an int.

    • nextLong

      long nextLong()
      Read and return the next value as a long.

    • nextDouble

      double nextDouble()
      Read and return the next value as a double.

    • nextDecimal

      BigDecimal nextDecimal()
      Read and return the next value as a BigDecimal.

    • nextBigInteger

      BigInteger nextBigInteger()
      Read and return the next value as a BigInteger.

    • nextString

      String nextString()
      Read and return the next value as String.

    • peekIsNull

      boolean peekIsNull()
      Return true if the next value is a null.

    • nextNull

      <T> T nextNull()
      Return the next value as a null.

    • path

      String path()
      Return the current path.

    • peek

      JsonReader.Token peek()
      Return the current Token.

    • close

      void close()
      Close the resources of the reader.
      Specified by:
      close in interface AutoCloseable
      Specified by:
      close in interface Closeable

    • skipValue

      void skipValue()
      Skip the next value.

    • unmappedField

      void unmappedField(String fieldName)
      Reading json with an unmapped field, throw an Exception if failOnUnmapped is true.