Package org.apache.juneau.rest.annotation

Class SwaggerAnnotation.Builder

java.lang.Object

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

org.apache.juneau.rest.annotation.SwaggerAnnotation.Builder

Enclosing class:

SwaggerAnnotation

public static class SwaggerAnnotation.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
Swagger	build()	Instantiates a new @Swagger object initialized with this builder.
SwaggerAnnotation.Builder	contact(Contact value)	Sets the Swagger.contact() property on this annotation.
SwaggerAnnotation.Builder	description(String... value)	Sets the description property on this annotation.
SwaggerAnnotation.Builder	externalDocs(ExternalDocs value)	Sets the Swagger.externalDocs() property on this annotation.
SwaggerAnnotation.Builder	license(License value)	Sets the Swagger.license() property on this annotation.
SwaggerAnnotation.Builder	tags(Tag... value)	Sets the Swagger.tags() property on this annotation.
SwaggerAnnotation.Builder	termsOfService(String... value)	Sets the Swagger.termsOfService() property on this annotation.
SwaggerAnnotation.Builder	title(String... value)	Sets the Swagger.title() property on this annotation.
SwaggerAnnotation.Builder	value(String... value)	Sets the Swagger.value() property on this annotation.
SwaggerAnnotation.Builder	version(String value)	Sets the Swagger.version() 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 Swagger build()

Instantiates a new @Swagger object initialized with this builder.

Returns:

A new @Swagger object.

description

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

Sets the description property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

contact

public SwaggerAnnotation.Builder contact(Contact value)

Sets the Swagger.contact() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

externalDocs

public SwaggerAnnotation.Builder externalDocs(ExternalDocs value)

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

Parameters:

value - The new value for this property.

Returns:

This object.

license

public SwaggerAnnotation.Builder license(License value)

Sets the Swagger.license() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

tags

public SwaggerAnnotation.Builder tags(Tag... value)

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

Parameters:

value - The new value for this property.

Returns:

This object.

termsOfService

public SwaggerAnnotation.Builder termsOfService(String... value)

Sets the Swagger.termsOfService() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

title

public SwaggerAnnotation.Builder title(String... value)

Sets the Swagger.title() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

value

public SwaggerAnnotation.Builder value(String... value)

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

Parameters:

value - The new value for this property.

Returns:

This object.

version

public SwaggerAnnotation.Builder version(String value)

Sets the Swagger.version() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.