Package org.springdoc.core.customizers

Class SpringDocCustomizers

java.lang.Object

org.springdoc.core.customizers.SpringDocCustomizers

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.beans.factory.InitializingBean, org.springframework.context.ApplicationContextAware

public class SpringDocCustomizers
extends Object
implements org.springframework.context.ApplicationContextAware, org.springframework.beans.factory.InitializingBean

The type Spring doc customizers.

Author:

bnasslahsen

Constructor Summary

Constructors

Constructor	Description
SpringDocCustomizers(Optional<Set<OpenApiCustomizer>> openApiCustomizers, Optional<Set<OperationCustomizer>> operationCustomizers, Optional<Set<RouterOperationCustomizer>> routerOperationCustomizers, Optional<Set<DataRestRouterOperationCustomizer>> dataRestRouterOperationCustomizers, Optional<Set<OpenApiMethodFilter>> methodFilters, Optional<Set<GlobalOpenApiCustomizer>> globalOpenApiCustomizers, Optional<Set<GlobalOperationCustomizer>> globalOperationCustomizers, Optional<Set<GlobalOpenApiMethodFilter>> globalOpenApiMethodFilters, Optional<List<DelegatingMethodParameterCustomizer>> optionalDelegatingMethodParameterCustomizers, Optional<List<ParameterCustomizer>> parameterCustomizers)	Instantiates a new Spring doc customizers.
SpringDocCustomizers(Optional<Set<OpenApiCustomizer>> openApiCustomizers, Optional<Set<OperationCustomizer>> operationCustomizers, Optional<Set<RouterOperationCustomizer>> routerOperationCustomizers, Optional<Set<OpenApiMethodFilter>> openApiMethodFilters, Optional<List<DelegatingMethodParameterCustomizer>> optionalDelegatingMethodParameterCustomizers, Optional<List<ParameterCustomizer>> parameterCustomizers)	Instantiates a new Spring doc customizers.

Method Summary

Modifier and Type	Method	Description
void	afterPropertiesSet()
Optional<Set<DataRestRouterOperationCustomizer>>	getDataRestRouterOperationCustomizers()	Gets data rest router operation customizers.
Stream<DataRestRouterOperationCustomizer>	getDataRestRouterOperationCustomizersStream()	Gets ordered data rest router operation customizer stream.
Optional<Set<GlobalOpenApiCustomizer>>	getGlobalOpenApiCustomizers()	Gets global open api customizers.
Stream<GlobalOpenApiCustomizer>	getGlobalOpenApiCustomizersStream()	Gets ordered global open api customizer stream.
Optional<Set<GlobalOpenApiMethodFilter>>	getGlobalOpenApiMethodFilters()	Gets global open api method filters.
Optional<Set<GlobalOperationCustomizer>>	getGlobalOperationCustomizers()	Gets global operation customizers.
Stream<GlobalOperationCustomizer>	getGlobalOperationCustomizersStream()	Gets ordered global operation customizer stream.
Optional<Set<OpenApiMethodFilter>>	getMethodFilters()	Gets method filters.
Optional<Set<OpenApiCustomizer>>	getOpenApiCustomizers()	Gets open api customizers.
Stream<OpenApiCustomizer>	getOpenApiCustomizersStream()	Gets ordered open api customizer stream.
Optional<Set<OperationCustomizer>>	getOperationCustomizers()	Gets operation customizers.
Stream<OperationCustomizer>	getOperationCustomizersStream()	Gets ordered operation customizer stream.
Optional<List<DelegatingMethodParameterCustomizer>>	getOptionalDelegatingMethodParameterCustomizers()	Gets optional delegating method parameter customizers.
Optional<List<ParameterCustomizer>>	getParameterCustomizers()	Gets parameter customizers.
Optional<Set<RouterOperationCustomizer>>	getRouterOperationCustomizers()	Gets router operation customizers.
Stream<RouterOperationCustomizer>	getRouterOperationCustomizersStream()	Gets ordered router operation customizer stream.
void	setApplicationContext(org.springframework.context.ApplicationContext applicationContext)

Methods inherited from class java.lang.Object

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

Constructor Details

SpringDocCustomizers

public SpringDocCustomizers(Optional<Set<OpenApiCustomizer>> openApiCustomizers,
 Optional<Set<OperationCustomizer>> operationCustomizers,
 Optional<Set<RouterOperationCustomizer>> routerOperationCustomizers,
 Optional<Set<DataRestRouterOperationCustomizer>> dataRestRouterOperationCustomizers,
 Optional<Set<OpenApiMethodFilter>> methodFilters,
 Optional<Set<GlobalOpenApiCustomizer>> globalOpenApiCustomizers,
 Optional<Set<GlobalOperationCustomizer>> globalOperationCustomizers,
 Optional<Set<GlobalOpenApiMethodFilter>> globalOpenApiMethodFilters,
 Optional<List<DelegatingMethodParameterCustomizer>> optionalDelegatingMethodParameterCustomizers,
 Optional<List<ParameterCustomizer>> parameterCustomizers)

Instantiates a new Spring doc customizers.

Parameters:

openApiCustomizers - the open api customizers

operationCustomizers - the operation customizers

routerOperationCustomizers - the router operation customizers

dataRestRouterOperationCustomizers - the data rest router operation customizers

methodFilters - the method filters

globalOpenApiCustomizers - the global open api customizers

globalOperationCustomizers - the global operation customizers

globalOpenApiMethodFilters - the global open api method filters

optionalDelegatingMethodParameterCustomizers - the optional delegating method parameter customizers

parameterCustomizers - the parameter customizers

SpringDocCustomizers

public SpringDocCustomizers(Optional<Set<OpenApiCustomizer>> openApiCustomizers,
 Optional<Set<OperationCustomizer>> operationCustomizers,
 Optional<Set<RouterOperationCustomizer>> routerOperationCustomizers,
 Optional<Set<OpenApiMethodFilter>> openApiMethodFilters,
 Optional<List<DelegatingMethodParameterCustomizer>> optionalDelegatingMethodParameterCustomizers,
 Optional<List<ParameterCustomizer>> parameterCustomizers)

Instantiates a new Spring doc customizers.

Parameters:

openApiCustomizers - the open api customizers

operationCustomizers - the operation customizers

routerOperationCustomizers - the router operation customizers

openApiMethodFilters - the open api method filters

optionalDelegatingMethodParameterCustomizers - the optional delegating method parameter customizers

parameterCustomizers - the parameter customizers

Method Details

getOpenApiCustomizers

public Optional<Set<OpenApiCustomizer>> getOpenApiCustomizers()

Gets open api customizers.

Returns:

the open api customizers

getOpenApiCustomizersStream

public Stream<OpenApiCustomizer> getOpenApiCustomizersStream()

Gets ordered open api customizer stream.

Returns:

the ordered open api customizer stream

getOperationCustomizers

public Optional<Set<OperationCustomizer>> getOperationCustomizers()

Gets operation customizers.

Returns:

the operation customizers

getOperationCustomizersStream

public Stream<OperationCustomizer> getOperationCustomizersStream()

Gets ordered operation customizer stream.

Returns:

the ordered operation customizer stream

getRouterOperationCustomizers

public Optional<Set<RouterOperationCustomizer>> getRouterOperationCustomizers()

Gets router operation customizers.

Returns:

the router operation customizers

getRouterOperationCustomizersStream

public Stream<RouterOperationCustomizer> getRouterOperationCustomizersStream()

Gets ordered router operation customizer stream.

Returns:

the ordered router operation customizer stream

getDataRestRouterOperationCustomizers

public Optional<Set<DataRestRouterOperationCustomizer>> getDataRestRouterOperationCustomizers()

Gets data rest router operation customizers.

Returns:

the data rest router operation customizers

getDataRestRouterOperationCustomizersStream

public Stream<DataRestRouterOperationCustomizer> getDataRestRouterOperationCustomizersStream()

Gets ordered data rest router operation customizer stream.

Returns:

the ordered data rest router operation customizer stream

getMethodFilters

public Optional<Set<OpenApiMethodFilter>> getMethodFilters()

Gets method filters.

Returns:

the method filters

setApplicationContext

public void setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
                           throws org.springframework.beans.BeansException

Specified by:

setApplicationContext in interface org.springframework.context.ApplicationContextAware

Throws:

org.springframework.beans.BeansException

getGlobalOpenApiCustomizers

public Optional<Set<GlobalOpenApiCustomizer>> getGlobalOpenApiCustomizers()

Gets global open api customizers.

Returns:

the global open api customizers

getGlobalOpenApiCustomizersStream

public Stream<GlobalOpenApiCustomizer> getGlobalOpenApiCustomizersStream()

Gets ordered global open api customizer stream.

Returns:

the ordered global open api customizer stream

getGlobalOperationCustomizers

public Optional<Set<GlobalOperationCustomizer>> getGlobalOperationCustomizers()

Gets global operation customizers.

Returns:

the global operation customizers

getGlobalOperationCustomizersStream

public Stream<GlobalOperationCustomizer> getGlobalOperationCustomizersStream()

Gets ordered global operation customizer stream.

Returns:

the ordered global operation customizer stream

getGlobalOpenApiMethodFilters

public Optional<Set<GlobalOpenApiMethodFilter>> getGlobalOpenApiMethodFilters()

Gets global open api method filters.

Returns:

the global open api method filters

getOptionalDelegatingMethodParameterCustomizers

public Optional<List<DelegatingMethodParameterCustomizer>> getOptionalDelegatingMethodParameterCustomizers()

Gets optional delegating method parameter customizers.

Returns:

the optional delegating method parameter customizers

getParameterCustomizers

public Optional<List<ParameterCustomizer>> getParameterCustomizers()

Gets parameter customizers.

Returns:

the parameter customizers

afterPropertiesSet

public void afterPropertiesSet()

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean