Class JsonParser

java.lang.Object
io.vertx.reactivex.core.parsetools.JsonParser
All Implemented Interfaces:
Handler<Buffer>, io.vertx.lang.rx.RxDelegate, ReadStream<JsonEvent>, StreamBase
public class JsonParser extends Object implements io.vertx.lang.rx.RxDelegate, ReadStream<JsonEvent>, Handler<Buffer>
A parser class which allows to incrementally parse json elements and emit json parse events instead of parsing a json element fully. This parser is convenient for parsing large json structures.

The parser also parses concatenated json streams or line delimited json streams.

The parser can also parse entire object or array when it is convenient, for instance a very large array of small objects can be parsed efficiently by handling array start/end and object events.

Whenever the parser fails to parse or process the stream, the exceptionHandler(Handler) is called with the cause of the failure and the current handling stops. After such event, the parser should not handle data anymore.

NOTE: This class has been automatically generated from the original non RX-ified interface using Vert.x codegen.

  • Field Details

    • __TYPE_ARG

      public static final io.vertx.lang.rx.TypeArg<JsonParser> __TYPE_ARG

  • Constructor Details

    • JsonParser

      public JsonParser(JsonParser delegate)

    • JsonParser

      public JsonParser(Object delegate)

  • Method Details

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • getDelegate

      public JsonParser getDelegate()
      Specified by:
      getDelegate in interface ReadStream<JsonEvent>
      Specified by:
      getDelegate in interface io.vertx.lang.rx.RxDelegate
      Specified by:
      getDelegate in interface StreamBase

    • toObservable

      public Observable<JsonEvent> toObservable()
      Specified by:
      toObservable in interface ReadStream<JsonEvent>

    • toFlowable

      public Flowable<JsonEvent> toFlowable()
      Specified by:
      toFlowable in interface ReadStream<JsonEvent>

    • handle

      public void handle(Buffer event)
      Something has happened, so handle it.
      Specified by:
      handle in interface Handler<Buffer>
      Parameters:
      event - the event to handle

    • pipe

      public Pipe<JsonEvent> pipe()
      Pause this stream and return a to transfer the elements of this stream to a destination .

      The stream will be resumed when the pipe will be wired to a WriteStream.

      Specified by:
      pipe in interface ReadStream<JsonEvent>
      Returns:
      a pipe

    • pipeTo

      public Future<Void> pipeTo(WriteStream<JsonEvent> dst)
      Pipe this ReadStream to the WriteStream.

      Elements emitted by this stream will be written to the write stream until this stream ends or fails.

      Specified by:
      pipeTo in interface ReadStream<JsonEvent>
      Parameters:
      dst - the destination write stream
      Returns:
      a future notified when the write stream will be ended with the outcome

    • rxPipeTo

      public Completable rxPipeTo(WriteStream<JsonEvent> dst)
      Pipe this ReadStream to the WriteStream.

      Elements emitted by this stream will be written to the write stream until this stream ends or fails.

      Specified by:
      rxPipeTo in interface ReadStream<JsonEvent>
      Parameters:
      dst - the destination write stream
      Returns:
      a future notified when the write stream will be ended with the outcome

    • newParser

      public static JsonParser newParser()
      Create a new JsonParser instance.
      Returns:

    • newParser

      public static JsonParser newParser(ReadStream<Buffer> stream)
      Create a new JsonParser instance.
      Parameters:
      stream -
      Returns:

    • newParser

      public static JsonParser newParser(Flowable<Buffer> stream)
      Create a new JsonParser instance.
      Parameters:
      stream -
      Returns:

    • write

      public JsonParser write(Buffer buffer)
      Handle a Buffer, pretty much like calling Handler.
      Parameters:
      buffer -
      Returns:
      a reference to this, so the API can be used fluently

    • end

      public void end()
      End the stream, this must be called after all the json stream has been processed.

    • objectEventMode

      public JsonParser objectEventMode()
      Flip the parser to emit a stream of events for each new json object.
      Returns:
      a reference to this, so the API can be used fluently

    • objectValueMode

      public JsonParser objectValueMode()
      Flip the parser to emit a single value event for each new json object.

      Json object currently streamed won't be affected.
      Returns:
      a reference to this, so the API can be used fluently

    • arrayEventMode

      public JsonParser arrayEventMode()
      Flip the parser to emit a stream of events for each new json array.
      Returns:
      a reference to this, so the API can be used fluently

    • arrayValueMode

      public JsonParser arrayValueMode()
      Flip the parser to emit a single value event for each new json array.

      Json array currently streamed won't be affected.
      Returns:
      a reference to this, so the API can be used fluently

    • pause

      public JsonParser pause()
      Description copied from interface: ReadStream
      Pause the ReadStream, it sets the buffer in fetch mode and clears the actual demand.

      While it's paused, no data will be sent to the data handler.

      Specified by:
      pause in interface ReadStream<JsonEvent>
      Returns:
      a reference to this, so the API can be used fluently

    • resume

      public JsonParser resume()
      Description copied from interface: ReadStream
      Resume reading, and sets the buffer in flowing mode.

      If the ReadStream has been paused, reading will recommence on it.

      Specified by:
      resume in interface ReadStream<JsonEvent>
      Returns:
      a reference to this, so the API can be used fluently

    • fetch

      public JsonParser fetch(long amount)
      Description copied from interface: ReadStream
      Fetch the specified amount of elements. If the ReadStream has been paused, reading will recommence with the specified amount of items, otherwise the specified amount will be added to the current stream demand.
      Specified by:
      fetch in interface ReadStream<JsonEvent>
      Parameters:
      amount -
      Returns:
      a reference to this, so the API can be used fluently

    • endHandler

      public JsonParser endHandler(Handler<Void> endHandler)
      Description copied from interface: ReadStream
      Set an end handler. Once the stream has ended, and there is no more data to be read, this handler will be called.
      Specified by:
      endHandler in interface ReadStream<JsonEvent>
      Parameters:
      endHandler -
      Returns:
      a reference to this, so the API can be used fluently

    • handler

      public JsonParser handler(Handler<JsonEvent> handler)
      Description copied from interface: ReadStream
      Set a data handler. As data is read, the handler will be called with the data.
      Specified by:
      handler in interface ReadStream<JsonEvent>
      Parameters:
      handler -
      Returns:
      a reference to this, so the API can be used fluently

    • exceptionHandler

      public JsonParser exceptionHandler(Handler<Throwable> handler)
      Description copied from interface: ReadStream
      Set an exception handler on the read stream.
      Specified by:
      exceptionHandler in interface ReadStream<JsonEvent>
      Specified by:
      exceptionHandler in interface StreamBase
      Parameters:
      handler - the exception handler
      Returns:
      a reference to this, so the API can be used fluently

    • newInstance

      public static JsonParser newInstance(JsonParser arg)