org.openapitools.codegen.config.CodegenConfiguratorUtils Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of openapi-generator Show documentation
There is a newer version: 7.9.0
/*
 * Copyright 2018 OpenAPI-Generator Contributors (https://openapi-generator.tech)
 * Copyright 2018 SmartBear Software
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.openapitools.codegen.config;

import org.apache.commons.lang3.tuple.Pair;
import org.openapitools.codegen.utils.OptionUtils;

import java.util.*;

/**
 * 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 {@code apply...Kvp} take a string of comma-separated key-value pairs.
 *     The methods named {@code apply...KvpList} take a list of such strings.
 *     The method named {@code apply...Csv} takes a string of comma-separated values.
 *     The method named {@code apply...CsvList} takes a list of such strings.
 * 
 * 
 *     The corresponding {@code add...} method on the passed configurator is called for each key-value pair (or value).
 * 
 */
public final class CodegenConfiguratorUtils {

    public static void applyGlobalPropertiesKvpList(List globalProperties, CodegenConfigurator configurator) {
        for (String propString : globalProperties) {
            applyGlobalPropertiesKvp(propString, configurator);
        }
    }

    public static void applyGlobalPropertiesKvp(String globalProperties, CodegenConfigurator configurator) {
        final Map map = createMapFromKeyValuePairs(globalProperties);
        for (Map.Entry entry : map.entrySet()) {
            configurator.addGlobalProperty(entry.getKey(), entry.getValue().replace(":", ","));
        }
    }

    public static void applyInstantiationTypesKvpList(List instantiationTypes, CodegenConfigurator configurator) {
        for (String propString : instantiationTypes) {
            applyInstantiationTypesKvp(propString, configurator);
        }
    }

    public static void applyInstantiationTypesKvp(String instantiationTypes, CodegenConfigurator configurator) {
        final Map map = createMapFromKeyValuePairs(instantiationTypes);
        for (Map.Entry entry : map.entrySet()) {
            configurator.addInstantiationType(entry.getKey(), entry.getValue());
        }
    }

    public static void applyImportMappingsKvpList(List importMappings, CodegenConfigurator configurator) {
        for (String propString : importMappings) {
            applyImportMappingsKvp(propString, configurator);
        }
    }

    public static void applyImportMappingsKvp(String importMappings, CodegenConfigurator configurator) {
        final Map map = createMapFromKeyValuePairs(importMappings);
        for (Map.Entry entry : map.entrySet()) {
            configurator.addImportMapping(entry.getKey().trim(), entry.getValue().trim());
        }
    }

    public static void applySchemaMappingsKvpList(List schemaMappings, CodegenConfigurator configurator) {
        for (String propString : schemaMappings) {
            applySchemaMappingsKvp(propString, configurator);
        }
    }

    public static void applySchemaMappingsKvp(String schemaMappings, CodegenConfigurator configurator) {
        final Map map = createMapFromKeyValuePairs(schemaMappings);
        for (Map.Entry entry : map.entrySet()) {
            configurator.addSchemaMapping(entry.getKey().trim(), entry.getValue().trim());
        }
    }

    public static void applyInlineSchemaNameMappingsKvpList(List inlineSchemaNameMappings, CodegenConfigurator configurator) {
        for (String propString : inlineSchemaNameMappings) {
            applyInlineSchemaNameMappingsKvp(propString, configurator);
        }
    }

    public static void applyInlineSchemaNameMappingsKvp(String inlineSchemaNameMappings, CodegenConfigurator configurator) {
        final Map map = createMapFromKeyValuePairs(inlineSchemaNameMappings);
        for (Map.Entry entry : map.entrySet()) {
            configurator.addInlineSchemaNameMapping(entry.getKey().trim(), entry.getValue().trim());
        }
    }

    public static void applyInlineSchemaOptionsKvpList(List inlineSchemaOptions, CodegenConfigurator configurator) {
        for (String propString : inlineSchemaOptions) {
            applyInlineSchemaOptionsKvp(propString, configurator);
        }
    }

    public static void applyInlineSchemaOptionsKvp(String inlineSchemaOptions, CodegenConfigurator configurator) {
        final Map map = createMapFromKeyValuePairs(inlineSchemaOptions);
        for (Map.Entry entry : map.entrySet()) {
            configurator.addInlineSchemaOption(entry.getKey().trim(), entry.getValue().trim());
        }
    }

    public static void applyNameMappingsKvpList(List nameMappings, CodegenConfigurator configurator) {
        for (String propString : nameMappings) {
            applyNameMappingsKvp(propString, configurator);
        }
    }

    public static void applyNameMappingsKvp(String nameMappings, CodegenConfigurator configurator) {
        final Map map = createMapFromKeyValuePairs(nameMappings);
        for (Map.Entry entry : map.entrySet()) {
            configurator.addNameMapping(entry.getKey().trim(), entry.getValue().trim());
        }
    }

    public static void applyParameterNameMappingsKvpList(List parameterNameMappings, CodegenConfigurator configurator) {
        for (String propString : parameterNameMappings) {
            applyParameterNameMappingsKvp(propString, configurator);
        }
    }

    public static void applyParameterNameMappingsKvp(String parameterNameMappings, CodegenConfigurator configurator) {
        final Map map = createMapFromKeyValuePairs(parameterNameMappings);
        for (Map.Entry entry : map.entrySet()) {
            configurator.addParameterNameMapping(entry.getKey().trim(), entry.getValue().trim());
        }
    }

    public static void applyModelNameMappingsKvpList(List modelNameMappings, CodegenConfigurator configurator) {
        for (String propString : modelNameMappings) {
            applyModelNameMappingsKvp(propString, configurator);
        }
    }

    public static void applyModelNameMappingsKvp(String modelNameMappings, CodegenConfigurator configurator) {
        final Map map = createMapFromKeyValuePairs(modelNameMappings);
        for (Map.Entry entry : map.entrySet()) {
            configurator.addModelNameMapping(entry.getKey().trim(), entry.getValue().trim());
        }
    }

    public static void applyEnumNameMappingsKvpList(List enumNameMappings, CodegenConfigurator configurator) {
        for (String propString : enumNameMappings) {
            applyEnumNameMappingsKvp(propString, configurator);
        }
    }

    public static void applyEnumNameMappingsKvp(String enumNameMappings, CodegenConfigurator configurator) {
        final Map map = createMapFromKeyValuePairs(enumNameMappings);
        for (Map.Entry entry : map.entrySet()) {
            configurator.addEnumNameMapping(entry.getKey().trim(), entry.getValue().trim());
        }
    }

    public static void applyOperationIdNameMappingsKvpList(List operationIdNameMappings, CodegenConfigurator configurator) {
        for (String propString : operationIdNameMappings) {
            applyOperationIdNameMappingsKvp(propString, configurator);
        }
    }

    public static void applyOperationIdNameMappingsKvp(String operationIdNameMappings, CodegenConfigurator configurator) {
        final Map map = createMapFromKeyValuePairs(operationIdNameMappings);
        for (Map.Entry entry : map.entrySet()) {
            configurator.addOperationIdNameMapping(entry.getKey().trim(), entry.getValue().trim());
        }
    }

    public static void applyOpenapiNormalizerKvpList(List openapiNormalizer, CodegenConfigurator configurator) {
        for (String propString : openapiNormalizer) {
            applyOpenapiNormalizerKvp(propString, configurator);
        }
    }

    public static void applyOpenapiNormalizerKvp(String openapiNormalizer, CodegenConfigurator configurator) {
        final Map map = createMapFromKeyValuePairs(openapiNormalizer);
        for (Map.Entry entry : map.entrySet()) {
            configurator.addOpenapiNormalizer(entry.getKey().trim(), entry.getValue().trim());
        }
    }

    public static void applyTypeMappingsKvpList(List typeMappings, CodegenConfigurator configurator) {
        for (String propString : typeMappings) {
            applyTypeMappingsKvp(propString, configurator);
        }
    }

    public static void applyTypeMappingsKvp(String typeMappings, CodegenConfigurator configurator) {
        final Map map = createMapFromKeyValuePairs(typeMappings);
        for (Map.Entry entry : map.entrySet()) {
            configurator.addTypeMapping(entry.getKey(), entry.getValue());
        }
    }

    public static void applyAdditionalPropertiesKvpList(List additionalProperties, CodegenConfigurator configurator) {
        for (String propString : additionalProperties) {
            applyAdditionalPropertiesKvp(propString, configurator);
        }
    }

    public static void applyAdditionalPropertiesKvp(String additionalProperties, CodegenConfigurator configurator) {
        final Map map = createMapFromKeyValuePairs(additionalProperties);
        for (Map.Entry entry : map.entrySet()) {
            configurator.addAdditionalProperty(entry.getKey(), entry.getValue());
        }
    }

    public static void applyServerVariablesKvpList(List values, CodegenConfigurator configurator) {
        for (String value : values) {
            applyServerVariablesKvp(value, configurator);
        }
    }

    public static void applyServerVariablesKvp(String values, CodegenConfigurator configurator) {
        final Map map = createMapFromKeyValuePairs(values);
        for (Map.Entry entry : map.entrySet()) {
            configurator.addServerVariable(entry.getKey(), entry.getValue());
        }
    }

    public static void applyLanguageSpecificPrimitivesCsvList(List languageSpecificPrimitives, CodegenConfigurator configurator) {
        for (String propString : languageSpecificPrimitives) {
            applyLanguageSpecificPrimitivesCsv(propString, configurator);
        }
    }

    public static void applyLanguageSpecificPrimitivesCsv(String languageSpecificPrimitives, CodegenConfigurator configurator) {
        final Set set = createSetFromCsvList(languageSpecificPrimitives);
        for (String item : set) {
            configurator.addLanguageSpecificPrimitive(item);
        }
    }

    public static void applyOpenapiGeneratorIgnoreListCsvList(List openapiGeneratorIgnoreList, CodegenConfigurator configurator) {
        for (String propString : openapiGeneratorIgnoreList) {
            applyOpenapiGeneratorIgnoreListCsv(propString, configurator);
        }
    }

    public static void applyOpenapiGeneratorIgnoreListCsv(String openapiGeneratorIgnoreList, CodegenConfigurator configurator) {
        final Set set = createSetFromCsvList(openapiGeneratorIgnoreList);
        for (String item : set) {
            configurator.addOpenapiGeneratorIgnoreList(item);
        }
    }

    public static void applyReservedWordsMappingsKvpList(List reservedWordsMappings, CodegenConfigurator configurator) {
        for (String propString : reservedWordsMappings) {
            applyReservedWordsMappingsKvp(propString, configurator);
        }
    }

    public static void applyReservedWordsMappingsKvp(String reservedWordsMappings, CodegenConfigurator configurator) {
        final Map map = createMapFromKeyValuePairs(reservedWordsMappings);
        for (Map.Entry entry : map.entrySet()) {
            configurator.addAdditionalReservedWordMapping(entry.getKey(), entry.getValue());
        }
    }

    private static Set createSetFromCsvList(String csvProperty) {
        final List values = OptionUtils.splitCommaSeparatedList(csvProperty);
        return new HashSet(values);
    }

    private static Map createMapFromKeyValuePairs(String commaSeparatedKVPairs) {
        final List> pairs = OptionUtils.parseCommaSeparatedTuples(commaSeparatedKVPairs);

        Map result = new HashMap();

        for (Pair pair : pairs) {
            result.put(pair.getLeft(), pair.getRight());
        }

        return result;
    }
}