org.ojai

Interface DocumentListener

@API.Public
public interface DocumentListener

Method Summary

Modifier and Type	Method and Description
boolean	documentArrived(Document document) Called when a Document from the DocumentStream is available for consumption.
void	eos() Called when the end of the document stream is reached.
void	failed(Exception e) Called when an Exception occurs while retrieving a Document.

Method Detail

documentArrived

boolean documentArrived(@API.NonNullable
                        Document document)

Called when a Document from the DocumentStream is available for consumption.

Parameters:

document - the available Document

Returns:

the implementation should return false to stop listening for more documents at which point the stream is closed

failed

void failed(@API.NonNullable
            Exception e)

Called when an Exception occurs while retrieving a Document. The DocumentListener will be closed and no new document will be returned.

Parameters:

e - the exception that describes the failure

eos

void eos()

Called when the end of the document stream is reached. The stream is already closed at this point.