Package org.apache.juneau.marshall.oapi

Class OpenApiApplyAnnotation.Builder

java.lang.Object

org.apache.juneau.commons.AnnotationObject.Builder

org.apache.juneau.commons.AppliedAnnotationObject.Builder

org.apache.juneau.commons.AppliedAnnotationObject.BuilderT

org.apache.juneau.commons.AppliedAnnotationObject.BuilderTMF

org.apache.juneau.marshall.oapi.OpenApiApplyAnnotation.Builder

Enclosing class:

OpenApiApplyAnnotation

public static class OpenApiApplyAnnotation.Builder
extends AppliedAnnotationObject.BuilderTMF

Builder class.

See Also:

• MarshallingContext.Builder#annotations(Annotation...)

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Builder()	Constructor.

Method Summary

Modifier and Type	Method	Description
OpenApiApply	build()	Instantiates a new @OpenApiApply object initialized with this builder.
OpenApiApplyAnnotation.Builder	on(Class<?>... value)	Appends the classes that this annotation applies to.
OpenApiApplyAnnotation.Builder	on(Field... value)	Appends the fields that this annotation applies to.
OpenApiApplyAnnotation.Builder	on(Method... value)	Appends the methods that this annotation applies to.
OpenApiApplyAnnotation.Builder	on(String... value)	The targets this annotation applies to.
OpenApiApplyAnnotation.Builder	on(ClassInfo... value)	Appends the classes that this annotation applies to.
OpenApiApplyAnnotation.Builder	on(FieldInfo... value)	Appends the fields that this annotation applies to.
OpenApiApplyAnnotation.Builder	on(MethodInfo... value)	Appends the methods that this annotation applies to.
OpenApiApplyAnnotation.Builder	onClass(Class<?>... value)	Appends the classes that this annotation applies to.
OpenApiApplyAnnotation.Builder	onClass(ClassInfo... value)	Appends the classes that this annotation applies to.
OpenApiApplyAnnotation.Builder	value(OpenApi value)	Sets the OpenApiApply.value() 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

value

public OpenApiApplyAnnotation.Builder value(OpenApi value)

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

Parameters:

value - The new value for this property.

Returns:

This object.

on

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

Description copied from class: AppliedAnnotationObject.Builder

The targets this annotation applies to.

Overrides:

on in class AppliedAnnotationObject.Builder

Parameters:

value - The targets this annotation applies to. Cannot be null or contain null elements.

Returns:

This object.

on

public OpenApiApplyAnnotation.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. Cannot be null or contain null elements.

Returns:

This object.

onClass

public OpenApiApplyAnnotation.Builder onClass(Class<?>... 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. Cannot be null or contain null elements.

Returns:

This object.

on

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

Description copied from class: AppliedAnnotationObject.BuilderTMF

Appends the methods that this annotation applies to.

Overrides:

on in class AppliedAnnotationObject.BuilderTMF

Parameters:

value - The values to append. Cannot be null or contain null elements.

Returns:

This object.

on

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

Description copied from class: AppliedAnnotationObject.BuilderTMF

Appends the fields that this annotation applies to.

Overrides:

on in class AppliedAnnotationObject.BuilderTMF

Parameters:

value - The values to append. Cannot be null or contain null elements.

Returns:

This object.

on

public OpenApiApplyAnnotation.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. Cannot be null or contain null elements.

Returns:

This object.

onClass

public OpenApiApplyAnnotation.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. Cannot be null or contain null elements.

Returns:

This object.

on

public OpenApiApplyAnnotation.Builder on(FieldInfo... value)

Description copied from class: AppliedAnnotationObject.BuilderTMF

Appends the fields that this annotation applies to.

Overrides:

on in class AppliedAnnotationObject.BuilderTMF

Parameters:

value - The values to append. Cannot be null or contain null elements.

Returns:

This object.

on

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

Description copied from class: AppliedAnnotationObject.BuilderTMF

Appends the methods that this annotation applies to.

Overrides:

on in class AppliedAnnotationObject.BuilderTMF

Parameters:

value - The values to append. Cannot be null or contain null elements.

Returns:

This object.

build

public OpenApiApply build()

Instantiates a new @OpenApiApply object initialized with this builder.

Returns:

A new OpenApiApply object.