fish.payara.microprofile.openapi.impl.model.util

Class ModelUtils

java.lang.Object

fish.payara.microprofile.openapi.impl.model.util.ModelUtils

public final class ModelUtils
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static String	UNKNOWN_ELEMENT_NAME The name of a variable in the model tree that is unrecognised.

Method Summary

Modifier and Type	Method and Description
static void	applyReference(org.eclipse.microprofile.openapi.models.Reference<?> referee, String reference) Set the reference property of an object, and clear every other field.
static org.eclipse.microprofile.openapi.models.Operation	findOperation(org.eclipse.microprofile.openapi.models.OpenAPI api, Method method, String path)
static org.eclipse.microprofile.openapi.models.PathItem.HttpMethod	getHttpMethod(Method method)
static org.eclipse.microprofile.openapi.models.PathItem.HttpMethod	getHttpMethod(String method)
static org.eclipse.microprofile.openapi.models.Operation	getOperation(Method method, org.eclipse.microprofile.openapi.models.OpenAPI api, Map<String,Set<Class<?>>> resourceMapping)
static org.eclipse.microprofile.openapi.models.Operation	getOrCreateOperation(org.eclipse.microprofile.openapi.models.PathItem pathItem, org.eclipse.microprofile.openapi.models.PathItem.HttpMethod httpMethod) Creates a new Operation, and inserts it into the PathItem.
static String	getParameterName(Parameter parameter)
static org.eclipse.microprofile.openapi.models.parameters.Parameter.In	getParameterType(Parameter parameter)
static org.eclipse.microprofile.openapi.models.media.Schema.SchemaType	getParentSchemaType(org.eclipse.microprofile.openapi.models.media.Schema.SchemaType type1, org.eclipse.microprofile.openapi.models.media.Schema.SchemaType type2) Finds a Schema.SchemaType that can represent both of the given types.
static String	getResourcePath(GenericDeclaration declaration, Map<String,Set<Class<?>>> resourceMapping)
static org.eclipse.microprofile.openapi.models.media.Schema.SchemaType	getSchemaType(Class<?> type) Finds the Schema.SchemaType that corresponds to a given class.
static boolean	isAnnotationNull(Annotation annotation)
static boolean	isRequestBody(Parameter parameter)
static <T> void	merge(T from, T to, boolean override)
static <E> E	mergeProperty(E current, E offer, boolean override)
static String	normaliseUrl(String path) Normalises a path string.
static <T> void	overwrite(T from, T to)
static void	removeOperation(org.eclipse.microprofile.openapi.models.PathItem pathItem, org.eclipse.microprofile.openapi.models.Operation operation)

Methods inherited from class java.lang.Object

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

Field Detail

UNKNOWN_ELEMENT_NAME

public static final String UNKNOWN_ELEMENT_NAME

The name of a variable in the model tree that is unrecognised.

See Also:

Constant Field Values

Method Detail

normaliseUrl

public static String normaliseUrl(String path)

Normalises a path string. A normalised path has:

• no multiple slashes.
• no trailing slash.

Parameters:

path - the path to be normalised.

getHttpMethod

public static org.eclipse.microprofile.openapi.models.PathItem.HttpMethod getHttpMethod(Method method)

Parameters:

method - the method to analyse.

Returns:

the PathItem.HttpMethod applied to this method, or null if there is none.

getHttpMethod

public static org.eclipse.microprofile.openapi.models.PathItem.HttpMethod getHttpMethod(String method)

getOrCreateOperation

public static org.eclipse.microprofile.openapi.models.Operation getOrCreateOperation(org.eclipse.microprofile.openapi.models.PathItem pathItem,
                                                                                     org.eclipse.microprofile.openapi.models.PathItem.HttpMethod httpMethod)

Creates a new Operation, and inserts it into the PathItem.

Parameters:

pathItem - the PathItem to add the Operation to.

httpMethod - the HTTP method of the operation to add.

Returns:

the newly created Operation, or the existing operation if available.

findOperation

public static org.eclipse.microprofile.openapi.models.Operation findOperation(org.eclipse.microprofile.openapi.models.OpenAPI api,
                                                                              Method method,
                                                                              String path)

removeOperation

public static void removeOperation(org.eclipse.microprofile.openapi.models.PathItem pathItem,
                                   org.eclipse.microprofile.openapi.models.Operation operation)

getSchemaType

public static org.eclipse.microprofile.openapi.models.media.Schema.SchemaType getSchemaType(Class<?> type)

Finds the Schema.SchemaType that corresponds to a given class.

Parameters:

type - the class to map.

Returns:

the schema type the class corresponds to.

getParentSchemaType

public static org.eclipse.microprofile.openapi.models.media.Schema.SchemaType getParentSchemaType(org.eclipse.microprofile.openapi.models.media.Schema.SchemaType type1,
                                                                                                  org.eclipse.microprofile.openapi.models.media.Schema.SchemaType type2)

Finds a Schema.SchemaType that can represent both of the given types. If one of the input values are null, this function returns the other. If both are null, this function returns null.

Parameters:

type1 - the first schema type.

type2 - the second schema type.

Returns:

a Schema.SchemaType that can represent both.

isRequestBody

public static boolean isRequestBody(Parameter parameter)

getParameterType

public static org.eclipse.microprofile.openapi.models.parameters.Parameter.In getParameterType(Parameter parameter)

getParameterName

public static String getParameterName(Parameter parameter)

isAnnotationNull

public static boolean isAnnotationNull(Annotation annotation)

mergeProperty

public static <E> E mergeProperty(E current,
                                  E offer,
                                  boolean override)

applyReference

public static void applyReference(org.eclipse.microprofile.openapi.models.Reference<?> referee,
                                  String reference)

Set the reference property of an object, and clear every other field.

overwrite

public static <T> void overwrite(T from,
                                 T to)

merge

public static <T> void merge(T from,
                             T to,
                             boolean override)

getOperation

public static org.eclipse.microprofile.openapi.models.Operation getOperation(Method method,
                                                                             org.eclipse.microprofile.openapi.models.OpenAPI api,
                                                                             Map<String,Set<Class<?>>> resourceMapping)

getResourcePath

public static String getResourcePath(GenericDeclaration declaration,
                                     Map<String,Set<Class<?>>> resourceMapping)