de.knightsoftnet.validators.shared.NotEmptyIfOthersHaveValue 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.NotEmptyIfOthersHaveValueValidator;

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 that has to be checked (option field)
 * a array of fields and entries to be compared (option
 * otherFieldValueMapping)
 * 
 * if the entries of otherFieldValueMapping.fieldCompare matches one of the
 * corresponding entries in otherFieldValueMapping.valueCompare (array of possible
 * values), field must not be empty (null or "").

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

 *
 */
@Constraint(validatedBy = {NotEmptyIfOthersHaveValueValidator.class})
@Target({ElementType.TYPE, ElementType.ANNOTATION_TYPE})
@Retention(RetentionPolicy.RUNTIME)
public @interface NotEmptyIfOthersHaveValue {
  /**
   * validation message.
   *
   * @return the validation message
   */
  String message() default "{de.knightsoftnet.validators.shared.NotEmptyIfOthersHaveValue"
      + ".message}";

  /**
   * validation groups.
   *
   * @return the validation groups
   */
  Class[] groups() default {};

  /**
   * name of the field to be validated.
   *
   * @return the name of the field to be validated
   */
  String field();

  /**
   * optional minimum value that the field should have.
   *
   * @return the minimum value that the field should have, -Double.MAX_VALUE if not specified.
   */
  double minValue() default -Double.MAX_VALUE;

  /**
   * array of FieldValueMapping's.
   *
   * @return an array of FieldValueMapping's
   */
  FieldValueMapping[] otherFieldValueMapping();

  /**
   * payload classes.
   *
   * @return the payload classes
   */
  Class[] payload() default {};

  /**
   * Defines several {@code NotEmptyIfOthersHaveValue} annotations on the same element.
   */
  @Target({ElementType.TYPE, ElementType.ANNOTATION_TYPE})
  @Retention(RetentionPolicy.RUNTIME)
  @interface List {
    NotEmptyIfOthersHaveValue[] value();
  }
}