com.microsoft.azure

Class AzureResponseBuilder<T,E extends RestException>

java.lang.Object

com.microsoft.azure.AzureResponseBuilder<T,E>

Type Parameters:

T - the return type from caller.

E - the exception to throw in case of error.

All Implemented Interfaces:

ResponseBuilder<T,E>

public final class AzureResponseBuilder<T,E extends RestException>
extends Object
implements ResponseBuilder<T,E>

The builder for building a ServiceResponse customized for Azure.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AzureResponseBuilder.Factory A factory to create an Azure response builder.

Method Summary

Modifier and Type	Method and Description
ServiceResponse<T>	build(retrofit2.Response<okhttp3.ResponseBody> response)
ServiceResponse<T>	buildEmpty(retrofit2.Response<Void> response)
<THeader> ServiceResponseWithHeaders<T,THeader>	buildEmptyWithHeaders(retrofit2.Response<Void> response, Class<THeader> headerType)
<THeader> ServiceResponseWithHeaders<T,THeader>	buildWithHeaders(retrofit2.Response<okhttp3.ResponseBody> response, Class<THeader> headerType)
ResponseBuilder<T,E>	register(int statusCode, Type type)
ResponseBuilder<T,E>	registerError(Class<? extends RestException> type)
AzureResponseBuilder<T,E>	withThrowOnGet404(boolean throwOnGet404) Specifies whether to throw on 404 responses from a GET call.

Methods inherited from class java.lang.Object

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

Method Detail

register

public ResponseBuilder<T,E> register(int statusCode,
                                     Type type)

Specified by:

register in interface ResponseBuilder<T,E extends RestException>

registerError

public ResponseBuilder<T,E> registerError(Class<? extends RestException> type)

Specified by:

registerError in interface ResponseBuilder<T,E extends RestException>

build

public ServiceResponse<T> build(retrofit2.Response<okhttp3.ResponseBody> response)
                         throws IOException

Specified by:

build in interface ResponseBuilder<T,E extends RestException>

Throws:

IOException

buildEmpty

public ServiceResponse<T> buildEmpty(retrofit2.Response<Void> response)
                              throws E extends RestException,
                                     IOException

Specified by:

buildEmpty in interface ResponseBuilder<T,E extends RestException>

Throws:

E extends RestException

IOException

buildWithHeaders

public <THeader> ServiceResponseWithHeaders<T,THeader> buildWithHeaders(retrofit2.Response<okhttp3.ResponseBody> response,
                                                                        Class<THeader> headerType)
                                                                 throws IOException

Specified by:

buildWithHeaders in interface ResponseBuilder<T,E extends RestException>

Throws:

IOException

buildEmptyWithHeaders

public <THeader> ServiceResponseWithHeaders<T,THeader> buildEmptyWithHeaders(retrofit2.Response<Void> response,
                                                                             Class<THeader> headerType)
                                                                      throws IOException

Specified by:

buildEmptyWithHeaders in interface ResponseBuilder<T,E extends RestException>

Throws:

IOException

withThrowOnGet404

public AzureResponseBuilder<T,E> withThrowOnGet404(boolean throwOnGet404)

Specifies whether to throw on 404 responses from a GET call.

Parameters:

throwOnGet404 - true if to throw; false to simply return null. Default is false.

Returns:

the response builder itself