Package org.apache.juneau.rest.server.servlet

Class RestServlet.Builder<R extends RestServlet,SELF extends RestServlet.Builder<R,SELF>>

java.lang.Object

org.apache.juneau.rest.server.AbstractRestBuilder<R,SELF>

org.apache.juneau.rest.server.servlet.RestServlet.Builder<R,SELF>

Type Parameters:

R - The resource type produced by build().

SELF - The concrete builder type (self type).

All Implemented Interfaces:

RestBuilder<SELF>

Direct Known Subclasses:

RestServlet.DefaultBuilder

Enclosing class:

RestServlet

public static class RestServlet.Builder<R extends RestServlet,SELF extends RestServlet.Builder<R,SELF>>
extends AbstractRestBuilder<R,SELF>

Fluent builder for programmatically configuring a RestServlet subclass.

This is the subclassable, self-typed (CRTP) flavor builder. Its SELF type parameter is left open so a user subclass's bespoke setters chain with true covariant returns alongside the inherited RestBuilder surface. For the common case where the builder is not subclassed, use RestServlet.builder(Class) which returns the concrete RestServlet.DefaultBuilder leaf.

Since:

10.0.0

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Builder(Class<R> type)	Constructor.

Method Summary

Modifier and Type	Method	Description
R	build()	Builds the configured resource instance.

Methods inherited from class org.apache.juneau.rest.server.AbstractRestBuilder

allowedHeaderParams, allowedMethodHeaders, allowedMethodParams, allowedParserOptions, allowedSerializerOptions, asyncCompletionExecutor, asyncTimeoutMillis, children, clientVersionHeader, config, consumes, converters, createResource, debugMarshalling, defaultAccept, defaultCharset, defaultContentType, defaultRequestAttributes, defaultRequestHeaders, defaultResponseHeaders, description, disableContentParam, eagerInit, encoders, getExtras, getMdcAsyncPropagation, getResourceType, guards, lazyChildren, maxInput, mdcAsyncPropagation, messages, mixinDefs, mixins, noInherit, observability, openApiProvider, parsers, partParser, partSerializer, path, paths, problemDetails, produces, renderResponseStackTraces, responseProcessors, restOpArgs, roleGuard, rolesDeclared, self, serializers, set, siteName, staticFiles, swaggerProvider, title, toRestAnnotation, uriAuthority, uriContext, uriRelativity, uriResolution, virtualThreads

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

protected Builder(Class<R> type)

Constructor.

Parameters:

type - The resource type produced by build(). Must not be null.

Method Details

build

public R build()

Description copied from class: AbstractRestBuilder

Builds the configured resource instance.

Specified by:

build in class AbstractRestBuilder<R extends RestServlet,SELF extends RestServlet.Builder<R,SELF>>

Returns:

A new resource instance configured by this builder.