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

Go to download
/*
 * 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.NotEmptyIfOtherIsEmptyValidator;

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 that has to be checked (option field)
 * a field which entry is compared (option fieldCompare)
 * 
 * if the entry of fieldCompare is empty (null or ""), field must not be
 * empty (null or "").

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

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

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

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

  /**
   * field name to compare.
   *
   * @return field/path containing compare value
   */
  String fieldCompare();

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

  /**
   * Defines several {@code MustBeFilledIfOtherIsEmpty} annotations on the same element.
   */
  @Target({ElementType.TYPE, ElementType.ANNOTATION_TYPE})
  @Retention(RetentionPolicy.RUNTIME)
  @Documented
  @interface List {
    /**
     * not empty if other is empty value.
     *
     * @return value
     */
    NotEmptyIfOtherIsEmpty[] value();
  }
}