springfox.bean.validators.plugins.schema.MinMaxAnnotationPlugin Maven / Gradle / Ivy
/*
*
* Copyright 2016-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.schema;
import com.google.common.annotations.VisibleForTesting;
import com.google.common.base.Optional;
import org.springframework.core.annotation.Order;
import org.springframework.stereotype.Component;
import springfox.bean.validators.plugins.Validators;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spi.schema.ModelPropertyBuilderPlugin;
import springfox.documentation.spi.schema.contexts.ModelPropertyContext;
import javax.validation.constraints.Max;
import javax.validation.constraints.Min;
import static springfox.bean.validators.plugins.RangeAnnotations.*;
import static springfox.bean.validators.plugins.Validators.*;
@Component
@Order(Validators.BEAN_VALIDATOR_PLUGIN_ORDER)
public class MinMaxAnnotationPlugin implements ModelPropertyBuilderPlugin {
@Override
public boolean supports(DocumentationType delimiter) {
// we simply support all documentationTypes!
return true;
}
@Override
public void apply(ModelPropertyContext context) {
Optional min = extractMin(context);
Optional max = extractMax(context);
// add support for @Min/@Max
context.getBuilder().allowableValues(allowableRange(min, max));
}
@VisibleForTesting
Optional extractMin(ModelPropertyContext context) {
return annotationFromBean(context, Min.class).or(annotationFromField(context, Min.class));
}
@VisibleForTesting
Optional extractMax(ModelPropertyContext context) {
return annotationFromBean(context, Max.class).or(annotationFromField(context, Max.class));
}
}