Package org.apache.juneau.rest.annotation

Class RestOptionsAnnotation.Builder

java.lang.Object

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

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

org.apache.juneau.commons.annotation.AppliedAnnotationObject.BuilderM

org.apache.juneau.rest.annotation.RestOptionsAnnotation.Builder

Enclosing class:

RestOptionsAnnotation

public static class RestOptionsAnnotation.Builder
extends AppliedAnnotationObject.BuilderM

Builder class.

See Also:

• BeanContext.Builder.annotations(Annotation...)

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Builder()	Constructor.

Method Summary

Modifier and Type	Method	Description
RestOptions	build()	Instantiates a new @RestOptions object initialized with this builder.
RestOptionsAnnotation.Builder	clientVersion(String value)	Sets the RestOptions.clientVersion() property on this annotation.
final RestOptionsAnnotation.Builder	converters(Class<? extends RestConverter>... value)	Sets the RestOptions.converters() property on this annotation.
RestOptionsAnnotation.Builder	debug(String value)	Sets the RestOptions.debug() property on this annotation.
RestOptionsAnnotation.Builder	defaultAccept(String value)	Sets the RestOptions.defaultAccept() property on this annotation.
RestOptionsAnnotation.Builder	defaultCharset(String value)	Sets the RestOptions.defaultCharset() property on this annotation.
RestOptionsAnnotation.Builder	defaultRequestAttributes(String... value)	Sets the RestOptions.defaultRequestAttributes() property on this annotation.
RestOptionsAnnotation.Builder	defaultRequestHeaders(String... value)	Sets the RestOptions.defaultRequestHeaders() property on this annotation.
RestOptionsAnnotation.Builder	defaultRequestQueryData(String... value)	Sets the RestOptions.defaultRequestQueryData() property on this annotation.
RestOptionsAnnotation.Builder	defaultResponseHeaders(String... value)	Sets the RestOptions.defaultResponseHeaders() property on this annotation.
RestOptionsAnnotation.Builder	description(String... value)	Sets the description property on this annotation.
final RestOptionsAnnotation.Builder	encoders(Class<? extends Encoder>... value)	Sets the RestOptions.encoders() property on this annotation.
final RestOptionsAnnotation.Builder	guards(Class<? extends RestGuard>... value)	Sets the RestOptions.guards() property on this annotation.
final RestOptionsAnnotation.Builder	matchers(Class<? extends RestMatcher>... value)	Sets the RestOptions.matchers() property on this annotation.
RestOptionsAnnotation.Builder	on(Method... value)	Appends the methods that this annotation applies to.
RestOptionsAnnotation.Builder	on(String... value)	The targets this annotation applies to.
RestOptionsAnnotation.Builder	on(MethodInfo... value)	Appends the methods that this annotation applies to.
RestOptionsAnnotation.Builder	path(String... value)	Sets the RestOptions.path() property on this annotation.
RestOptionsAnnotation.Builder	produces(String... value)	Sets the RestOptions.produces() property on this annotation.
RestOptionsAnnotation.Builder	roleGuard(String value)	Sets the RestOptions.roleGuard() property on this annotation.
RestOptionsAnnotation.Builder	rolesDeclared(String value)	Sets the RestOptions.rolesDeclared() property on this annotation.
final RestOptionsAnnotation.Builder	serializers(Class<? extends Serializer>... value)	Sets the RestOptions.serializers() property on this annotation.
RestOptionsAnnotation.Builder	summary(String value)	Sets the RestOptions.summary() property on this annotation.
RestOptionsAnnotation.Builder	swagger(OpSwagger value)	Sets the RestOptions.swagger() property on this annotation.
RestOptionsAnnotation.Builder	value(String value)	Sets the RestOptions.value() 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

build

public RestOptions build()

Instantiates a new @RestOptions object initialized with this builder.

Returns:

A new @RestOptions object.

description

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

Sets the description property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

clientVersion

public RestOptionsAnnotation.Builder clientVersion(String value)

Sets the RestOptions.clientVersion() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

converters

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

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

Parameters:

value - The new value for this property.

Returns:

This object.

debug

public RestOptionsAnnotation.Builder debug(String value)

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

Parameters:

value - The new value for this property.

Returns:

This object.

defaultAccept

public RestOptionsAnnotation.Builder defaultAccept(String value)

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

Parameters:

value - The new value for this property.

Returns:

This object.

defaultCharset

public RestOptionsAnnotation.Builder defaultCharset(String value)

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

Parameters:

value - The new value for this property.

Returns:

This object.

defaultRequestAttributes

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

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

Parameters:

value - The new value for this property.

Returns:

This object.

defaultRequestHeaders

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

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

Parameters:

value - The new value for this property.

Returns:

This object.

defaultRequestQueryData

public RestOptionsAnnotation.Builder defaultRequestQueryData(String... value)

Sets the RestOptions.defaultRequestQueryData() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

defaultResponseHeaders

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

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

Parameters:

value - The new value for this property.

Returns:

This object.

encoders

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

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

Parameters:

value - The new value for this property.

Returns:

This object.

guards

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

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

Parameters:

value - The new value for this property.

Returns:

This object.

matchers

@SafeVarargs
public final RestOptionsAnnotation.Builder matchers(Class<? extends RestMatcher>... value)

Sets the RestOptions.matchers() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

path

public RestOptionsAnnotation.Builder path(String... value)

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

Parameters:

value - The new value for this property.

Returns:

This object.

produces

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

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

Parameters:

value - The new value for this property.

Returns:

This object.

roleGuard

public RestOptionsAnnotation.Builder roleGuard(String value)

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

Parameters:

value - The new value for this property.

Returns:

This object.

rolesDeclared

public RestOptionsAnnotation.Builder rolesDeclared(String value)

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

Parameters:

value - The new value for this property.

Returns:

This object.

serializers

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

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

Parameters:

value - The new value for this property.

Returns:

This object.

summary

public RestOptionsAnnotation.Builder summary(String value)

Sets the RestOptions.summary() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

swagger

public RestOptionsAnnotation.Builder swagger(OpSwagger value)

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

Parameters:

value - The new value for this property.

Returns:

This object.

value

public RestOptionsAnnotation.Builder value(String value)

Sets the RestOptions.value() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

on

public RestOptionsAnnotation.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 RestOptionsAnnotation.Builder on(Method... value)

Description copied from class: AppliedAnnotationObject.BuilderM

Appends the methods that this annotation applies to.

Overrides:

on in class AppliedAnnotationObject.BuilderM

Parameters:

value - The values to append.

Returns:

This object.

on

public RestOptionsAnnotation.Builder on(MethodInfo... value)

Description copied from class: AppliedAnnotationObject.BuilderM

Appends the methods that this annotation applies to.

Overrides:

on in class AppliedAnnotationObject.BuilderM

Parameters:

value - The values to append.

Returns:

This object.