Package org.openapitools.codegen.languages

Class EnumValueInterfaceUtils

java.lang.Object

org.openapitools.codegen.languages.EnumValueInterfaceUtils

public final class EnumValueInterfaceUtils
extends Object

Language-agnostic utility for the useEnumValueInterface code-generation option.

When enabled, every generated enum (both top-level schema enums and inline property enums) is made to implement a common ValuedEnum<T> interface that exposes the backing value, allowing generic code to access enum values without reflection.

Two entry points are provided, one for each generator lifecycle hook:

• setupInPreprocessOpenAPI(java.util.Map<java.lang.String, java.lang.String>, java.util.Map<java.lang.String, java.lang.Object>, java.util.List<org.openapitools.codegen.SupportingFile>, java.lang.String, java.lang.String, java.lang.String, java.lang.String) — called from preprocessOpenAPI to register the supporting file and the import mapping.
• injectInPostProcessModelsEnum(org.openapitools.codegen.model.ModelsMap, java.lang.String, java.lang.String, java.lang.String) — called from postProcessModelsEnum to inject the interface into every enum model's implements vendor extension.

The only language-specific knobs are:

• The name of the vendor extension that carries implemented interfaces ("x-implements" for Java, "x-kotlin-implements" for Kotlin).
• The output file name ("ValuedEnum.java" vs "ValuedEnum.kt").

Used by both SpringCodegen and KotlinSpringServerCodegen.

Method Summary

Modifier and Type	Method	Description
static void	injectInPostProcessModelsEnum(ModelsMap objs, String valuedEnumClassName, String valuedEnumFqn, String xImplementsExtensionKey)	Injects ValuedEnum<T> into the implements vendor extension of every enum in the given model batch.
static String	setupInPreprocessOpenAPI(Map<String,String> importMapping, Map<String,Object> additionalProperties, List<SupportingFile> supportingFiles, String sourceFolder, String configPackage, String mustacheTemplate, String outputFileName)	Registers the ValuedEnum supporting file and import mapping.

Methods inherited from class java.lang.Object

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

Method Detail

setupInPreprocessOpenAPI

public static String setupInPreprocessOpenAPI(Map<String,String> importMapping,
                                              Map<String,Object> additionalProperties,
                                              List<SupportingFile> supportingFiles,
                                              String sourceFolder,
                                              String configPackage,
                                              String mustacheTemplate,
                                              String outputFileName)

Registers the ValuedEnum supporting file and import mapping.

Must be called from preprocessOpenAPI when useEnumValueInterface is enabled. Returns the simple class name derived from the (possibly custom) import mapping, which the caller must store and pass to injectInPostProcessModelsEnum(org.openapitools.codegen.model.ModelsMap, java.lang.String, java.lang.String, java.lang.String) later.

Parameters:

importMapping - the codegen's import-mapping map (mutated in place)

additionalProperties - the codegen's additional-properties map (mutated in place)

supportingFiles - the codegen's supporting-files list (mutated in place)

sourceFolder - language source folder (e.g. "src/main/java")

configPackage - the config package where the interface is generated (e.g. "org.openapitools.configuration")

mustacheTemplate - template name (e.g. "enumValueInterface.mustache")

outputFileName - generated file name (e.g. "ValuedEnum.java")

Returns:

the simple class name of ValuedEnum (accounts for custom import mappings)

injectInPostProcessModelsEnum

public static void injectInPostProcessModelsEnum(ModelsMap objs,
                                                 String valuedEnumClassName,
                                                 String valuedEnumFqn,
                                                 String xImplementsExtensionKey)

Injects ValuedEnum<T> into the implements vendor extension of every enum in the given model batch.

Must be called from postProcessModelsEnum when useEnumValueInterface is enabled. Handles both top-level enum schemas and inline enum properties.

Parameters:

objs - the model batch being post-processed

valuedEnumClassName - simple class name (e.g. "ValuedEnum")

valuedEnumFqn - fully-qualified name used for the import statement

xImplementsExtensionKey - vendor-extension key that carries the implements list ("x-implements" for Java, "x-kotlin-implements" for Kotlin)