com.splunk

Class ResultsReaderJson

java.lang.Object

com.splunk.ResultsReader

com.splunk.ResultsReaderJson

All Implemented Interfaces:

SearchResults, Iterable<Event>

public class ResultsReaderJson
extends ResultsReader

The ResultsReaderJson class represents a streaming JSON reader for Splunk search results. This class requires the gson-2.1.jar file in your build path. If you want to access the preview events, use the MultiResultsReaderJson class.

Field Summary

Fields inherited from class com.splunk.ResultsReader

inputStream

Constructor Summary

Constructors

Constructor and Description
ResultsReaderJson(InputStream inputStream) Class constructor.

Method Summary

Modifier and Type	Method and Description
void	close() Closes the reader and returns resources.
Collection<String>	getFields() This method is not supported.
boolean	isPreview() Indicates whether the results are a preview from an unfinished search.

Methods inherited from class com.splunk.ResultsReader

getNextEvent, iterator

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

ResultsReaderJson

public ResultsReaderJson(InputStream inputStream)
                  throws IOException

Class constructor. Constructs a streaming JSON reader for the event stream. You should only attempt to parse a JSON stream with this reader. If you attempt to parse a different type of stream, unpredictable results may occur.

Parameters:

inputStream - The JSON stream to parse.

Throws:

IOException - The IOException instance

Method Detail

close

public void close()
           throws IOException

Closes the reader and returns resources.

Overrides:

close in class ResultsReader

Throws:

IOException - On IO exception.

isPreview

public boolean isPreview()

Indicates whether the results are a preview from an unfinished search.

Returns:

true if the results are a preview, false if not.

getFields

public Collection<String> getFields()

This method is not supported.

Returns:

Not applicable.