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, theexceptionHandler(io.vertx.core.Handler<java.lang.Throwable>)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
originalnon RX-ified interface using Vert.x codegen.
-
-
Field Summary
Fields Modifier and Type Field Description static io.vertx.lang.rx.TypeArg<JsonParser>__TYPE_ARG
-
Constructor Summary
Constructors Constructor Description JsonParser(JsonParser delegate)JsonParser(Object delegate)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description JsonParserarrayEventMode()Flip the parser to emit a stream of events for each new json array.JsonParserarrayValueMode()Flip the parser to emit a single value event for each new json array.voidend()End the stream, this must be called after all the json stream has been processed.JsonParserendHandler(Handler<Void> endHandler)Set an end handler.booleanequals(Object o)JsonParserexceptionHandler(Handler<Throwable> handler)Set an exception handler on the read stream.JsonParserfetch(long amount)Fetch the specifiedamountof elements.JsonParsergetDelegate()voidhandle(Buffer event)Something has happened, so handle it.JsonParserhandler(Handler<JsonEvent> handler)Set a data handler.inthashCode()static JsonParsernewInstance(JsonParser arg)static JsonParsernewParser()Create a newJsonParserinstance.static JsonParsernewParser(Flowable<Buffer> stream)Create a newJsonParserinstance.static JsonParsernewParser(ReadStream<Buffer> stream)Create a newJsonParserinstance.JsonParserobjectEventMode()Flip the parser to emit a stream of events for each new json object.JsonParserobjectValueMode()Flip the parser to emit a single value event for each new json object.JsonParserpause()Pause theReadStream, it sets the buffer infetchmode and clears the actual demand.Pipe<JsonEvent>pipe()Pause this stream and return a to transfer the elements of this stream to a destination .Future<Void>pipeTo(WriteStream<JsonEvent> dst)Pipe thisReadStreamto theWriteStream.JsonParserresume()Resume reading, and sets the buffer inflowingmode.CompletablerxPipeTo(WriteStream<JsonEvent> dst)Pipe thisReadStreamto theWriteStream.Flowable<JsonEvent>toFlowable()Observable<JsonEvent>toObservable()StringtoString()JsonParserwrite(Buffer buffer)Handle aBuffer, pretty much like callingHandler.
-
-
-
Field Detail
-
__TYPE_ARG
public static final io.vertx.lang.rx.TypeArg<JsonParser> __TYPE_ARG
-
-
Constructor Detail
-
JsonParser
public JsonParser(JsonParser delegate)
-
JsonParser
public JsonParser(Object delegate)
-
-
Method Detail
-
getDelegate
public JsonParser getDelegate()
- Specified by:
getDelegatein interfaceReadStream<JsonEvent>- Specified by:
getDelegatein interfaceio.vertx.lang.rx.RxDelegate- Specified by:
getDelegatein interfaceStreamBase
-
toObservable
public Observable<JsonEvent> toObservable()
- Specified by:
toObservablein interfaceReadStream<JsonEvent>
-
toFlowable
public Flowable<JsonEvent> toFlowable()
- Specified by:
toFlowablein interfaceReadStream<JsonEvent>
-
handle
public void handle(Buffer event)
Something has happened, so handle it.
-
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 aWriteStream.- Specified by:
pipein interfaceReadStream<JsonEvent>- Returns:
- a pipe
-
pipeTo
public Future<Void> pipeTo(WriteStream<JsonEvent> dst)
Pipe thisReadStreamto theWriteStream.Elements emitted by this stream will be written to the write stream until this stream ends or fails.
- Specified by:
pipeToin interfaceReadStream<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 thisReadStreamto theWriteStream.Elements emitted by this stream will be written to the write stream until this stream ends or fails.
- Specified by:
rxPipeToin interfaceReadStream<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 newJsonParserinstance.- Returns:
-
newParser
public static JsonParser newParser(ReadStream<Buffer> stream)
Create a newJsonParserinstance.- Parameters:
stream-- Returns:
-
newParser
public static JsonParser newParser(Flowable<Buffer> stream)
Create a newJsonParserinstance.- Parameters:
stream-- Returns:
-
write
public JsonParser write(Buffer buffer)
Handle aBuffer, pretty much like callingHandler.- 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:ReadStreamPause theReadStream, it sets the buffer infetchmode and clears the actual demand.While it's paused, no data will be sent to the data
handler.- Specified by:
pausein interfaceReadStream<JsonEvent>- Returns:
- a reference to this, so the API can be used fluently
-
resume
public JsonParser resume()
Description copied from interface:ReadStreamResume reading, and sets the buffer inflowingmode. If theReadStreamhas been paused, reading will recommence on it.- Specified by:
resumein interfaceReadStream<JsonEvent>- Returns:
- a reference to this, so the API can be used fluently
-
fetch
public JsonParser fetch(long amount)
Description copied from interface:ReadStreamFetch the specifiedamountof elements. If theReadStreamhas been paused, reading will recommence with the specifiedamountof items, otherwise the specifiedamountwill be added to the current stream demand.- Specified by:
fetchin interfaceReadStream<JsonEvent>- Returns:
- a reference to this, so the API can be used fluently
-
endHandler
public JsonParser endHandler(Handler<Void> endHandler)
Description copied from interface:ReadStreamSet an end handler. Once the stream has ended, and there is no more data to be read, this handler will be called.- Specified by:
endHandlerin interfaceReadStream<JsonEvent>- Returns:
- a reference to this, so the API can be used fluently
-
handler
public JsonParser handler(Handler<JsonEvent> handler)
Description copied from interface:ReadStreamSet a data handler. As data is read, the handler will be called with the data.- Specified by:
handlerin interfaceReadStream<JsonEvent>- Returns:
- a reference to this, so the API can be used fluently
-
exceptionHandler
public JsonParser exceptionHandler(Handler<Throwable> handler)
Description copied from interface:ReadStreamSet an exception handler on the read stream.- Specified by:
exceptionHandlerin interfaceReadStream<JsonEvent>- Specified by:
exceptionHandlerin interfaceStreamBase- Parameters:
handler- the exception handler- Returns:
- a reference to this, so the API can be used fluently
-
newInstance
public static JsonParser newInstance(JsonParser arg)
-
-