Package org.apache.juneau.rest.annotation

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

Enclosing class:

RestGetAnnotation

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

Instantiates a new @RestGet object initialized with this builder.

Returns:

A new @RestGet object.

description

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

Sets the description property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

clientVersion

public RestGetAnnotation.Builder clientVersion(String value)

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

Parameters:

value - The new value for this property.

Returns:

This object.

converters

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

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

Parameters:

value - The new value for this property.

Returns:

This object.

debug

public RestGetAnnotation.Builder debug(String value)

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

Parameters:

value - The new value for this property.

Returns:

This object.

defaultAccept

public RestGetAnnotation.Builder defaultAccept(String value)

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

Parameters:

value - The new value for this property.

Returns:

This object.

defaultCharset

public RestGetAnnotation.Builder defaultCharset(String value)

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

Parameters:

value - The new value for this property.

Returns:

This object.

defaultRequestAttributes

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

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

Parameters:

value - The new value for this property.

Returns:

This object.

defaultRequestHeaders

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

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

Parameters:

value - The new value for this property.

Returns:

This object.

defaultRequestQueryData

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

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

Parameters:

value - The new value for this property.

Returns:

This object.

defaultResponseHeaders

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

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

Parameters:

value - The new value for this property.

Returns:

This object.

encoders

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

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

Parameters:

value - The new value for this property.

Returns:

This object.

guards

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

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

Parameters:

value - The new value for this property.

Returns:

This object.

matchers

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

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

Parameters:

value - The new value for this property.

Returns:

This object.

path

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

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

Parameters:

value - The new value for this property.

Returns:

This object.

produces

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

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

Parameters:

value - The new value for this property.

Returns:

This object.

roleGuard

public RestGetAnnotation.Builder roleGuard(String value)

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

Parameters:

value - The new value for this property.

Returns:

This object.

rolesDeclared

public RestGetAnnotation.Builder rolesDeclared(String value)

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

Parameters:

value - The new value for this property.

Returns:

This object.

serializers

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

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

Parameters:

value - The new value for this property.

Returns:

This object.

summary

public RestGetAnnotation.Builder summary(String value)

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

Parameters:

value - The new value for this property.

Returns:

This object.

swagger

public RestGetAnnotation.Builder swagger(OpSwagger value)

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

Parameters:

value - The new value for this property.

Returns:

This object.

value

public RestGetAnnotation.Builder value(String value)

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

Parameters:

value - The new value for this property.

Returns:

This object.

on

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