org.springdoc.core

Class GenericParameterService

java.lang.Object

org.springdoc.core.GenericParameterService

public class GenericParameterService
extends Object

The type Generic parameter builder.

Author:

bnasslahsen

Constructor Summary

Constructors

Constructor and Description
GenericParameterService(PropertyResolverUtils propertyResolverUtils, Optional<DelegatingMethodParameterCustomizer> optionalDelegatingMethodParameterCustomizer) Instantiates a new Generic parameter builder.

Method Summary

Modifier and Type	Method and Description
static void	addFileType(Class<?>... classes) Add file type.
io.swagger.v3.oas.models.parameters.Parameter	buildParameterFromDoc(io.swagger.v3.oas.annotations.Parameter parameterDoc, io.swagger.v3.oas.models.Components components, com.fasterxml.jackson.annotation.JsonView jsonView) Build parameter from doc parameter.
Optional<DelegatingMethodParameterCustomizer>	getDelegatingMethodParameterCustomizer() Gets delegating method parameter customizer.
PropertyResolverUtils	getPropertyResolverUtils() Gets property resolver utils.
static boolean	isFile(Class type) Is file boolean.
boolean	isFile(org.springframework.core.MethodParameter methodParameter) Is file boolean.
static io.swagger.v3.oas.models.parameters.Parameter	mergeParameter(List<io.swagger.v3.oas.models.parameters.Parameter> existingParamDoc, io.swagger.v3.oas.models.parameters.Parameter paramCalcul) Merge parameter parameter.

Methods inherited from class java.lang.Object

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

Constructor Detail

GenericParameterService

public GenericParameterService(PropertyResolverUtils propertyResolverUtils,
                               Optional<DelegatingMethodParameterCustomizer> optionalDelegatingMethodParameterCustomizer)

Instantiates a new Generic parameter builder.

Parameters:

propertyResolverUtils - the property resolver utils

optionalDelegatingMethodParameterCustomizer - the optional delegating method parameter customizer

Method Detail

addFileType

public static void addFileType(Class<?>... classes)

Add file type.

Parameters:

classes - the classes

isFile

public static boolean isFile(Class type)

Is file boolean.

Parameters:

type - the type

Returns:

the boolean

mergeParameter

public static io.swagger.v3.oas.models.parameters.Parameter mergeParameter(List<io.swagger.v3.oas.models.parameters.Parameter> existingParamDoc,
                                                                           io.swagger.v3.oas.models.parameters.Parameter paramCalcul)

Merge parameter parameter.

Parameters:

existingParamDoc - the existing param doc

paramCalcul - the param calcul

Returns:

the parameter

buildParameterFromDoc

public io.swagger.v3.oas.models.parameters.Parameter buildParameterFromDoc(io.swagger.v3.oas.annotations.Parameter parameterDoc,
                                                                           io.swagger.v3.oas.models.Components components,
                                                                           com.fasterxml.jackson.annotation.JsonView jsonView)

Build parameter from doc parameter.

Parameters:

parameterDoc - the parameter doc

components - the components

jsonView - the json view

Returns:

the parameter

isFile

public boolean isFile(org.springframework.core.MethodParameter methodParameter)

Is file boolean.

Parameters:

methodParameter - the method parameter

Returns:

the boolean

getDelegatingMethodParameterCustomizer

public Optional<DelegatingMethodParameterCustomizer> getDelegatingMethodParameterCustomizer()

Gets delegating method parameter customizer.

Returns:

the delegating method parameter customizer

getPropertyResolverUtils

public PropertyResolverUtils getPropertyResolverUtils()

Gets property resolver utils.

Returns:

the property resolver utils