Module io.helidon.integrations.common.rest

Package io.helidon.integrations.common.rest

Class ApiOptionalResponse<R>

java.lang.Object

io.helidon.integrations.common.rest.ApiJsonParser

io.helidon.integrations.common.rest.ApiResponse

io.helidon.integrations.common.rest.ApiOptionalResponse<R>

Type Parameters:

R - type of the (optional) response object created from entity

Direct Known Subclasses:

VaultOptionalResponse

public class ApiOptionalResponse<R>
extends ApiResponse

A response for requests that may or may not return an entity, such as GET requests that may have a 404 response code.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ApiOptionalResponse.Builder<X,R>	Fluent API builder for ApiOptionalResponse.
static class	ApiOptionalResponse.BuilderBase<B extends ApiOptionalResponse.BuilderBase<B,T,X,R>,T extends ApiOptionalResponse<R>,X,R>	Fluent API builder base for subclasses of ApiOptionalResponse.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ApiOptionalResponse(ApiOptionalResponse.BuilderBase<?,?,?,?> builder, Optional<R> entity)

Method Summary

Modifier and Type	Method	Description
static <X, R> ApiOptionalResponse.Builder<X,R>	apiResponseBuilder()	A builder to create an optional response.
Optional<R>	entity()	Get the entity if it is present.
<U> ApiOptionalResponse<U>	map(Function<R,U> mapper)	Map the (possible) response entity to a different type.

Methods inherited from class io.helidon.integrations.common.rest.ApiResponse

headers, requestId, status

Methods inherited from class io.helidon.integrations.common.rest.ApiJsonParser

isPresent, stringValue, toBoolean, toBytesBase64, toDouble, toInstant, toInt, toList, toLong, toMap, toObject, toString

Methods inherited from class java.lang.Object

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

Constructor Details

ApiOptionalResponse

protected ApiOptionalResponse(ApiOptionalResponse.BuilderBase<?,?,?,?> builder,
 Optional<R> entity)

Method Details

apiResponseBuilder

public static <X,
R>
ApiOptionalResponse.Builder<X,R> apiResponseBuilder()

A builder to create an optional response. Method name is not builder to allow subclasses to define their own builder methods.

Type Parameters:

X - expected entity (such as JsonObject

R - type of object used to represent the entity

Returns:

a new builder

entity

public Optional<R> entity()

Get the entity if it is present.

Returns:

optional with the entity

map

public <U> ApiOptionalResponse<U> map(Function<R,U> mapper)

Map the (possible) response entity to a different type.

Type Parameters:

U - new type

Parameters:

mapper - mapper function

Returns:

new optional response with the mapped entity