EnumModule (Java JSON Schema Generator 4.0.2 API)

java.lang.Object
- com.github.victools.jsonschema.generator.impl.module.EnumModule

All Implemented Interfaces:

Module
```
public class EnumModule
extends Object
implements Module
```
Default module being included for the Option.ENUM_AS_STRING.

Constructor Summary

Constructors
Constructor Description

EnumModule(boolean treatAsString)
Constructor remembering whether to treat enums as plain strings or as objects.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`applyToConfigBuilder(SchemaGeneratorConfigBuilder builder)`	Apply this module to the given configuration builder instance.
`static EnumModule`	`asObjects()`	Factory method: creating an `EnumModule` instance that treats all enums as objects but hides all methods declared by the general enum interface but `name()`.
`static EnumModule`	`asStrings()`	Factory method: creating an `EnumModule` instance that treats all enums as plain strings.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - EnumModule
```
public EnumModule(boolean treatAsString)
```
    Constructor remembering whether to treat enums as plain strings or as objects.
    
    Parameters:
    
    treatAsString - whether to treat enums as plain strings
- Method Detail
  - asStrings
```
public static EnumModule asStrings()
```
    Factory method: creating an EnumModule instance that treats all enums as plain strings.
    
    Returns:
    
    created module instance
  - asObjects
```
public static EnumModule asObjects()
```
    Factory method: creating an EnumModule instance that treats all enums as objects but hides all methods declared by the general enum interface but name(). Methods and fields (including the enum constants) declared by their sub types are not excluded.
    
    Returns:
    
    created module instance
  - applyToConfigBuilder
```
public void applyToConfigBuilder(SchemaGeneratorConfigBuilder builder)
```
    Description copied from interface: Module
    
    Apply this module to the given configuration builder instance.
    
    Specified by:
    
    applyToConfigBuilder in interface Module
    
    Parameters:
    
    builder - configuration builder instance to which to apply this module