Package org.apache.juneau.http.annotation

Class ResponseAnnotation.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.commons.annotation.AppliedAnnotationObject.BuilderTM

org.apache.juneau.http.annotation.ResponseAnnotation.Builder

Enclosing class:

ResponseAnnotation

public static class ResponseAnnotation.Builder
extends AppliedAnnotationObject.BuilderTM

Builder class.

See Also:

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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Builder()	Constructor.

Method Summary

Modifier and Type	Method	Description
Response	build()	Instantiates a new @Response object initialized with this builder.
ResponseAnnotation.Builder	description(String... value)	Sets the description property on this annotation.
ResponseAnnotation.Builder	examples(String... value)	Sets the Response.examples() property on this annotation.
ResponseAnnotation.Builder	headers(Header... value)	Sets the Response.headers() property on this annotation.
ResponseAnnotation.Builder	on(Class<?>... value)	Appends the classes that this annotation applies to.
ResponseAnnotation.Builder	on(Method... value)	Appends the methods that this annotation applies to.
ResponseAnnotation.Builder	on(String... value)	The targets this annotation applies to.
ResponseAnnotation.Builder	on(ClassInfo... value)	Appends the classes that this annotation applies to.
ResponseAnnotation.Builder	on(MethodInfo... value)	Appends the methods that this annotation applies to.
ResponseAnnotation.Builder	onClass(Class<?>... value)	Appends the classes that this annotation applies to.
ResponseAnnotation.Builder	onClass(ClassInfo... value)	Appends the classes that this annotation applies to.
ResponseAnnotation.Builder	parser(Class<? extends HttpPartParser> value)	Sets the Response.parser() property on this annotation.
ResponseAnnotation.Builder	schema(Schema value)	Sets the Response.schema() property on this annotation.
ResponseAnnotation.Builder	serializer(Class<? extends HttpPartSerializer> value)	Sets the Response.serializer() 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 Response build()

Instantiates a new @Response object initialized with this builder.

Returns:

A new @Response object.

description

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

Sets the description property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

examples

public ResponseAnnotation.Builder examples(String... value)

Sets the Response.examples() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

headers

public ResponseAnnotation.Builder headers(Header... value)

Sets the Response.headers() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

parser

public ResponseAnnotation.Builder parser(Class<? extends HttpPartParser> value)

Sets the Response.parser() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

schema

public ResponseAnnotation.Builder schema(Schema value)

Sets the Response.schema() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

serializer

public ResponseAnnotation.Builder serializer(Class<? extends HttpPartSerializer> value)

Sets the Response.serializer() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

on

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

Description copied from class: AppliedAnnotationObject.Builder

The targets this annotation applies to.

Overrides:

on in class AppliedAnnotationObject.BuilderTM

Parameters:

value - The targets this annotation applies to.

Returns:

This object.

on

public ResponseAnnotation.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 ResponseAnnotation.Builder onClass(Class<?>... value)

Description copied from class: AppliedAnnotationObject.BuilderT

Appends the classes that this annotation applies to.

Overrides:

onClass in class AppliedAnnotationObject.BuilderTM

Parameters:

value - The values to append.

Returns:

This object.

on

public ResponseAnnotation.Builder on(Method... value)

Description copied from class: AppliedAnnotationObject.BuilderTM

Appends the methods that this annotation applies to.

Overrides:

on in class AppliedAnnotationObject.BuilderTM

Parameters:

value - The values to append.

Returns:

This object.

on

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

on

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

Description copied from class: AppliedAnnotationObject.BuilderTM

Appends the methods that this annotation applies to.

Overrides:

on in class AppliedAnnotationObject.BuilderTM

Parameters:

value - The values to append.

Returns:

This object.