Package org.apache.juneau.oapi.annotation

Class OpenApiAnnotation

java.lang.Object

org.apache.juneau.oapi.annotation.OpenApiAnnotation

public class OpenApiAnnotation
extends Object

Utility classes and methods for the @OpenApi annotation.

See Also:

• OpenApi Basics

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	OpenApiAnnotation.Apply	Applies targeted OpenApi annotations to a Context.Builder.
static @interface	OpenApiAnnotation.Array	A collection of @OpenApi annotations.
static class	OpenApiAnnotation.Builder	Builder class.

Field Summary

Fields

Modifier and Type	Field	Description
static final OpenApi	DEFAULT	Default value

Constructor Summary

Constructors

Constructor	Description
OpenApiAnnotation()

Method Summary

Modifier and Type	Method	Description
static OpenApi	copy(OpenApi a, VarResolverSession r)	Creates a copy of the specified annotation.
static OpenApiAnnotation.Builder	create()	Instantiates a new builder for this class.
static OpenApiAnnotation.Builder	create(Class<?>... on)	Instantiates a new builder for this class.
static OpenApiAnnotation.Builder	create(String... on)	Instantiates a new builder for this class.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

DEFAULT

public static final OpenApi DEFAULT

Default value

Constructor Details

OpenApiAnnotation

public OpenApiAnnotation()

Method Details

copy

public static OpenApi copy(OpenApi a,
 VarResolverSession r)

Creates a copy of the specified annotation.

Parameters:

a - The annotation to copy.s

r - The var resolver for resolving any variables.

Returns:

A copy of the specified annotation.

create

public static OpenApiAnnotation.Builder create()

Instantiates a new builder for this class.

Returns:

A new builder object.

create

public static OpenApiAnnotation.Builder create(Class<?>... on)

Instantiates a new builder for this class.

Parameters:

on - The targets this annotation applies to.

Returns:

A new builder object.

create

public static OpenApiAnnotation.Builder create(String... on)

Instantiates a new builder for this class.

Parameters:

on - The targets this annotation applies to.

Returns:

A new builder object.