springfox.bean.validators.plugins.Validators Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of springfox-bean-validators Show documentation
JSON API documentation for spring based applications
There is a newer version: 3.0.0
Show newest version
/*
 *
 *  Copyright 2015-2017 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.bean.validators.plugins;

import com.fasterxml.jackson.databind.introspect.BeanPropertyDefinition;
import com.google.common.base.Optional;
import org.springframework.core.Ordered;
import org.springframework.core.annotation.AnnotationUtils;
import springfox.documentation.service.ResolvedMethodParameter;
import springfox.documentation.spi.schema.contexts.ModelPropertyContext;
import springfox.documentation.spi.service.contexts.ParameterContext;

import java.lang.annotation.Annotation;
import java.lang.reflect.AnnotatedElement;
import java.lang.reflect.Field;
import java.lang.reflect.Method;

/**
 * Utility methods for Validators
 */
public class Validators {
  public static final int BEAN_VALIDATOR_PLUGIN_ORDER = Ordered.HIGHEST_PRECEDENCE + 500;

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

  public static  Optional extractAnnotation(
      ModelPropertyContext context,
      Class annotationType) {
    return annotationFromBean(context, annotationType)
        .or(annotationFromField(context, annotationType));
  }

  public static  Optional annotationFromBean(
      ModelPropertyContext context,
      Class annotationType) {

    Optional propertyDefinition = context.getBeanPropertyDefinition();
    Optional notNull = Optional.absent();
    if (propertyDefinition.isPresent()) {
      Optional getter = extractGetterFromPropertyDefinition(propertyDefinition.get());
      Optional field = extractFieldFromPropertyDefinition(propertyDefinition.get());
      notNull = findAnnotation(getter, annotationType).or(findAnnotation(field, annotationType));
    }

    return notNull;
  }

  public static  Optional annotationFromField(
      ModelPropertyContext context,
      Class annotationType) {
    return findAnnotation(context.getAnnotatedElement(), annotationType);
  }

  public static  Optional annotationFromParameter(
      ParameterContext context,
      Class annotationType) {

    ResolvedMethodParameter methodParam = context.resolvedMethodParameter();
    return methodParam.findAnnotation(annotationType);
  }

  private static Optional extractFieldFromPropertyDefinition(BeanPropertyDefinition propertyDefinition) {
    if (propertyDefinition.getField() != null) {
      return Optional.fromNullable(propertyDefinition.getField().getAnnotated());
    }
    return Optional.absent();
  }

  private static Optional extractGetterFromPropertyDefinition(BeanPropertyDefinition propertyDefinition) {
    if (propertyDefinition.getGetter() != null) {
      return Optional.fromNullable(propertyDefinition.getGetter().getMember());
    }
    return Optional.absent();
  }

  private static  Optional findAnnotation(
      Optional annotatedElement,
      Class annotationType) {
    if (annotatedElement.isPresent()) {
      return Optional.fromNullable(AnnotationUtils.findAnnotation(annotatedElement.get(), annotationType));
    } else {
      return Optional.absent();
    }
  }
}