Package org.apache.juneau.oapi.annotation

Class OpenApiAnnotation.Builder

java.lang.Object

org.apache.juneau.annotation.AnnotationBuilder

org.apache.juneau.annotation.TargetedAnnotationBuilder

org.apache.juneau.annotation.TargetedAnnotationTBuilder

org.apache.juneau.annotation.TargetedAnnotationTMFBuilder

org.apache.juneau.oapi.annotation.OpenApiAnnotation.Builder

Enclosing class:

OpenApiAnnotation

public static class OpenApiAnnotation.Builder
extends TargetedAnnotationTMFBuilder

Builder class.

See Also:

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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Builder()	Constructor.

Method Summary

Modifier and Type	Method	Description
OpenApi	build()	Instantiates a new @OpenApi object initialized with this builder.
OpenApiAnnotation.Builder	on(Class<?>... value)	Appends the classes that this annotation applies to.
OpenApiAnnotation.Builder	on(Field... value)	Appends the fields that this annotation applies to.
OpenApiAnnotation.Builder	on(Method... value)	Appends the methods that this annotation applies to.
OpenApiAnnotation.Builder	on(String... values)	The targets this annotation applies to.
OpenApiAnnotation.Builder	onClass(Class<?>... value)	Appends the classes that this annotation applies to.

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 OpenApi build()

Instantiates a new @OpenApi object initialized with this builder.

Returns:

A new @OpenApi object.

on

public OpenApiAnnotation.Builder on(String... values)

Description copied from class: TargetedAnnotationBuilder

The targets this annotation applies to.

Overrides:

on in class TargetedAnnotationTMFBuilder

Parameters:

values - The targets this annotation applies to.

Returns:

This object.

on

public OpenApiAnnotation.Builder on(Class<?>... value)

Description copied from class: TargetedAnnotationTBuilder

Appends the classes that this annotation applies to.

Overrides:

on in class TargetedAnnotationTMFBuilder

Parameters:

value - The values to append.

Returns:

This object.

onClass

public OpenApiAnnotation.Builder onClass(Class<?>... value)

Description copied from class: TargetedAnnotationTBuilder

Appends the classes that this annotation applies to.

Overrides:

onClass in class TargetedAnnotationTMFBuilder

Parameters:

value - The values to append.

Returns:

This object.

on

public OpenApiAnnotation.Builder on(Field... value)

Description copied from class: TargetedAnnotationTMFBuilder

Appends the fields that this annotation applies to.

Overrides:

on in class TargetedAnnotationTMFBuilder

Parameters:

value - The values to append.

Returns:

This object.

on

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

Description copied from class: TargetedAnnotationTMFBuilder

Appends the methods that this annotation applies to.

Overrides:

on in class TargetedAnnotationTMFBuilder

Parameters:

value - The values to append.

Returns:

This object.