Package org.apache.juneau.rest.annotation

Class RestOpAnnotation.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.RestOpAnnotation.Builder

Enclosing class:

RestOpAnnotation

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

Instantiates a new @RestOp object initialized with this builder.

Returns:

A new @RestOp object.

description

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

Sets the description property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

clientVersion

public RestOpAnnotation.Builder clientVersion(String value)

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

Parameters:

value - The new value for this property.

Returns:

This object.

consumes

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

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

Parameters:

value - The new value for this property.

Returns:

This object.

converters

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

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

Parameters:

value - The new value for this property.

Returns:

This object.

debug

public RestOpAnnotation.Builder debug(String value)

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

Parameters:

value - The new value for this property.

Returns:

This object.

defaultAccept

public RestOpAnnotation.Builder defaultAccept(String value)

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

Parameters:

value - The new value for this property.

Returns:

This object.

defaultCharset

public RestOpAnnotation.Builder defaultCharset(String value)

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

Parameters:

value - The new value for this property.

Returns:

This object.

defaultContentType

public RestOpAnnotation.Builder defaultContentType(String value)

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

Parameters:

value - The new value for this property.

Returns:

This object.

defaultRequestAttributes

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

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

Parameters:

value - The new value for this property.

Returns:

This object.

defaultRequestFormData

public RestOpAnnotation.Builder defaultRequestFormData(String... value)

Sets the RestOp.defaultRequestFormData() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

defaultRequestHeaders

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

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

Parameters:

value - The new value for this property.

Returns:

This object.

defaultRequestQueryData

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

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

Parameters:

value - The new value for this property.

Returns:

This object.

defaultResponseHeaders

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

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

Parameters:

value - The new value for this property.

Returns:

This object.

encoders

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

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

Parameters:

value - The new value for this property.

Returns:

This object.

guards

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

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

Parameters:

value - The new value for this property.

Returns:

This object.

matchers

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

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

Parameters:

value - The new value for this property.

Returns:

This object.

maxInput

public RestOpAnnotation.Builder maxInput(String value)

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

Parameters:

value - The new value for this property.

Returns:

This object.

method

public RestOpAnnotation.Builder method(String value)

Sets the RestOp.method() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

parsers

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

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

Parameters:

value - The new value for this property.

Returns:

This object.

path

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

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

Parameters:

value - The new value for this property.

Returns:

This object.

produces

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

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

Parameters:

value - The new value for this property.

Returns:

This object.

roleGuard

public RestOpAnnotation.Builder roleGuard(String value)

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

Parameters:

value - The new value for this property.

Returns:

This object.

rolesDeclared

public RestOpAnnotation.Builder rolesDeclared(String value)

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

Parameters:

value - The new value for this property.

Returns:

This object.

serializers

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

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

Parameters:

value - The new value for this property.

Returns:

This object.

summary

public RestOpAnnotation.Builder summary(String value)

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

Parameters:

value - The new value for this property.

Returns:

This object.

swagger

public RestOpAnnotation.Builder swagger(OpSwagger value)

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

Parameters:

value - The new value for this property.

Returns:

This object.

value

public RestOpAnnotation.Builder value(String value)

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

Parameters:

value - The new value for this property.

Returns:

This object.

on

public RestOpAnnotation.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 RestOpAnnotation.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 RestOpAnnotation.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.