com.whitepages.proapi.api.client

Interface ResponseDecoder<R extends Response<?>,V>

public interface ResponseDecoder<R extends Response<?>,V>

Response decoders transform the raw response data from a compatible DataSource instance, and return a standardized Response. For example, they may take an InputStream of JSON and parse it into native data objects.

ResponseDecoder is part of the ResultFinder pipeline. ResultFinder instances link together the dataflow of the conversion of a Query to a Response via the following steps:

1. The Query is transformed to an intermediate form via a QueryCoder,
2. The intermediate form is used to fetch the raw response from the data source via a DataSource, and
3. The raw response is transformed into a normalized Response via a ResponseDecoder

See Also:

ResultFinder, ResultFinderImpl, QueryCoder, DataSource, ResponseDecoder, Response

Method Summary

Methods

Modifier and Type	Method and Description
R	decode(V responseData, Client client) Transforms raw response data into a standardized response.

Method Detail

decode

R decode(V responseData,
       Client client)
                             throws ResponseDecoderException

Transforms raw response data into a standardized response.

Parameters:

responseData - The raw response data.

client - The associated Client.

Returns:

The standardized Response.

Throws:

ResponseDecoderException - The wrapper for any errors encountered while attempting this transformation.