Previously, users that wanted to document a request field’s constraints had to roll their own solution. This commit introduces a new API that makes it easier to document constraints. Support is provided for discovering Bean Validation constraints and resolving descriptions for them. The constraint descriptions can then be used as required. For example, they can included in a field’s description or in an additional constraints attribute that’s included in an additional table column via the use of a custom snippet template. Closes gh-42
47 lines
1.4 KiB
Java
47 lines
1.4 KiB
Java
/*
|
|
* Copyright 2014 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 com.example.notes;
|
|
|
|
import java.lang.annotation.ElementType;
|
|
import java.lang.annotation.Retention;
|
|
import java.lang.annotation.RetentionPolicy;
|
|
import java.lang.annotation.Target;
|
|
|
|
import javax.validation.Constraint;
|
|
import javax.validation.Payload;
|
|
import javax.validation.constraints.Null;
|
|
|
|
import org.hibernate.validator.constraints.CompositionType;
|
|
import org.hibernate.validator.constraints.ConstraintComposition;
|
|
import org.hibernate.validator.constraints.NotBlank;
|
|
|
|
@ConstraintComposition(CompositionType.OR)
|
|
@Constraint(validatedBy = {})
|
|
@Null
|
|
@NotBlank
|
|
@Target({ ElementType.FIELD, ElementType.PARAMETER })
|
|
@Retention(RetentionPolicy.RUNTIME)
|
|
public @interface NullOrNotBlank {
|
|
|
|
String message() default "Must be null or not blank";
|
|
|
|
Class<?>[] groups() default {};
|
|
|
|
Class<? extends Payload>[] payload() default {};
|
|
|
|
}
|