com.splunk
Class ResultsReader

java.lang.Object
  com.splunk.ResultsReader

Direct Known Subclasses:

ResultsReaderXml

public abstract class ResultsReader
extends java.lang.Object

Constructor Summary

ResultsReader(java.io.InputStream inputStream)
Class constructor.

Method Summary

void	close() Closes the reader and returns resources.
java.util.HashMap<java.lang.String,java.lang.String>	getNextEvent() Returns the next event in the event stream.

Methods inherited from class java.lang.Object

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

Constructor Detail

ResultsReader

public ResultsReader(java.io.InputStream inputStream)
              throws java.lang.Exception

Class constructor.

Parameters:

inputStream - The input stream (unread) return stream from a Splunk query or export.

Throws:

java.io.IOException - If an IO exception occurs.

java.lang.Exception

Method Detail

close

public void close()
           throws java.lang.Exception

Closes the reader and returns resources.

Throws:

java.lang.Exception - on Exception

getNextEvent

public java.util.HashMap<java.lang.String,java.lang.String> getNextEvent()
                                                                  throws java.lang.Exception

Returns the next event in the event stream.

Returns:

The hash map of key-value pairs for an entire event.

Throws:

java.lang.Exception - on Exception.