Package org.apache.juneau.rest.annotation

Class RestAnnotation.Builder

java.lang.Object

org.apache.juneau.commons.annotation.AnnotationObject.Builder

org.apache.juneau.commons.annotation.AppliedAnnotationObject.Builder

org.apache.juneau.commons.annotation.AppliedAnnotationObject.BuilderT

org.apache.juneau.rest.annotation.RestAnnotation.Builder

Enclosing class:

RestAnnotation

public static class RestAnnotation.Builder
extends AppliedAnnotationObject.BuilderT

Builder class.

See Also:

• BeanContext.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	beanStore(Class<? extends BeanStore> value)	Sets the Rest.beanStore() property on this annotation.
Rest	build()	Instantiates a new @Rest object initialized with this builder.
RestAnnotation.Builder	callLogger(Class<? extends CallLogger> value)	Sets the Rest.callLogger() property on this annotation.
RestAnnotation.Builder	children(Class<?>... value)	Sets the Rest.children() 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	debug(String value)	Sets the Rest.debug() property on this annotation.
RestAnnotation.Builder	debugEnablement(Class<? extends DebugEnablement> value)	Sets the Rest.debugEnablement() property on this annotation.
RestAnnotation.Builder	debugOn(String value)	Sets the Rest.debugOn() 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.
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	maxInput(String value)	Sets the Rest.maxInput() property on this annotation.
RestAnnotation.Builder	messages(String value)	Sets the Rest.messages() property on this annotation.
RestAnnotation.Builder	on(Class<?>... value)	Appends the classes that this annotation applies to.
RestAnnotation.Builder	on(String... value)	The targets this annotation applies to.
RestAnnotation.Builder	on(ClassInfo... value)	Appends the classes that this annotation applies to.
RestAnnotation.Builder	onClass(Class<?>... value)	Appends the classes that this annotation applies to.
RestAnnotation.Builder	onClass(ClassInfo... value)	Appends the classes that this annotation applies to.
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	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.
RestAnnotation.Builder	restChildrenClass(Class<? extends RestChildren> value)	Sets the Rest.restChildrenClass() 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.

Methods inherited from class org.apache.juneau.commons.annotation.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.

beanStore

public RestAnnotation.Builder beanStore(Class<? extends BeanStore> value)

Sets the Rest.beanStore() 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.

callLogger

public RestAnnotation.Builder callLogger(Class<? extends CallLogger> value)

Sets the Rest.callLogger() 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.

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.

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.

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.

debug

public RestAnnotation.Builder debug(String value)

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

Parameters:

value - The new value for this property.

Returns:

This object.

debugEnablement

public RestAnnotation.Builder debugEnablement(Class<? extends DebugEnablement> value)

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

Parameters:

value - The new value for this property.

Returns:

This object.

debugOn

public RestAnnotation.Builder debugOn(String value)

Sets the Rest.debugOn() 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.

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.

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.

restChildrenClass

public RestAnnotation.Builder restChildrenClass(Class<? extends RestChildren> value)

Sets the Rest.restChildrenClass() 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.

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.

on

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

Description copied from class: AppliedAnnotationObject.Builder

The targets this annotation applies to.

Overrides:

on in class AppliedAnnotationObject.Builder

Parameters:

value - The targets this annotation applies to.

Returns:

This object.

on

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

Description copied from class: AppliedAnnotationObject.BuilderT

Appends the classes that this annotation applies to.

Overrides:

on in class AppliedAnnotationObject.BuilderT

Parameters:

value - The values to append.

Returns:

This object.

onClass

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

Description copied from class: AppliedAnnotationObject.BuilderT

Appends the classes that this annotation applies to.

Overrides:

onClass in class AppliedAnnotationObject.BuilderT

Parameters:

value - The values to append.

Returns:

This object.

on

public RestAnnotation.Builder on(ClassInfo... value)

Description copied from class: AppliedAnnotationObject.BuilderT

Appends the classes that this annotation applies to.

Overrides:

on in class AppliedAnnotationObject.BuilderT

Parameters:

value - The values to append.

Returns:

This object.

onClass

public RestAnnotation.Builder onClass(ClassInfo... value)

Description copied from class: AppliedAnnotationObject.BuilderT

Appends the classes that this annotation applies to.

Overrides:

onClass in class AppliedAnnotationObject.BuilderT

Parameters:

value - The values to append.

Returns:

This object.