io.github.robwin.swagger2markup.utils.ParameterUtils.java Source code

Introduction

Here is the source code for io.github.robwin.swagger2markup.utils.ParameterUtils.java

Source

/*
 *
 *  Copyright 2015 Robert Winkler
 *
 *  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
 *
 *         http://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 io.github.robwin.swagger2markup.utils;

import io.swagger.models.Model;
import io.swagger.models.parameters.AbstractSerializableParameter;
import io.swagger.models.parameters.BodyParameter;
import io.swagger.models.parameters.Parameter;
import io.swagger.models.parameters.RefParameter;
import io.github.robwin.markup.builder.MarkupLanguage;
import org.apache.commons.collections.CollectionUtils;
import org.apache.commons.lang3.StringUtils;
import org.apache.commons.lang3.Validate;

import java.util.List;

public final class ParameterUtils {

    public static String getType(Parameter parameter, MarkupLanguage markupLanguage) {
        Validate.notNull(parameter, "property must not be null!");
        String type = "NOT FOUND";
        if (parameter instanceof BodyParameter) {
            BodyParameter bodyParameter = (BodyParameter) parameter;
            Model model = bodyParameter.getSchema();
            type = ModelUtils.getType(model, markupLanguage);
        } else if (parameter instanceof AbstractSerializableParameter) {
            AbstractSerializableParameter serializableParameter = (AbstractSerializableParameter) parameter;
            List enums = serializableParameter.getEnum();
            if (CollectionUtils.isNotEmpty(enums)) {
                type = "enum" + " (" + StringUtils.join(enums, ", ") + ")";
            } else {
                type = getTypeWithFormat(serializableParameter.getType(), serializableParameter.getFormat());
            }
            if (type.equals("array")) {
                String collectionFormat = serializableParameter.getCollectionFormat();
                type = collectionFormat + " "
                        + PropertyUtils.getType(serializableParameter.getItems(), markupLanguage) + " " + type;
            }
        } else if (parameter instanceof RefParameter) {
            RefParameter refParameter = (RefParameter) parameter;
            switch (markupLanguage) {
            case ASCIIDOC:
                return "<<" + refParameter.getSimpleRef() + ">>";
            default:
                return refParameter.getSimpleRef();
            }
        }
        return StringUtils.defaultString(type);
    }

    private static String getTypeWithFormat(String typeWithoutFormat, String format) {
        String type;
        if (StringUtils.isNotBlank(format)) {
            type = StringUtils.defaultString(typeWithoutFormat) + " (" + format + ")";
        } else {
            type = StringUtils.defaultString(typeWithoutFormat);
        }
        return type;
    }

    public static String getDefaultValue(Parameter parameter) {
        Validate.notNull(parameter, "property must not be null!");
        String defaultValue = "";
        if (parameter instanceof AbstractSerializableParameter) {
            AbstractSerializableParameter serializableParameter = (AbstractSerializableParameter) parameter;
            defaultValue = serializableParameter.getDefaultValue();
        }
        return StringUtils.defaultString(defaultValue);
    }

}