springfox.documentation.spring.data.rest.RequestExtractionUtils.java Source code

Introduction

Here is the source code for springfox.documentation.spring.data.rest.RequestExtractionUtils.java

Source

/*
 *
 *  Copyright 2017-2018 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.spring.data.rest;

import com.fasterxml.classmate.ResolvedType;
import com.fasterxml.classmate.TypeResolver;
import com.google.common.base.CaseFormat;
import org.springframework.core.annotation.AnnotationUtils;
import org.springframework.data.mapping.PersistentEntity;
import org.springframework.data.mapping.PersistentProperty;
import org.springframework.hateoas.Resource;
import org.springframework.hateoas.Resources;
import org.springframework.web.method.HandlerMethod;

import java.lang.annotation.Annotation;
import java.lang.reflect.Method;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import java.util.Map;

class RequestExtractionUtils {
    private RequestExtractionUtils() {
        throw new UnsupportedOperationException();
    }

    public static String lowerCamelCaseName(String stringValue) {
        return CaseFormat.UPPER_CAMEL.to(CaseFormat.LOWER_CAMEL, stringValue);
    }

    public static String upperCamelCaseName(String stringValue) {
        return CaseFormat.UPPER_CAMEL.to(CaseFormat.LOWER_CAMEL, stringValue);
    }

    public static String actionName(PersistentEntity<?, ?> entity, Method method) {
        return String.format("%s%s", method.getName(), entity.getType().getSimpleName());
    }

    public static List<Annotation> pathAnnotations(String name) {
        return pathAnnotations(name, null);
    }

    public static List<Annotation> pathAnnotations(String name, HandlerMethod handler) {
        List<Annotation> annotations = handlerAnnotations(handler);
        if (name != null) {
            annotations.add(SynthesizedAnnotations.pathVariable(name));
        }
        return annotations;
    }

    public static List<Annotation> bodyAnnotations(HandlerMethod handler) {
        List<Annotation> annotations = handlerAnnotations(handler);
        annotations.add(SynthesizedAnnotations.REQUEST_BODY_ANNOTATION);
        return annotations;
    }

    private static List<Annotation> handlerAnnotations(HandlerMethod handler) {
        List<Annotation> annotations = new ArrayList<Annotation>();
        if (handler != null) {
            annotations.addAll(Arrays.asList(AnnotationUtils.getAnnotations(handler.getMethod())));
        }
        return annotations;
    }

    public static List<Annotation> bodyAnnotations() {
        List<Annotation> annotations = handlerAnnotations(null);
        annotations.add(SynthesizedAnnotations.REQUEST_BODY_ANNOTATION);
        return annotations;
    }

    public static String propertyIdentifierName(PersistentProperty<?> property) {
        String propertyName = property.getName();
        if (property.isCollectionLike()) {
            propertyName = property.getComponentType().getSimpleName();
        } else if (property.isMap()) {
            propertyName = property.getMapValueType().getSimpleName();
        }
        return String.format("%sId", propertyName.toLowerCase());
    }

    public static ResolvedType propertyResponse(PersistentProperty<?> property, TypeResolver resolver) {
        if (property.isCollectionLike()) {
            return resolver.resolve(Resources.class, property.getComponentType());
        } else if (property.isMap()) {
            return resolver.resolve(Resource.class,
                    resolver.resolve(Map.class, String.class, property.getMapValueType()));
        }
        return resolver.resolve(Resource.class, property.getType());
    }

    public static ResolvedType propertyItemResponse(PersistentProperty<?> property, TypeResolver resolver) {
        if (property.isCollectionLike()) {
            return resolver.resolve(Resource.class, property.getComponentType());
        } else if (property.isMap()) {
            return resolver.resolve(Resource.class, property.getMapValueType());
        }
        return resolver.resolve(Resource.class, property.getType());
    }
}