de.knightsoftnet.validators.shared.MustBeSmallerOrEqual Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of mt-bean-validators Show documentation

The MT Bean Validators is a collection of JSR-303/JSR-349/JSR-380 bean validators. It's extracted from GWT Bean Validators and contains no dependencies to GWT.

There is a newer version: 2.3.1

Show newest version

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more contributor license
 * agreements. See the NOTICE file distributed with this work for additional information regarding
 * copyright ownership. The ASF licenses this file to You 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 de.knightsoftnet.validators.shared;

import de.knightsoftnet.validators.shared.impl.MustBeSmallerOrEqualValidator;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

import jakarta.validation.Constraint;
import jakarta.validation.Payload;

/**
 * The annotated bean must contain at least two properties:
 * 
 * a field to compare (option field1)
 * another field to compared (option field2)
 * add the error to field1 (option addErrorToField1, default true)
 * add the error to field2 (option addErrorToField2, default false)
 * 
 * the entry of field1 must be smaller or equal then entry of field2, can
 * be used e.g. for date or number "from"/"to" fields.

 * Supported types are beans, null elements are considered valid.

 * The fields must implement Comparable!

 *
 * @author Manfred Tremmel
 *
 */
@Documented
@Constraint(validatedBy = MustBeSmallerOrEqualValidator.class)
@Target({ElementType.TYPE, ElementType.ANNOTATION_TYPE})
@Retention(RetentionPolicy.RUNTIME)
public @interface MustBeSmallerOrEqual {
  /**
   * localized message.
   *
   * @return localized validation message
   */
  String message() default "{de.knightsoftnet.validators.shared.MustBeSmallerOrEqual.message}";

  /**
   * groups to use.
   *
   * @return array of validation groups
   */
  Class[] groups() default {};

  /**
   * field1 name to compare.
   *
   * @return field/path contains value to compare
   */
  String field1();

  /**
   * field2 name to compare.
   *
   * @return field/path contains value to compare
   */
  String field2();

  /**
   * add error to field1 (default true).
   *
   * @return true if error should be added to field1
   */
  boolean addErrorToField1() default true;

  /**
   * add error to field2 (default false).
   *
   * @return true if error should be added to field2
   */
  boolean addErrorToField2() default false;

  /**
   * payload whatever.
   *
   * @return payload class
   */
  Class[] payload() default {};

  /**
   * Defines several {@code MustBeSmallerOrEqual} annotations on the same element.
   */
  @Target({ElementType.TYPE, ElementType.ANNOTATION_TYPE})
  @Retention(RetentionPolicy.RUNTIME)
  @Documented
  @interface List {
    /**
     * must be smaller or equal value.
     *
     * @return value
     */
    MustBeSmallerOrEqual[] value();
  }
}