org.openapitools.codegen.config

Class CodegenConfiguratorUtils

java.lang.Object

org.openapitools.codegen.config.CodegenConfiguratorUtils

public final class CodegenConfiguratorUtils
extends Object

Contains shared logic for applying key-value pairs and CSV strings to specific settings in CodegenConfigurator.

This class exists to facilitate testing. These methods could be applied to CodegenConfigurator, but this complicates things when mocking CodegenConfigurator.

• The methods named apply...Kvp take a string of comma-separated key-value pairs.
• The methods named apply...KvpList take a list of such strings.
• The method named apply...Csv takes a string of comma-separated values.
• The method named apply...CsvList takes a list of such strings.

The corresponding add... method on the passed configurator is called for each key-value pair (or value).

Constructor Summary

Constructors

Constructor and Description
CodegenConfiguratorUtils()

Method Summary

Modifier and Type	Method and Description
static void	applyAdditionalPropertiesKvp(String additionalProperties, CodegenConfigurator configurator)
static void	applyAdditionalPropertiesKvpList(List<String> additionalProperties, CodegenConfigurator configurator)
static void	applyGlobalPropertiesKvp(String globalProperties, CodegenConfigurator configurator)
static void	applyGlobalPropertiesKvpList(List<String> globalProperties, CodegenConfigurator configurator)
static void	applyImportMappingsKvp(String importMappings, CodegenConfigurator configurator)
static void	applyImportMappingsKvpList(List<String> importMappings, CodegenConfigurator configurator)
static void	applyInstantiationTypesKvp(String instantiationTypes, CodegenConfigurator configurator)
static void	applyInstantiationTypesKvpList(List<String> instantiationTypes, CodegenConfigurator configurator)
static void	applyLanguageSpecificPrimitivesCsv(String languageSpecificPrimitives, CodegenConfigurator configurator)
static void	applyLanguageSpecificPrimitivesCsvList(List<String> languageSpecificPrimitives, CodegenConfigurator configurator)
static void	applyReservedWordsMappingsKvp(String reservedWordMappings, CodegenConfigurator configurator)
static void	applyReservedWordsMappingsKvpList(List<String> reservedWordMappings, CodegenConfigurator configurator)
static void	applyServerVariablesKvp(String values, CodegenConfigurator configurator)
static void	applyServerVariablesKvpList(List<String> values, CodegenConfigurator configurator)
static void	applySystemPropertiesKvp(String systemProperties, CodegenConfigurator configurator) Deprecated. This method is deprecated due to confusing between Java Sytsem Properties and generator-specific "system-level properties". They've since been renamed as "Global Properties". Please use applyGlobalPropertiesKvp(String, CodegenConfigurator).
static void	applySystemPropertiesKvpList(List<String> systemProperties, CodegenConfigurator configurator) Deprecated. This method is deprecated due to confusion around the tool's use of system properties. We called these system properties in the past and accepted them via CLI option -D. This lead to confusion between true Java System Properties and generator-specific "system level properties". They've since been renamed as "Global Properties". Please use applyGlobalPropertiesKvpList(List, CodegenConfigurator).
static void	applyTypeMappingsKvp(String typeMappings, CodegenConfigurator configurator)
static void	applyTypeMappingsKvpList(List<String> typeMappings, CodegenConfigurator configurator)

Methods inherited from class java.lang.Object

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

Constructor Detail

CodegenConfiguratorUtils

public CodegenConfiguratorUtils()

Method Detail

applySystemPropertiesKvpList

@Deprecated
public static void applySystemPropertiesKvpList(List<String> systemProperties,
                                                            CodegenConfigurator configurator)

Deprecated. This method is deprecated due to confusion around the tool's use of system properties. We called these system properties in the past and accepted them via CLI option -D. This lead to confusion between true Java System Properties and generator-specific "system level properties". They've since been renamed as "Global Properties". Please use applyGlobalPropertiesKvpList(List, CodegenConfigurator).

Applies "system" properties to the configurator as global properties.

Parameters:

systemProperties - List of properties to be globally available throughout the generator execution.

configurator - The CodegenConfigurator instance to configure.

applySystemPropertiesKvp

@Deprecated
public static void applySystemPropertiesKvp(String systemProperties,
                                                        CodegenConfigurator configurator)

Deprecated. This method is deprecated due to confusing between Java Sytsem Properties and generator-specific "system-level properties". They've since been renamed as "Global Properties". Please use applyGlobalPropertiesKvp(String, CodegenConfigurator).

Applies a key-value pair of strings as "system" properties to the configurator as global properties.

Parameters:

systemProperties - List of properties to be globally available throughout the generator execution.

configurator - The CodegenConfigurator instance to configure.

applyGlobalPropertiesKvpList

public static void applyGlobalPropertiesKvpList(List<String> globalProperties,
                                                CodegenConfigurator configurator)

applyGlobalPropertiesKvp

public static void applyGlobalPropertiesKvp(String globalProperties,
                                            CodegenConfigurator configurator)

applyInstantiationTypesKvpList

public static void applyInstantiationTypesKvpList(List<String> instantiationTypes,
                                                  CodegenConfigurator configurator)

applyInstantiationTypesKvp

public static void applyInstantiationTypesKvp(String instantiationTypes,
                                              CodegenConfigurator configurator)

applyImportMappingsKvpList

public static void applyImportMappingsKvpList(List<String> importMappings,
                                              CodegenConfigurator configurator)

applyImportMappingsKvp

public static void applyImportMappingsKvp(String importMappings,
                                          CodegenConfigurator configurator)

applyTypeMappingsKvpList

public static void applyTypeMappingsKvpList(List<String> typeMappings,
                                            CodegenConfigurator configurator)

applyTypeMappingsKvp

public static void applyTypeMappingsKvp(String typeMappings,
                                        CodegenConfigurator configurator)

applyAdditionalPropertiesKvpList

public static void applyAdditionalPropertiesKvpList(List<String> additionalProperties,
                                                    CodegenConfigurator configurator)

applyAdditionalPropertiesKvp

public static void applyAdditionalPropertiesKvp(String additionalProperties,
                                                CodegenConfigurator configurator)

applyServerVariablesKvpList

public static void applyServerVariablesKvpList(List<String> values,
                                               CodegenConfigurator configurator)

applyServerVariablesKvp

public static void applyServerVariablesKvp(String values,
                                           CodegenConfigurator configurator)

applyLanguageSpecificPrimitivesCsvList

public static void applyLanguageSpecificPrimitivesCsvList(List<String> languageSpecificPrimitives,
                                                          CodegenConfigurator configurator)

applyLanguageSpecificPrimitivesCsv

public static void applyLanguageSpecificPrimitivesCsv(String languageSpecificPrimitives,
                                                      CodegenConfigurator configurator)

applyReservedWordsMappingsKvpList

public static void applyReservedWordsMappingsKvpList(List<String> reservedWordMappings,
                                                     CodegenConfigurator configurator)

applyReservedWordsMappingsKvp

public static void applyReservedWordsMappingsKvp(String reservedWordMappings,
                                                 CodegenConfigurator configurator)