Class ResponseMarshaler.Builder

java.lang.Object

com.soklet.ResponseMarshaler.Builder

Enclosing interface:

ResponseMarshaler

@NotThreadSafe
public static class ResponseMarshaler.Builder
extends Object

Builder used to construct a standard implementation of ResponseMarshaler.

This class is intended for use by a single thread.

Author:

Mark Allen

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ResponseMarshaler.Builder.ContentTooLargeHandler
static interface	ResponseMarshaler.Builder.CorsAllowedHandler
static interface	ResponseMarshaler.Builder.CorsPreflightAllowedHandler
static interface	ResponseMarshaler.Builder.CorsPreflightRejectedHandler
static interface	ResponseMarshaler.Builder.HappyPathHandler
static interface	ResponseMarshaler.Builder.HeadHandler
static interface	ResponseMarshaler.Builder.MethodNotAllowedHandler
static interface	ResponseMarshaler.Builder.NotFoundHandler
static interface	ResponseMarshaler.Builder.OptionsHandler
static interface	ResponseMarshaler.Builder.PostProcessor
static interface	ResponseMarshaler.Builder.ThrowableHandler

Method Summary

Modifier and Type	Method	Description
ResponseMarshaler	build()	Constructs a default ResponseMarshaler instance.
ResponseMarshaler.Builder	charset(Charset charset)	Specifies the default charset to use for encoding character data.
ResponseMarshaler.Builder	contentTooLarge(ResponseMarshaler.Builder.ContentTooLargeHandler contentTooLargeHandler)
ResponseMarshaler.Builder	corsAllowed(ResponseMarshaler.Builder.CorsAllowedHandler corsAllowedHandler)
ResponseMarshaler.Builder	corsPreflightAllowed(ResponseMarshaler.Builder.CorsPreflightAllowedHandler corsPreflightAllowedHandler)
ResponseMarshaler.Builder	corsPreflightRejected(ResponseMarshaler.Builder.CorsPreflightRejectedHandler corsPreflightRejectedHandler)
ResponseMarshaler.Builder	happyPath(ResponseMarshaler.Builder.HappyPathHandler happyPathHandler)	Specifies a custom "happy path" handler for requests.
ResponseMarshaler.Builder	head(ResponseMarshaler.Builder.HeadHandler headHandler)
ResponseMarshaler.Builder	methodNotAllowed(ResponseMarshaler.Builder.MethodNotAllowedHandler methodNotAllowedHandler)
ResponseMarshaler.Builder	notFound(ResponseMarshaler.Builder.NotFoundHandler notFoundHandler)
ResponseMarshaler.Builder	options(ResponseMarshaler.Builder.OptionsHandler optionsHandler)
ResponseMarshaler.Builder	postProcessor(ResponseMarshaler.Builder.PostProcessor postProcessor)	Specifies an optional "post-process" hook for any final customization or processing before data goes over the wire.
ResponseMarshaler.Builder	throwable(ResponseMarshaler.Builder.ThrowableHandler throwableHandler)

Methods inherited from class Object

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

Method Details

charset

@Nonnull
public ResponseMarshaler.Builder charset(@Nonnull
 Charset charset)

Specifies the default charset to use for encoding character data.

Parameters:

charset - the charset to use for encoding character data

Returns:

this Builder, for chaining

happyPath

@Nonnull
public ResponseMarshaler.Builder happyPath(@Nullable
 ResponseMarshaler.Builder.HappyPathHandler happyPathHandler)

Specifies a custom "happy path" handler for requests.

Parameters:

happyPathHandler - an optional "happy path" handler

Returns:

this Builder, for chaining

notFound

@Nonnull
public ResponseMarshaler.Builder notFound(@Nullable
 ResponseMarshaler.Builder.NotFoundHandler notFoundHandler)

methodNotAllowed

@Nonnull
public ResponseMarshaler.Builder methodNotAllowed(@Nullable
 ResponseMarshaler.Builder.MethodNotAllowedHandler methodNotAllowedHandler)

contentTooLarge

@Nonnull
public ResponseMarshaler.Builder contentTooLarge(@Nullable
 ResponseMarshaler.Builder.ContentTooLargeHandler contentTooLargeHandler)

options

@Nonnull
public ResponseMarshaler.Builder options(@Nullable
 ResponseMarshaler.Builder.OptionsHandler optionsHandler)

throwable

@Nonnull
public ResponseMarshaler.Builder throwable(@Nullable
 ResponseMarshaler.Builder.ThrowableHandler throwableHandler)

head

@Nonnull
public ResponseMarshaler.Builder head(@Nullable
 ResponseMarshaler.Builder.HeadHandler headHandler)

corsPreflightAllowed

@Nonnull
public ResponseMarshaler.Builder corsPreflightAllowed(@Nullable
 ResponseMarshaler.Builder.CorsPreflightAllowedHandler corsPreflightAllowedHandler)

corsPreflightRejected

@Nonnull
public ResponseMarshaler.Builder corsPreflightRejected(@Nullable
 ResponseMarshaler.Builder.CorsPreflightRejectedHandler corsPreflightRejectedHandler)

corsAllowed

@Nonnull
public ResponseMarshaler.Builder corsAllowed(@Nullable
 ResponseMarshaler.Builder.CorsAllowedHandler corsAllowedHandler)

postProcessor

@Nonnull
public ResponseMarshaler.Builder postProcessor(@Nullable
 ResponseMarshaler.Builder.PostProcessor postProcessor)

Specifies an optional "post-process" hook for any final customization or processing before data goes over the wire.

Parameters:

postProcessor - an optional "post-process" hook

Returns:

this Builder, for chaining

build

@Nonnull
public ResponseMarshaler build()

Constructs a default ResponseMarshaler instance.

The constructed instance is thread-safe.

Returns:

a ResponseMarshaler instance