de.bitgrip.ficum.swagger

Class FicumExpressionParameterBuilderPlugin

java.lang.Object

de.bitgrip.ficum.swagger.FicumExpressionParameterBuilderPlugin

All Implemented Interfaces:

org.springframework.plugin.core.Plugin<springfox.documentation.spi.DocumentationType>, springfox.documentation.spi.service.ParameterBuilderPlugin

@Order(value=-2147481648)
public class FicumExpressionParameterBuilderPlugin
extends Object
implements springfox.documentation.spi.service.ParameterBuilderPlugin

Plugin which attaches a description to all parameters which are annotated with FicumExpression. Additionally it adds all allowedValues which are configured by FicumExpression to formatDescription

(w) marcelmuller (c) bitgrip GmbH, 2019

Field Summary

Fields

Modifier and Type	Field and Description
private static String	DEFAULT_FORMAT_DESCRIPTION
private String	formatDescription
private com.fasterxml.classmate.TypeResolver	resolver

Constructor Summary

Constructors

Constructor and Description
FicumExpressionParameterBuilderPlugin(com.fasterxml.classmate.TypeResolver resolver)
FicumExpressionParameterBuilderPlugin(com.fasterxml.classmate.TypeResolver resolver, String formatDescription)

Method Summary

Modifier and Type	Method and Description
void	apply(springfox.documentation.spi.service.contexts.ParameterContext parameterContext)
boolean	supports(springfox.documentation.spi.DocumentationType delimiter)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_FORMAT_DESCRIPTION

private static final String DEFAULT_FORMAT_DESCRIPTION

See Also:

Constant Field Values

resolver

private com.fasterxml.classmate.TypeResolver resolver

formatDescription

private String formatDescription

Constructor Detail

FicumExpressionParameterBuilderPlugin

public FicumExpressionParameterBuilderPlugin(com.fasterxml.classmate.TypeResolver resolver,
                                             String formatDescription)

FicumExpressionParameterBuilderPlugin

public FicumExpressionParameterBuilderPlugin(com.fasterxml.classmate.TypeResolver resolver)

Method Detail

apply

public void apply(springfox.documentation.spi.service.contexts.ParameterContext parameterContext)

Specified by:

apply in interface springfox.documentation.spi.service.ParameterBuilderPlugin

supports

public boolean supports(springfox.documentation.spi.DocumentationType delimiter)

Specified by:

supports in interface org.springframework.plugin.core.Plugin<springfox.documentation.spi.DocumentationType>