Class MarshaledResponse.Builder

java.lang.Object

com.soklet.MarshaledResponse.Builder

Enclosing class:

MarshaledResponse

@NotThreadSafe
public static final class MarshaledResponse.Builder
extends Object

Builder used to construct instances of MarshaledResponse via MarshaledResponse.withResponse(Response) or MarshaledResponse.withStatusCode(Integer).

Known-length bodies and streaming bodies are mutually exclusive. This builder does not automatically clear one when the other is set; use withoutBody() or withoutStream() before build() when switching body modes.

This class is intended for use by a single thread.

Author:

Mark Allen

Method Summary

Modifier and Type	Method	Description
@NonNull MarshaledResponse.Builder	body(@Nullable byte[] bytes)	Sets a byte-array-backed response body, or removes any current body if bytes is null.
@NonNull MarshaledResponse.Builder	body(@Nullable MarshaledResponseBody body)	Sets a response body descriptor, or removes any current body if body is null.
@NonNull MarshaledResponse.Builder	body(@Nullable ByteBuffer byteBuffer)	Sets a byte-buffer-backed response body, or removes any current body if byteBuffer is null.
@NonNull MarshaledResponse.Builder	body(@NonNull FileChannel fileChannel, @NonNull Long offset, @NonNull Long count, @NonNull Boolean closeOnComplete)	Sets a file-channel-backed response body.
@NonNull MarshaledResponse.Builder	body(@NonNull Path path, @NonNull Long offset, @NonNull Long count)	Sets a ranged path-backed response body.
@NonNull MarshaledResponse.Builder	body(@Nullable Path path)	Sets a path-backed response body, or removes any current body if path is null.
@NonNull MarshaledResponse	build()
@NonNull MarshaledResponse.Builder	cookies(@Nullable Set<@NonNull ResponseCookie> cookies)
@NonNull MarshaledResponse.Builder	headers(@Nullable Map<@NonNull String, @NonNull Set<@NonNull String>> headers)
@NonNull MarshaledResponse.Builder	statusCode(@NonNull Integer statusCode)
@NonNull MarshaledResponse.Builder	stream(@Nullable StreamingResponseBody stream)	Sets a streaming response body, or removes any current stream if stream is null.
@NonNull MarshaledResponse.Builder	withoutBody()	Removes the response body from this builder.
@NonNull MarshaledResponse.Builder	withoutStream()	Removes the streaming response body from this builder.

Methods inherited from class Object

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

Method Details

statusCode

public @NonNull MarshaledResponse.Builder statusCode(@NonNull Integer statusCode)

cookies

public @NonNull MarshaledResponse.Builder cookies(@Nullable Set<@NonNull ResponseCookie> cookies)

headers

public @NonNull MarshaledResponse.Builder headers(@Nullable Map<@NonNull String, @NonNull Set<@NonNull String>> headers)

body

public @NonNull MarshaledResponse.Builder body(@Nullable byte[] bytes)

Sets a byte-array-backed response body, or removes any current body if bytes is null.

Parameters:

bytes - the response bytes to write, or null for no body

Returns:

this builder

body

public @NonNull MarshaledResponse.Builder body(@Nullable MarshaledResponseBody body)

Sets a response body descriptor, or removes any current body if body is null.

Parameters:

body - the response body descriptor to write, or null for no body

Returns:

this builder

body

public @NonNull MarshaledResponse.Builder body(@Nullable Path path)

Sets a path-backed response body, or removes any current body if path is null.

Parameters:

path - the file path to write, or null for no body

Returns:

this builder

body

public @NonNull MarshaledResponse.Builder body(@NonNull Path path,
 @NonNull Long offset,
 @NonNull Long count)

Sets a ranged path-backed response body.

Parameters:

path - the file path to write

offset - the zero-based file offset from which response bytes should be written

count - the number of file bytes to write

Returns:

this builder

body

public @NonNull MarshaledResponse.Builder body(@NonNull FileChannel fileChannel,
 @NonNull Long offset,
 @NonNull Long count,
 @NonNull Boolean closeOnComplete)

Sets a file-channel-backed response body.

Parameters:

fileChannel - the file channel to write

offset - the zero-based channel offset from which response bytes should be written

count - the number of channel bytes to write

closeOnComplete - whether Soklet should close the channel after response completion

Returns:

this builder

body

public @NonNull MarshaledResponse.Builder body(@Nullable ByteBuffer byteBuffer)

Sets a byte-buffer-backed response body, or removes any current body if byteBuffer is null.

Parameters:

byteBuffer - the byte buffer to write, or null for no body

Returns:

this builder

stream

public @NonNull MarshaledResponse.Builder stream(@Nullable StreamingResponseBody stream)

Sets a streaming response body, or removes any current stream if stream is null.

A response may have a known-length body or a stream, but not both. Setting a stream does not remove any current known-length body; call withoutBody() first if replacing a known-length body with a stream. build() rejects responses that still specify both.

Parameters:

stream - the streaming response body to write, or null for no stream

Returns:

this builder

withoutBody

public @NonNull MarshaledResponse.Builder withoutBody()

Removes the response body from this builder.

If the current body owns a caller-supplied FileChannel, the channel is closed before it is removed. Path-backed file bodies are lazy and do not hold open resources at this point.

Returns:

this builder

withoutStream

public @NonNull MarshaledResponse.Builder withoutStream()

Removes the streaming response body from this builder.

Returns:

this builder

build

public @NonNull MarshaledResponse build()