com.yahoo.bard.webservice.web

Interface ResponseWriter

All Known Implementing Classes:

CsvResponseWriter, FiliResponseWriter, JsonAndJsonApiResponseWriter, JsonApiResponseWriter, JsonResponseWriter

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface ResponseWriter

The interface for objects that write fully-processed ResultSets back to the user. This allows customers to fully customize how they choose to serialize the results from Fili based on the request.

Method Summary

Modifier and Type	Method and Description
void	write(ApiRequest request, ResponseData responseData, OutputStream os) Serializes the ResultSet (pulled from the ResponseData) and any desired metadata and adds it to the specified output stream.

Method Detail

write

void write(ApiRequest request,
           ResponseData responseData,
           OutputStream os)
    throws IOException

Serializes the ResultSet (pulled from the ResponseData) and any desired metadata and adds it to the specified output stream.

Parameters:

request - ApiRequest object with all the associated info in it

responseData - Data object containing all the result information

os - OutputStream

Throws:

IOException - if a problem is encountered writing to the OutputStream