springfox.documentation.schema.ResolvedTypes.java Source code

Introduction

Here is the source code for springfox.documentation.schema.ResolvedTypes.java

Source

/*
 *
 *  Copyright 2015 the original author or authors.
 *
 *  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 springfox.documentation.schema;

import com.fasterxml.classmate.ResolvedType;
import com.fasterxml.classmate.types.ResolvedArrayType;
import com.fasterxml.classmate.types.ResolvedPrimitiveType;
import com.google.common.base.Function;
import com.google.common.base.Optional;
import springfox.documentation.service.AllowableValues;
import springfox.documentation.spi.schema.contexts.ModelContext;

import java.lang.reflect.Type;
import java.util.List;

import static springfox.documentation.schema.Collections.*;
import static springfox.documentation.schema.Types.*;

public class ResolvedTypes {

    private ResolvedTypes() {
        throw new UnsupportedOperationException();
    }

    public static String simpleQualifiedTypeName(ResolvedType type) {
        if (type instanceof ResolvedPrimitiveType) {
            Type primitiveType = type.getErasedType();
            return typeNameFor(primitiveType);
        }
        if (type instanceof ResolvedArrayType) {
            return typeNameFor(type.getArrayElementType().getErasedType());
        }

        return type.getErasedType().getName();
    }

    public static AllowableValues allowableValues(ResolvedType resolvedType) {
        if (isContainerType(resolvedType)) {
            List<ResolvedType> typeParameters = resolvedType.getTypeParameters();
            if (typeParameters != null && typeParameters.size() == 1) {
                return Enums.allowableValues(typeParameters.get(0).getErasedType());
            }
        }
        return Enums.allowableValues(resolvedType.getErasedType());
    }

    public static Optional<String> resolvedTypeSignature(ResolvedType resolvedType) {
        return Optional.fromNullable(resolvedType).transform(new Function<ResolvedType, String>() {
            @Override
            public String apply(ResolvedType input) {
                return input.getSignature();
            }
        });
    }

    public static Function<ResolvedType, ModelReference> modelRefFactory(final ModelContext parentContext,
            final TypeNameExtractor typeNameExtractor) {

        return new ModelReferenceProvider(typeNameExtractor, parentContext);
    }

}