Package org.apache.juneau.rest.annotation

Class OpSwaggerAnnotation.Builder

java.lang.Object

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

org.apache.juneau.rest.annotation.OpSwaggerAnnotation.Builder

Enclosing class:

OpSwaggerAnnotation

public static class OpSwaggerAnnotation.Builder
extends AnnotationObject.Builder

Builder class.

See Also:

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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Builder()	Constructor.

Method Summary

Modifier and Type	Method	Description
OpSwagger	build()	Instantiates a new @OpSwagger object initialized with this builder.
OpSwaggerAnnotation.Builder	consumes(String... value)	Sets the OpSwagger.consumes() property on this annotation.
OpSwaggerAnnotation.Builder	deprecated(String value)	Sets the OpSwagger.deprecated() property on this annotation.
OpSwaggerAnnotation.Builder	description(String... value)	Sets the description property on this annotation.
OpSwaggerAnnotation.Builder	externalDocs(ExternalDocs value)	Sets the OpSwagger.externalDocs() property on this annotation.
OpSwaggerAnnotation.Builder	operationId(String value)	Sets the OpSwagger.operationId() property on this annotation.
OpSwaggerAnnotation.Builder	parameters(String... value)	Sets the OpSwagger.parameters() property on this annotation.
OpSwaggerAnnotation.Builder	produces(String... value)	Sets the OpSwagger.produces() property on this annotation.
OpSwaggerAnnotation.Builder	responses(String... value)	Sets the OpSwagger.responses() property on this annotation.
OpSwaggerAnnotation.Builder	schemes(String... value)	Sets the OpSwagger.schemes() property on this annotation.
OpSwaggerAnnotation.Builder	summary(String... value)	Sets the OpSwagger.summary() property on this annotation.
OpSwaggerAnnotation.Builder	tags(String... value)	Sets the OpSwagger.tags() property on this annotation.
OpSwaggerAnnotation.Builder	value(String... value)	Sets the OpSwagger.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 OpSwagger build()

Instantiates a new @OpSwagger object initialized with this builder.

Returns:

A new @OpSwagger object.

description

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

Sets the description property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

consumes

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

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

Parameters:

value - The new value for this property.

Returns:

This object.

deprecated

public OpSwaggerAnnotation.Builder deprecated(String value)

Sets the OpSwagger.deprecated() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

externalDocs

public OpSwaggerAnnotation.Builder externalDocs(ExternalDocs value)

Sets the OpSwagger.externalDocs() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

operationId

public OpSwaggerAnnotation.Builder operationId(String value)

Sets the OpSwagger.operationId() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

parameters

public OpSwaggerAnnotation.Builder parameters(String... value)

Sets the OpSwagger.parameters() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

produces

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

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

Parameters:

value - The new value for this property.

Returns:

This object.

responses

public OpSwaggerAnnotation.Builder responses(String... value)

Sets the OpSwagger.responses() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

schemes

public OpSwaggerAnnotation.Builder schemes(String... value)

Sets the OpSwagger.schemes() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

summary

public OpSwaggerAnnotation.Builder summary(String... value)

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

Parameters:

value - The new value for this property.

Returns:

This object.

tags

public OpSwaggerAnnotation.Builder tags(String... value)

Sets the OpSwagger.tags() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

value

public OpSwaggerAnnotation.Builder value(String... value)

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

Parameters:

value - The new value for this property.

Returns:

This object.