feign.jackson

Class JacksonIteratorDecoder

java.lang.Object

feign.jackson.JacksonIteratorDecoder

All Implemented Interfaces:

Decoder

public final class JacksonIteratorDecoder
extends Object
implements Decoder

Jackson decoder which return a closeable iterator. Returned iterator auto-close the Response when it reached json array end or failed to parse stream. If this iterator is not fetched till the end, it has to be casted to Closeable and explicity Closeable#close by the consumer.

Example:

 Feign.builder()
   .decoder(JacksonIteratorDecoder.create())
   .doNotCloseAfterDecode() // Required to fetch the iterator after the response is processed, need to be close
   .target(GitHub.class, "https://api.github.com");
 interface GitHub {
   @RequestLine("GET /repos/{owner}/{repo}/contributors")
   Iterator contributors(@Param("owner") String owner, @Param("repo") String repo);
 }

Nested Class Summary

Nested classes/interfaces inherited from interface feign.codec.Decoder

Decoder.Default

Method Summary

Modifier and Type	Method and Description
static JacksonIteratorDecoder	create()
static JacksonIteratorDecoder	create(Iterable<com.fasterxml.jackson.databind.Module> modules)
static JacksonIteratorDecoder	create(com.fasterxml.jackson.databind.ObjectMapper objectMapper)
Object	decode(Response response, Type type)

Methods inherited from class java.lang.Object

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

Method Detail

decode

public Object decode(Response response,
                     Type type)
              throws IOException

Specified by:

decode in interface Decoder

Throws:

IOException

create

public static JacksonIteratorDecoder create()

create

public static JacksonIteratorDecoder create(Iterable<com.fasterxml.jackson.databind.Module> modules)

create

public static JacksonIteratorDecoder create(com.fasterxml.jackson.databind.ObjectMapper objectMapper)