Package io.swagger.v3.core.util

Class AnnotationsUtils

java.lang.Object

io.swagger.v3.core.util.AnnotationsUtils

public abstract class AnnotationsUtils
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static String	COMPONENTS_REF

Constructor Summary

Constructors

Constructor	Description
AnnotationsUtils()

Method Summary

Modifier and Type	Method	Description
static void	addEncodingToMediaType(MediaType mediaType, Encoding encoding, com.fasterxml.jackson.annotation.JsonView jsonViewAnnotation)
static void	addEncodingToMediaType(MediaType mediaType, Encoding encoding, com.fasterxml.jackson.annotation.JsonView jsonViewAnnotation, boolean openapi31)
static void	applyTypes(String[] classTypes, String[] methodTypes, Content content, MediaType mediaType)
static Schema	clone(Schema schema, boolean openapi31)
static boolean	equals(ArraySchema thisArraySchema, ArraySchema thatArraySchema)
static boolean	equals(Schema thisSchema, Schema thatSchema)
static boolean	equals(Annotation thisAnnotation, Annotation thatAnnotation)
static <T> T	getAnnotation(Class<T> cls, Annotation... annotations)
static Optional<ArraySchema>	getArraySchema(ArraySchema arraySchema, com.fasterxml.jackson.annotation.JsonView jsonViewAnnotation)
static Optional<ArraySchema>	getArraySchema(ArraySchema arraySchema, Components components, com.fasterxml.jackson.annotation.JsonView jsonViewAnnotation)
static Optional<ArraySchema>	getArraySchema(ArraySchema arraySchema, Components components, com.fasterxml.jackson.annotation.JsonView jsonViewAnnotation, boolean openapi31)
static Optional<Schema>	getArraySchema(ArraySchema arraySchema, Components components, com.fasterxml.jackson.annotation.JsonView jsonViewAnnotation, boolean openapi31, Schema existingSchema)
static Optional<Schema>	getArraySchema(ArraySchema arraySchema, Components components, com.fasterxml.jackson.annotation.JsonView jsonViewAnnotation, boolean openapi31, Schema existingSchema, boolean processSchemaImplementation)
static ArraySchema	getArraySchemaAnnotation(Annotation... annotations)
static Optional<Contact>	getContact(Contact contact)
static Optional<Contact>	getContact(Contact contact, boolean openapi31)
static Optional<Content>	getContent(Content[] annotationContents, String[] classTypes, String[] methodTypes, Schema schema, Components components, com.fasterxml.jackson.annotation.JsonView jsonViewAnnotation)
static Optional<Content>	getContent(Content[] annotationContents, String[] classTypes, String[] methodTypes, Schema schema, Components components, com.fasterxml.jackson.annotation.JsonView jsonViewAnnotation, boolean openapi31)
static Optional<Example>	getExample(ExampleObject example)
static Optional<Example>	getExample(ExampleObject example, boolean ignoreName)
static Map<String,Object>	getExtensions(boolean openapi31, Extension... extensions)
static Map<String,Object>	getExtensions(Extension... extensions)
static Optional<ExternalDocumentation>	getExternalDocumentation(ExternalDocumentation externalDocumentation)
static Optional<ExternalDocumentation>	getExternalDocumentation(ExternalDocumentation externalDocumentation, boolean openapi31)
static Optional<Header>	getHeader(Header header, com.fasterxml.jackson.annotation.JsonView jsonViewAnnotation)
static Optional<Header>	getHeader(Header header, com.fasterxml.jackson.annotation.JsonView jsonViewAnnotation, boolean openapi31)
static Optional<Header>	getHeader(Header header, Components components, com.fasterxml.jackson.annotation.JsonView jsonViewAnnotation)
static Optional<Header>	getHeader(Header header, Components components, com.fasterxml.jackson.annotation.JsonView jsonViewAnnotation, boolean openapi31)
static Optional<Map<String,Header>>	getHeaders(Header[] annotationHeaders, com.fasterxml.jackson.annotation.JsonView jsonViewAnnotation)
static Optional<Map<String,Header>>	getHeaders(Header[] annotationHeaders, com.fasterxml.jackson.annotation.JsonView jsonViewAnnotation, boolean openapi31)
static Optional<Map<String,Header>>	getHeaders(Header[] annotationHeaders, Components components, com.fasterxml.jackson.annotation.JsonView jsonViewAnnotation)
static Optional<Map<String,Header>>	getHeaders(Header[] annotationHeaders, Components components, com.fasterxml.jackson.annotation.JsonView jsonViewAnnotation, boolean openapi31)
static Optional<Info>	getInfo(Info info)
static Optional<Info>	getInfo(Info info, boolean openapi31)
static Optional<License>	getLicense(License license)
static Optional<License>	getLicense(License license, boolean openapi31)
static Optional<Link>	getLink(Link link)
static Optional<Link>	getLink(Link link, boolean openapi31)
static Map<String,String>	getLinkParameters(LinkParameter[] linkParameter)
static Map<String,Link>	getLinks(Link[] links)
static Map<String,Link>	getLinks(Link[] links, boolean openapi31)
static Optional<? extends Schema>	getSchema(Content annotationContent, Components components, com.fasterxml.jackson.annotation.JsonView jsonViewAnnotation)
static Optional<? extends Schema>	getSchema(Content annotationContent, Components components, com.fasterxml.jackson.annotation.JsonView jsonViewAnnotation, boolean openapi31)
static Optional<? extends Schema>	getSchema(Schema schemaAnnotation, ArraySchema arrayAnnotation, boolean isArray, Class<?> schemaImplementation, Components components, com.fasterxml.jackson.annotation.JsonView jsonViewAnnotation)
static Optional<? extends Schema>	getSchema(Schema schemaAnnotation, ArraySchema arrayAnnotation, boolean isArray, Class<?> schemaImplementation, Components components, com.fasterxml.jackson.annotation.JsonView jsonViewAnnotation, boolean openapi31)
static Schema	getSchemaAnnotation(com.fasterxml.jackson.databind.introspect.Annotated a)
static Schema	getSchemaAnnotation(Annotation... annotations)
static Schema	getSchemaAnnotation(Class<?> cls)
static Schema	getSchemaDeclaredAnnotation(com.fasterxml.jackson.databind.introspect.Annotated a)
static Schema	getSchemaDeclaredAnnotation(Class<?> cls)
static Optional<Schema>	getSchemaFromAnnotation(Schema schema, com.fasterxml.jackson.annotation.JsonView jsonViewAnnotation)
static Optional<Schema>	getSchemaFromAnnotation(Schema schema, com.fasterxml.jackson.annotation.JsonView jsonViewAnnotation, boolean openapi31)
static Optional<Schema>	getSchemaFromAnnotation(Schema schema, Components components, com.fasterxml.jackson.annotation.JsonView jsonViewAnnotation)
static Optional<Schema>	getSchemaFromAnnotation(Schema schema, Components components, com.fasterxml.jackson.annotation.JsonView jsonViewAnnotation, boolean openapi31)
static Optional<Schema>	getSchemaFromAnnotation(Schema schema, Components components, com.fasterxml.jackson.annotation.JsonView jsonViewAnnotation, boolean openapi31, Schema existingSchema)
static Optional<Schema>	getSchemaFromAnnotation(Schema schema, Components components, com.fasterxml.jackson.annotation.JsonView jsonViewAnnotation, boolean openapi31, Schema existingSchema, ModelConverterContext context)
static Optional<Schema>	getSchemaFromAnnotation(Schema schema, Components components, com.fasterxml.jackson.annotation.JsonView jsonViewAnnotation, boolean openapi31, Schema existingSchema, Schema.SchemaResolution schemaResolution, ModelConverterContext context)
static Type	getSchemaType(Schema schema)
static Type	getSchemaType(Schema schema, boolean nullIfNotFound)
static Optional<Server>	getServer(Server server)
static Optional<List<Server>>	getServers(Server[] servers)
static Optional<Set<Tag>>	getTags(Tag[] tags, boolean skipOnlyName)
static boolean	hasArrayAnnotation(ArraySchema array)
static boolean	hasSchemaAnnotation(Schema schema)
static ArraySchema	mergeArraySchemaAnnotations(ArraySchema master, ArraySchema patch)
static ArraySchema	mergeArrayWithSchemaAnnotation(ArraySchema arraySchema, Schema schema)
static Schema	mergeSchemaAnnotations(Schema master, Schema patch)
static Annotation	mergeSchemaAnnotations(Annotation[] ctxAnnotations, com.fasterxml.jackson.databind.JavaType type)
static Annotation	mergeSchemaAnnotations(Annotation[] ctxAnnotations, com.fasterxml.jackson.databind.JavaType type, boolean contextWins)
static Annotation[]	removeAnnotations(Annotation[] annotations, Class... classes)
static Schema	resolveSchemaFromType(Class<?> schemaImplementation, Components components, com.fasterxml.jackson.annotation.JsonView jsonViewAnnotation)
static Schema	resolveSchemaFromType(Class<?> schemaImplementation, Components components, com.fasterxml.jackson.annotation.JsonView jsonViewAnnotation, boolean openapi31)
static Schema	resolveSchemaFromType(Class<?> schemaImplementation, Components components, com.fasterxml.jackson.annotation.JsonView jsonViewAnnotation, boolean openapi31, Schema schemaAnnotation, ArraySchema arrayAnnotation, ModelConverterContext context)
static Schema.SchemaResolution	resolveSchemaResolution(Schema.SchemaResolution globalSchemaResolution, Schema schemaAnnotation)
static void	setHeaderExplode(Header header, Header h)
static void	updateAnnotation(Class<?> clazz, Schema newAnnotation)

Methods inherited from class java.lang.Object

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

Field Detail

COMPONENTS_REF

public static final String COMPONENTS_REF

See Also:

Constant Field Values

Constructor Detail

AnnotationsUtils

public AnnotationsUtils()

Method Detail

hasSchemaAnnotation

public static boolean hasSchemaAnnotation(Schema schema)

equals

public static boolean equals(Annotation thisAnnotation,
                             Annotation thatAnnotation)

equals

public static boolean equals(ArraySchema thisArraySchema,
                             ArraySchema thatArraySchema)

equals

public static boolean equals(Schema thisSchema,
                             Schema thatSchema)

hasArrayAnnotation

public static boolean hasArrayAnnotation(ArraySchema array)

getExample

public static Optional<Example> getExample(ExampleObject example)

getExample

public static Optional<Example> getExample(ExampleObject example,
                                           boolean ignoreName)

getArraySchema

public static Optional<ArraySchema> getArraySchema(ArraySchema arraySchema,
                                                   com.fasterxml.jackson.annotation.JsonView jsonViewAnnotation)

getArraySchema

public static Optional<ArraySchema> getArraySchema(ArraySchema arraySchema,
                                                   Components components,
                                                   com.fasterxml.jackson.annotation.JsonView jsonViewAnnotation)

getArraySchema

public static Optional<ArraySchema> getArraySchema(ArraySchema arraySchema,
                                                   Components components,
                                                   com.fasterxml.jackson.annotation.JsonView jsonViewAnnotation,
                                                   boolean openapi31)

getArraySchema

public static Optional<Schema> getArraySchema(ArraySchema arraySchema,
                                              Components components,
                                              com.fasterxml.jackson.annotation.JsonView jsonViewAnnotation,
                                              boolean openapi31,
                                              Schema existingSchema)

getArraySchema

public static Optional<Schema> getArraySchema(ArraySchema arraySchema,
                                              Components components,
                                              com.fasterxml.jackson.annotation.JsonView jsonViewAnnotation,
                                              boolean openapi31,
                                              Schema existingSchema,
                                              boolean processSchemaImplementation)

getSchemaFromAnnotation

public static Optional<Schema> getSchemaFromAnnotation(Schema schema,
                                                       com.fasterxml.jackson.annotation.JsonView jsonViewAnnotation)

getSchemaFromAnnotation

public static Optional<Schema> getSchemaFromAnnotation(Schema schema,
                                                       com.fasterxml.jackson.annotation.JsonView jsonViewAnnotation,
                                                       boolean openapi31)

getSchemaFromAnnotation

public static Optional<Schema> getSchemaFromAnnotation(Schema schema,
                                                       Components components,
                                                       com.fasterxml.jackson.annotation.JsonView jsonViewAnnotation)

getSchemaFromAnnotation

public static Optional<Schema> getSchemaFromAnnotation(Schema schema,
                                                       Components components,
                                                       com.fasterxml.jackson.annotation.JsonView jsonViewAnnotation,
                                                       boolean openapi31)

getSchemaFromAnnotation

public static Optional<Schema> getSchemaFromAnnotation(Schema schema,
                                                       Components components,
                                                       com.fasterxml.jackson.annotation.JsonView jsonViewAnnotation,
                                                       boolean openapi31,
                                                       Schema existingSchema)

getSchemaFromAnnotation

public static Optional<Schema> getSchemaFromAnnotation(Schema schema,
                                                       Components components,
                                                       com.fasterxml.jackson.annotation.JsonView jsonViewAnnotation,
                                                       boolean openapi31,
                                                       Schema existingSchema,
                                                       ModelConverterContext context)

getSchemaFromAnnotation

public static Optional<Schema> getSchemaFromAnnotation(Schema schema,
                                                       Components components,
                                                       com.fasterxml.jackson.annotation.JsonView jsonViewAnnotation,
                                                       boolean openapi31,
                                                       Schema existingSchema,
                                                       Schema.SchemaResolution schemaResolution,
                                                       ModelConverterContext context)

resolveSchemaFromType

public static Schema resolveSchemaFromType(Class<?> schemaImplementation,
                                           Components components,
                                           com.fasterxml.jackson.annotation.JsonView jsonViewAnnotation)

resolveSchemaFromType

public static Schema resolveSchemaFromType(Class<?> schemaImplementation,
                                           Components components,
                                           com.fasterxml.jackson.annotation.JsonView jsonViewAnnotation,
                                           boolean openapi31)

resolveSchemaFromType

public static Schema resolveSchemaFromType(Class<?> schemaImplementation,
                                           Components components,
                                           com.fasterxml.jackson.annotation.JsonView jsonViewAnnotation,
                                           boolean openapi31,
                                           Schema schemaAnnotation,
                                           ArraySchema arrayAnnotation,
                                           ModelConverterContext context)

getTags

public static Optional<Set<Tag>> getTags(Tag[] tags,
                                         boolean skipOnlyName)

getServers

public static Optional<List<Server>> getServers(Server[] servers)

getServer

public static Optional<Server> getServer(Server server)

getExternalDocumentation

public static Optional<ExternalDocumentation> getExternalDocumentation(ExternalDocumentation externalDocumentation)

getExternalDocumentation

public static Optional<ExternalDocumentation> getExternalDocumentation(ExternalDocumentation externalDocumentation,
                                                                       boolean openapi31)

getInfo

public static Optional<Info> getInfo(Info info)

getInfo

public static Optional<Info> getInfo(Info info,
                                     boolean openapi31)

getContact

public static Optional<Contact> getContact(Contact contact)

getContact

public static Optional<Contact> getContact(Contact contact,
                                           boolean openapi31)

getLicense

public static Optional<License> getLicense(License license)

getLicense

public static Optional<License> getLicense(License license,
                                           boolean openapi31)

getLinks

public static Map<String,Link> getLinks(Link[] links)

getLinks

public static Map<String,Link> getLinks(Link[] links,
                                              boolean openapi31)

getLink

public static Optional<Link> getLink(Link link)

getLink

public static Optional<Link> getLink(Link link,
                                     boolean openapi31)

getLinkParameters

public static Map<String,String> getLinkParameters(LinkParameter[] linkParameter)

getHeaders

public static Optional<Map<String,Header>> getHeaders(Header[] annotationHeaders,
                                                            com.fasterxml.jackson.annotation.JsonView jsonViewAnnotation)

getHeaders

public static Optional<Map<String,Header>> getHeaders(Header[] annotationHeaders,
                                                            Components components,
                                                            com.fasterxml.jackson.annotation.JsonView jsonViewAnnotation)

getHeaders

public static Optional<Map<String,Header>> getHeaders(Header[] annotationHeaders,
                                                            com.fasterxml.jackson.annotation.JsonView jsonViewAnnotation,
                                                            boolean openapi31)

getHeaders

public static Optional<Map<String,Header>> getHeaders(Header[] annotationHeaders,
                                                            Components components,
                                                            com.fasterxml.jackson.annotation.JsonView jsonViewAnnotation,
                                                            boolean openapi31)

getHeader

public static Optional<Header> getHeader(Header header,
                                         com.fasterxml.jackson.annotation.JsonView jsonViewAnnotation)

getHeader

public static Optional<Header> getHeader(Header header,
                                         Components components,
                                         com.fasterxml.jackson.annotation.JsonView jsonViewAnnotation)

getHeader

public static Optional<Header> getHeader(Header header,
                                         com.fasterxml.jackson.annotation.JsonView jsonViewAnnotation,
                                         boolean openapi31)

getHeader

public static Optional<Header> getHeader(Header header,
                                         Components components,
                                         com.fasterxml.jackson.annotation.JsonView jsonViewAnnotation,
                                         boolean openapi31)

setHeaderExplode

public static void setHeaderExplode(Header header,
                                    Header h)

addEncodingToMediaType

public static void addEncodingToMediaType(MediaType mediaType,
                                          Encoding encoding,
                                          com.fasterxml.jackson.annotation.JsonView jsonViewAnnotation)

addEncodingToMediaType

public static void addEncodingToMediaType(MediaType mediaType,
                                          Encoding encoding,
                                          com.fasterxml.jackson.annotation.JsonView jsonViewAnnotation,
                                          boolean openapi31)

getSchemaType

public static Type getSchemaType(Schema schema)

getSchemaType

public static Type getSchemaType(Schema schema,
                                 boolean nullIfNotFound)

getContent

public static Optional<Content> getContent(Content[] annotationContents,
                                           String[] classTypes,
                                           String[] methodTypes,
                                           Schema schema,
                                           Components components,
                                           com.fasterxml.jackson.annotation.JsonView jsonViewAnnotation)

clone

public static Schema clone(Schema schema,
                           boolean openapi31)

getContent

public static Optional<Content> getContent(Content[] annotationContents,
                                           String[] classTypes,
                                           String[] methodTypes,
                                           Schema schema,
                                           Components components,
                                           com.fasterxml.jackson.annotation.JsonView jsonViewAnnotation,
                                           boolean openapi31)

getSchema

public static Optional<? extends Schema> getSchema(Content annotationContent,
                                                   Components components,
                                                   com.fasterxml.jackson.annotation.JsonView jsonViewAnnotation)

getSchema

public static Optional<? extends Schema> getSchema(Content annotationContent,
                                                   Components components,
                                                   com.fasterxml.jackson.annotation.JsonView jsonViewAnnotation,
                                                   boolean openapi31)

getSchema

public static Optional<? extends Schema> getSchema(Schema schemaAnnotation,
                                                   ArraySchema arrayAnnotation,
                                                   boolean isArray,
                                                   Class<?> schemaImplementation,
                                                   Components components,
                                                   com.fasterxml.jackson.annotation.JsonView jsonViewAnnotation)

getSchema

public static Optional<? extends Schema> getSchema(Schema schemaAnnotation,
                                                   ArraySchema arrayAnnotation,
                                                   boolean isArray,
                                                   Class<?> schemaImplementation,
                                                   Components components,
                                                   com.fasterxml.jackson.annotation.JsonView jsonViewAnnotation,
                                                   boolean openapi31)

applyTypes

public static void applyTypes(String[] classTypes,
                              String[] methodTypes,
                              Content content,
                              MediaType mediaType)

getSchemaAnnotation

public static Schema getSchemaAnnotation(com.fasterxml.jackson.databind.introspect.Annotated a)

getSchemaDeclaredAnnotation

public static Schema getSchemaDeclaredAnnotation(com.fasterxml.jackson.databind.introspect.Annotated a)

getSchemaAnnotation

public static Schema getSchemaAnnotation(Class<?> cls)

getSchemaDeclaredAnnotation

public static Schema getSchemaDeclaredAnnotation(Class<?> cls)

getExtensions

public static Map<String,Object> getExtensions(Extension... extensions)

getExtensions

public static Map<String,Object> getExtensions(boolean openapi31,
                                                     Extension... extensions)

getSchemaAnnotation

public static Schema getSchemaAnnotation(Annotation... annotations)

getArraySchemaAnnotation

public static ArraySchema getArraySchemaAnnotation(Annotation... annotations)

getAnnotation

public static <T> T getAnnotation(Class<T> cls,
                                  Annotation... annotations)

removeAnnotations

public static Annotation[] removeAnnotations(Annotation[] annotations,
                                             Class... classes)

updateAnnotation

public static void updateAnnotation(Class<?> clazz,
                                    Schema newAnnotation)

mergeSchemaAnnotations

public static Annotation mergeSchemaAnnotations(Annotation[] ctxAnnotations,
                                                com.fasterxml.jackson.databind.JavaType type)

mergeSchemaAnnotations

public static Annotation mergeSchemaAnnotations(Annotation[] ctxAnnotations,
                                                com.fasterxml.jackson.databind.JavaType type,
                                                boolean contextWins)

mergeSchemaAnnotations

public static Schema mergeSchemaAnnotations(Schema master,
                                            Schema patch)

mergeArraySchemaAnnotations

public static ArraySchema mergeArraySchemaAnnotations(ArraySchema master,
                                                      ArraySchema patch)

mergeArrayWithSchemaAnnotation

public static ArraySchema mergeArrayWithSchemaAnnotation(ArraySchema arraySchema,
                                                         Schema schema)

resolveSchemaResolution

public static Schema.SchemaResolution resolveSchemaResolution(Schema.SchemaResolution globalSchemaResolution,
                                                              Schema schemaAnnotation)