Package org.apache.juneau.http

Class ResponseAnnotation.Builder

java.lang.Object

org.apache.juneau.commons.AnnotationObject.Builder

org.apache.juneau.http.ResponseAnnotation.Builder

Enclosing class:

ResponseAnnotation

public static class ResponseAnnotation.Builder
extends AnnotationObject.Builder

Builder class.

See Also:

• MarshallingContext.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	schema(Schema value)	Sets the Response.schema() property on this annotation.
ResponseAnnotation.Builder	summary(String value)	Sets the Response.summary() property on this annotation.

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

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.

summary

public ResponseAnnotation.Builder summary(String value)

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

Parameters:

value - The new value for this property.

Returns:

This object.

Since:

10.0.0