ApiEnumDescriptionPlugin (Springfox Enum Plugin 3.0.0 API)

java.lang.Object
- de.pentabyte.springfox.ApiEnumDescriptionPlugin

All Implemented Interfaces:

org.springframework.plugin.core.Plugin<springfox.documentation.spi.DocumentationType>, springfox.documentation.spi.schema.ModelPropertyBuilderPlugin, springfox.documentation.spi.service.ParameterBuilderPlugin
```
@Component
@Order(-2147481648)
public class ApiEnumDescriptionPlugin
extends Object
implements springfox.documentation.spi.schema.ModelPropertyBuilderPlugin, springfox.documentation.spi.service.ParameterBuilderPlugin
```
Will extend all ApiModelPropertys' and ApiParams' description with a list of ENUM descriptions, if the property is an enum and if at least one of its values is annotated with ApiEnum to make this work.

Since:

2018

Author:

Michael Höreth

Constructor Summary

Constructors
Constructor Description

ApiEnumDescriptionPlugin()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`apply(springfox.documentation.spi.schema.contexts.ModelPropertyContext context)`
`void`	`apply(springfox.documentation.spi.service.contexts.ParameterContext context)`
`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

- Constructor Detail
  - ApiEnumDescriptionPlugin
```
public ApiEnumDescriptionPlugin()
```
- Method Detail
  - supports
```
public boolean supports(springfox.documentation.spi.DocumentationType delimiter)
```
    Specified by:
    
    supports in interface org.springframework.plugin.core.Plugin<springfox.documentation.spi.DocumentationType>
  - apply
```
public void apply(springfox.documentation.spi.schema.contexts.ModelPropertyContext context)
```
    Specified by:
    
    apply in interface springfox.documentation.spi.schema.ModelPropertyBuilderPlugin
  - apply
```
public void apply(springfox.documentation.spi.service.contexts.ParameterContext context)
```
    Specified by:
    
    apply in interface springfox.documentation.spi.service.ParameterBuilderPlugin