Package org.apache.juneau.rest.server

Class RestAnnotation.Builder

java.lang.Object

org.apache.juneau.commons.AnnotationObject.Builder

org.apache.juneau.rest.server.RestAnnotation.Builder

Enclosing class:

RestAnnotation

public static class RestAnnotation.Builder
extends AnnotationObject.Builder

Builder class.

See Also:

• Context.Builder.annotations(Annotation...)

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Builder()	Constructor.

Method Summary

Modifier and Type	Method	Description
RestAnnotation.Builder	allowedHeaderParams(String value)	Sets the Rest.allowedHeaderParams() property on this annotation.
RestAnnotation.Builder	allowedMethodHeaders(String value)	Sets the Rest.allowedMethodHeaders() property on this annotation.
RestAnnotation.Builder	allowedMethodParams(String value)	Sets the Rest.allowedMethodParams() property on this annotation.
RestAnnotation.Builder	allowedParserOptions(String... value)	Sets the Rest.allowedParserOptions() property on this annotation.
RestAnnotation.Builder	allowedSerializerOptions(String... value)	Sets the Rest.allowedSerializerOptions() property on this annotation.
RestAnnotation.Builder	asyncCompletionExecutor(String value)	Sets the Rest.asyncCompletionExecutor() property on this annotation.
RestAnnotation.Builder	asyncTimeoutMillis(String value)	Sets the Rest.asyncTimeoutMillis() property on this annotation.
RestAnnotation.Builder	authenticator(Class<? extends RestAuthenticator> value)	Sets the Rest.authenticator() property on this annotation.
Rest	build()	Instantiates a new @Rest object initialized with this builder.
RestAnnotation.Builder	children(Class<?>... value)	Sets the Rest.children() property on this annotation.
RestAnnotation.Builder	childrenDefs(Child... value)	Sets the Rest.childrenDefs() property on this annotation.
RestAnnotation.Builder	clientVersionHeader(String value)	Sets the Rest.clientVersionHeader() property on this annotation.
RestAnnotation.Builder	config(String value)	Sets the Rest.config() property on this annotation.
RestAnnotation.Builder	consumes(String... value)	Sets the Rest.consumes() property on this annotation.
final RestAnnotation.Builder	converters(Class<? extends RestConverter>... value)	Sets the Rest.converters() property on this annotation.
RestAnnotation.Builder	debugMarshalling(String value)	Sets the Rest.debugMarshalling() property on this annotation.
RestAnnotation.Builder	defaultAccept(String value)	Sets the Rest.defaultAccept() property on this annotation.
RestAnnotation.Builder	defaultCharset(String value)	Sets the Rest.defaultCharset() property on this annotation.
RestAnnotation.Builder	defaultContentType(String value)	Sets the Rest.defaultContentType() property on this annotation.
RestAnnotation.Builder	defaultRequestAttributes(String... value)	Sets the Rest.defaultRequestAttributes() property on this annotation.
RestAnnotation.Builder	defaultRequestHeaders(String... value)	Sets the Rest.defaultRequestHeaders() property on this annotation.
RestAnnotation.Builder	defaultResponseHeaders(String... value)	Sets the Rest.defaultResponseHeaders() property on this annotation.
RestAnnotation.Builder	description(String... value)	Sets the description property on this annotation.
RestAnnotation.Builder	disableContentParam(String value)	Sets the Rest.disableContentParam() property on this annotation.
RestAnnotation.Builder	eagerInit(String value)	Sets the Rest.eagerInit() property on this annotation.
final RestAnnotation.Builder	encoders(Class<? extends Encoder>... value)	Sets the Rest.encoders() property on this annotation.
final RestAnnotation.Builder	guards(Class<? extends RestGuard>... value)	Sets the Rest.guards() property on this annotation.
RestAnnotation.Builder	lazyChildren(String value)	Sets the Rest.lazyChildren() property on this annotation.
RestAnnotation.Builder	maxInput(String value)	Sets the Rest.maxInput() property on this annotation.
RestAnnotation.Builder	mergeResponseProcessorsIntoHost(boolean value)	Sets the Rest.mergeResponseProcessorsIntoHost() property on this annotation.
RestAnnotation.Builder	messages(String value)	Sets the Rest.messages() property on this annotation.
RestAnnotation.Builder	mixinDefs(Mixin... value)	Sets the Rest.mixinDefs() property on this annotation.
RestAnnotation.Builder	mixins(Class<?>... value)	Sets the Rest.mixins() property on this annotation.
RestAnnotation.Builder	noInherit(String... value)	Sets the Rest.noInherit() property on this annotation.
RestAnnotation.Builder	observability(String value)	Sets the Rest.observability() property on this annotation.
RestAnnotation.Builder	openApiProvider(Class<? extends OpenApiProvider> value)	Sets the Rest.openApiProvider() property on this annotation.
RestAnnotation.Builder	parsers(Class<?>... value)	Sets the Rest.parsers() property on this annotation.
RestAnnotation.Builder	partParser(Class<? extends HttpPartParser> value)	Sets the Rest.partParser() property on this annotation.
RestAnnotation.Builder	partSerializer(Class<? extends HttpPartSerializer> value)	Sets the Rest.partSerializer() property on this annotation.
RestAnnotation.Builder	path(String value)	Sets the Rest.path() property on this annotation.
RestAnnotation.Builder	paths(String... value)	Sets the Rest.paths() property on this annotation.
RestAnnotation.Builder	problemDetails(String value)	Sets the Rest.problemDetails() property on this annotation.
RestAnnotation.Builder	produces(String... value)	Sets the Rest.produces() property on this annotation.
RestAnnotation.Builder	renderResponseStackTraces(String value)	Sets the Rest.renderResponseStackTraces() property on this annotation.
final RestAnnotation.Builder	responseProcessors(Class<? extends ResponseProcessor>... value)	Sets the Rest.responseProcessors() property on this annotation.
final RestAnnotation.Builder	restOpArgs(Class<? extends RestOpArg>... value)	Sets the Rest.restOpArgs() property on this annotation.
RestAnnotation.Builder	roleGuard(String value)	Sets the Rest.roleGuard() property on this annotation.
RestAnnotation.Builder	rolesDeclared(String value)	Sets the Rest.rolesDeclared() property on this annotation.
final RestAnnotation.Builder	serializers(Class<? extends Serializer>... value)	Sets the Rest.serializers() property on this annotation.
RestAnnotation.Builder	siteName(String value)	Sets the Rest.siteName() property on this annotation.
RestAnnotation.Builder	staticFiles(Class<? extends StaticFiles> value)	Sets the Rest.staticFiles() property on this annotation.
RestAnnotation.Builder	swagger(Swagger value)	Sets the Rest.swagger() property on this annotation.
RestAnnotation.Builder	swaggerProvider(Class<? extends SwaggerProvider> value)	Sets the Rest.swaggerProvider() property on this annotation.
RestAnnotation.Builder	title(String... value)	Sets the Rest.title() property on this annotation.
RestAnnotation.Builder	uriAuthority(String value)	Sets the Rest.uriAuthority() property on this annotation.
RestAnnotation.Builder	uriContext(String value)	Sets the Rest.uriContext() property on this annotation.
RestAnnotation.Builder	uriRelativity(String value)	Sets the Rest.uriRelativity() property on this annotation.
RestAnnotation.Builder	uriResolution(String value)	Sets the Rest.uriResolution() property on this annotation.
RestAnnotation.Builder	virtualThreads(String value)	Sets the Rest.virtualThreads() property on this annotation.

Methods inherited from class org.apache.juneau.commons.AnnotationObject.Builder

getAnnotationType

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

protected Builder()

Constructor.

Method Details

allowedHeaderParams

public RestAnnotation.Builder allowedHeaderParams(String value)

Sets the Rest.allowedHeaderParams() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

allowedMethodHeaders

public RestAnnotation.Builder allowedMethodHeaders(String value)

Sets the Rest.allowedMethodHeaders() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

allowedMethodParams

public RestAnnotation.Builder allowedMethodParams(String value)

Sets the Rest.allowedMethodParams() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

build

public Rest build()

Instantiates a new @Rest object initialized with this builder.

Returns:

A new @Rest object.

description

public RestAnnotation.Builder description(String... value)

Sets the description property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

authenticator

public RestAnnotation.Builder authenticator(Class<? extends RestAuthenticator> value)

Sets the Rest.authenticator() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

children

public RestAnnotation.Builder children(Class<?>... value)

Sets the Rest.children() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

childrenDefs

public RestAnnotation.Builder childrenDefs(Child... value)

Sets the Rest.childrenDefs() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

mixins

public RestAnnotation.Builder mixins(Class<?>... value)

Sets the Rest.mixins() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

mixinDefs

public RestAnnotation.Builder mixinDefs(Mixin... value)

Sets the Rest.mixinDefs() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

mergeResponseProcessorsIntoHost

public RestAnnotation.Builder mergeResponseProcessorsIntoHost(boolean value)

Sets the Rest.mergeResponseProcessorsIntoHost() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

clientVersionHeader

public RestAnnotation.Builder clientVersionHeader(String value)

Sets the Rest.clientVersionHeader() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

config

public RestAnnotation.Builder config(String value)

Sets the Rest.config() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

eagerInit

public RestAnnotation.Builder eagerInit(String value)

Sets the Rest.eagerInit() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

lazyChildren

public RestAnnotation.Builder lazyChildren(String value)

Sets the Rest.lazyChildren() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

consumes

public RestAnnotation.Builder consumes(String... value)

Sets the Rest.consumes() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

allowedSerializerOptions

public RestAnnotation.Builder allowedSerializerOptions(String... value)

Sets the Rest.allowedSerializerOptions() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

allowedParserOptions

public RestAnnotation.Builder allowedParserOptions(String... value)

Sets the Rest.allowedParserOptions() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

noInherit

public RestAnnotation.Builder noInherit(String... value)

Sets the Rest.noInherit() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

converters

@SafeVarargs
public final RestAnnotation.Builder converters(Class<? extends RestConverter>... value)

Sets the Rest.converters() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

defaultAccept

public RestAnnotation.Builder defaultAccept(String value)

Sets the Rest.defaultAccept() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

defaultCharset

public RestAnnotation.Builder defaultCharset(String value)

Sets the Rest.defaultCharset() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

defaultContentType

public RestAnnotation.Builder defaultContentType(String value)

Sets the Rest.defaultContentType() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

defaultRequestAttributes

public RestAnnotation.Builder defaultRequestAttributes(String... value)

Sets the Rest.defaultRequestAttributes() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

defaultRequestHeaders

public RestAnnotation.Builder defaultRequestHeaders(String... value)

Sets the Rest.defaultRequestHeaders() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

defaultResponseHeaders

public RestAnnotation.Builder defaultResponseHeaders(String... value)

Sets the Rest.defaultResponseHeaders() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

disableContentParam

public RestAnnotation.Builder disableContentParam(String value)

Sets the Rest.disableContentParam() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

encoders

@SafeVarargs
public final RestAnnotation.Builder encoders(Class<? extends Encoder>... value)

Sets the Rest.encoders() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

guards

@SafeVarargs
public final RestAnnotation.Builder guards(Class<? extends RestGuard>... value)

Sets the Rest.guards() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

maxInput

public RestAnnotation.Builder maxInput(String value)

Sets the Rest.maxInput() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

messages

public RestAnnotation.Builder messages(String value)

Sets the Rest.messages() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

parsers

public RestAnnotation.Builder parsers(Class<?>... value)

Sets the Rest.parsers() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

partParser

public RestAnnotation.Builder partParser(Class<? extends HttpPartParser> value)

Sets the Rest.partParser() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

partSerializer

public RestAnnotation.Builder partSerializer(Class<? extends HttpPartSerializer> value)

Sets the Rest.partSerializer() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

path

public RestAnnotation.Builder path(String value)

Sets the Rest.path() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

paths

public RestAnnotation.Builder paths(String... value)

Sets the Rest.paths() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

produces

public RestAnnotation.Builder produces(String... value)

Sets the Rest.produces() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

problemDetails

public RestAnnotation.Builder problemDetails(String value)

Sets the Rest.problemDetails() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

debugMarshalling

public RestAnnotation.Builder debugMarshalling(String value)

Sets the Rest.debugMarshalling() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

observability

public RestAnnotation.Builder observability(String value)

Sets the Rest.observability() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

virtualThreads

public RestAnnotation.Builder virtualThreads(String value)

Sets the Rest.virtualThreads() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

asyncTimeoutMillis

public RestAnnotation.Builder asyncTimeoutMillis(String value)

Sets the Rest.asyncTimeoutMillis() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

asyncCompletionExecutor

public RestAnnotation.Builder asyncCompletionExecutor(String value)

Sets the Rest.asyncCompletionExecutor() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

renderResponseStackTraces

public RestAnnotation.Builder renderResponseStackTraces(String value)

Sets the Rest.renderResponseStackTraces() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

responseProcessors

@SafeVarargs
public final RestAnnotation.Builder responseProcessors(Class<? extends ResponseProcessor>... value)

Sets the Rest.responseProcessors() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

restOpArgs

@SafeVarargs
public final RestAnnotation.Builder restOpArgs(Class<? extends RestOpArg>... value)

Sets the Rest.restOpArgs() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

roleGuard

public RestAnnotation.Builder roleGuard(String value)

Sets the Rest.roleGuard() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

rolesDeclared

public RestAnnotation.Builder rolesDeclared(String value)

Sets the Rest.rolesDeclared() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

serializers

@SafeVarargs
public final RestAnnotation.Builder serializers(Class<? extends Serializer>... value)

Sets the Rest.serializers() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

siteName

public RestAnnotation.Builder siteName(String value)

Sets the Rest.siteName() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

staticFiles

public RestAnnotation.Builder staticFiles(Class<? extends StaticFiles> value)

Sets the Rest.staticFiles() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

swagger

public RestAnnotation.Builder swagger(Swagger value)

Sets the Rest.swagger() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

swaggerProvider

public RestAnnotation.Builder swaggerProvider(Class<? extends SwaggerProvider> value)

Sets the Rest.swaggerProvider() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

openApiProvider

public RestAnnotation.Builder openApiProvider(Class<? extends OpenApiProvider> value)

Sets the Rest.openApiProvider() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

title

public RestAnnotation.Builder title(String... value)

Sets the Rest.title() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

uriAuthority

public RestAnnotation.Builder uriAuthority(String value)

Sets the Rest.uriAuthority() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

uriContext

public RestAnnotation.Builder uriContext(String value)

Sets the Rest.uriContext() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

uriRelativity

public RestAnnotation.Builder uriRelativity(String value)

Sets the Rest.uriRelativity() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

uriResolution

public RestAnnotation.Builder uriResolution(String value)

Sets the Rest.uriResolution() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.