com.jsunsoft.http

Interface ResponseHandler<T>

Type Parameters:

T - Type of converted content from response

public interface ResponseHandler<T>

ResponseHandler objects are immutable they can be shared.

The instance which contains converted response content and provide a lot of methods to manipulation and checking.

Method Summary

Modifier and Type	Method and Description
FilterSupport<T>	filter(Predicate<ResponseHandler<T>> predicate)
T	get() Strongly recommend call get method after check content is present.
org.apache.http.entity.ContentType	getContentType()
String	getErrorText()
<X extends Throwable> T	getOrThrow(Supplier<X> exceptionSupplier)
<X extends Throwable> T	getOrThrow(T defaultValue, Supplier<X> exceptionSupplier)
int	getStatusCode()
org.apache.http.StatusLine	getStatusLine() Obtains the status line of this response.
URI	getURI()
boolean	hasContent()
default boolean	hasNotContent()
void	ifHasContent(Consumer<? super T> consumer) If has a content, invoke the specified consumer with the content, otherwise do nothing.
void	ifNotSuccess(Consumer<ResponseHandler<T>> consumer) If status code is not success , invoke the specified consumer with the responseHandler.
OtherwiseSupport<T>	ifSuccess(Consumer<ResponseHandler<T>> consumer) If status code is success , invoke the specified consumer with the responseHandler and returns OtherwiseSupport with ignore else OtherwiseSupport with not ignore.
default boolean	isNonSuccess()
boolean	isSuccess()
T	orElse(T defaultValue)
T	orElseThrow()
T	orElseThrow(T defaultValue)
<X extends Throwable> T	orThrow(Function<ResponseHandler<? super T>,X> exceptionFunction)
<X extends Throwable> T	orThrow(T defaultValue, Function<ResponseHandler<? super T>,X> exceptionFunction)

Method Detail

hasContent

boolean hasContent()

Returns:

true If content is present else false

hasNotContent

default boolean hasNotContent()

Returns:

true If hasn't content else false

getStatusCode

int getStatusCode()

Returns:

Status code

orElse

T orElse(T defaultValue)

Parameters:

defaultValue - value to return if content isn't present

Returns:

Deserialized Content from response. If content isn't present returns defaultValue.

Throws:

UnsupportedOperationException - if generic type is a Void

orElseThrow

T orElseThrow(T defaultValue)

Parameters:

defaultValue - value to return if status code is success and hasn't body

Returns:

Deserialized Content from response. If hasn't body returns defaultValue.

Throws:

UnexpectedStatusCodeException - If status code is not success

UnsupportedOperationException - if generic type is a Void

orThrow

<X extends Throwable> T orThrow(Function<ResponseHandler<? super T>,X> exceptionFunction)
                         throws X extends Throwable

Type Parameters:

X - Type of the exception to be thrown

Parameters:

exceptionFunction - Instance of type Function by parameter this which returns exception to throw if status code isn't success.

Returns:

Deserialized content from response. If hasn't body returns null.

Throws:

X - If status code isn't success.

X extends Throwable

orThrow

<X extends Throwable> T orThrow(T defaultValue,
                                Function<ResponseHandler<? super T>,X> exceptionFunction)
                         throws X extends Throwable

Type Parameters:

X - Type of the exception to be thrown

Parameters:

defaultValue - Value to return if content is null

exceptionFunction - Instance of type Function by parameter this which returns exception to throw if status code isn't success.

Returns:

Deserialized content from response. If hasn't body returns defaultValue.

Throws:

X - If status code isn't success.

X extends Throwable

getOrThrow

<X extends Throwable> T getOrThrow(Supplier<X> exceptionSupplier)
                            throws X extends Throwable

Type Parameters:

X - Type of the exception to be thrown

Parameters:

exceptionSupplier - Instance of type Supplier which returns exception to throw if status code isn't success.

Returns:

Deserialized content from response. If hasn't body returns null.

Throws:

X - If status code isn't success.

X extends Throwable

getOrThrow

<X extends Throwable> T getOrThrow(T defaultValue,
                                   Supplier<X> exceptionSupplier)
                            throws X extends Throwable

Type Parameters:

X - Type of the exception to be thrown

Parameters:

defaultValue - Value to return if content is null

exceptionSupplier - Instance of type Supplier which returns exception to throw if status code isn't success.

Returns:

Deserialized content from response. If hasn't body returns defaultValue.

Throws:

X - If status code isn't success.

X extends Throwable

orElseThrow

T orElseThrow()

Returns:

Content from response. Returns null if hasn't body

Throws:

UnexpectedStatusCodeException - If response code is not success

UnsupportedOperationException - if generic type is a Void

get

T get()

Strongly recommend call get method after check content is present. For example

     if(responseHandler.hasContent()){
         responseHandler.get()
     }
 

Returns:

Deserialized content from response.

Throws:

NoSuchContentException - If content is not present

UnsupportedOperationException - if generic type is a Void

See Also:

orElse(Object), ifHasContent(Consumer)

getErrorText

String getErrorText()

Returns:

Returns the error text if the connection failed but the server sent useful data nonetheless.

Throws:

NoSuchElementException - If error text is not present

UnsupportedOperationException - if generic type is a Void

getURI

URI getURI()

Returns:

Returns the connection URI

getStatusLine

org.apache.http.StatusLine getStatusLine()

Obtains the status line of this response.

Returns:

the status line.

getContentType

org.apache.http.entity.ContentType getContentType()

Returns:

Content type of response

isSuccess

boolean isSuccess()

Returns:

Returns true if status code contains [200, 300) else false

isNonSuccess

default boolean isNonSuccess()

Returns:

Returns true if status code isn't contains [200, 300) else false

ifHasContent

void ifHasContent(Consumer<? super T> consumer)

If has a content, invoke the specified consumer with the content, otherwise do nothing.

Parameters:

consumer - block to be executed if has a content

Throws:

IllegalArgumentException - if consumer is null

ifSuccess

OtherwiseSupport<T> ifSuccess(Consumer<ResponseHandler<T>> consumer)

If status code is success , invoke the specified consumer with the responseHandler and returns OtherwiseSupport with ignore else OtherwiseSupport with not ignore.

Parameters:

consumer - block to be executed if status code is success.

Returns:

OtherwiseSupport instance to support action otherwise.

See Also:

OtherwiseSupport.otherwise(Consumer)

ifNotSuccess

void ifNotSuccess(Consumer<ResponseHandler<T>> consumer)

If status code is not success , invoke the specified consumer with the responseHandler.

Parameters:

consumer - block to be executed if status code is not success.

filter

FilterSupport<T> filter(Predicate<ResponseHandler<T>> predicate)