de.knightsoftnet.validators.shared.LevenshteinDistance 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.LevenshteinDistanceValidator;

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 exact three properties:
 * 
 * a field that has to be checked (option field1)
 * a field which entry is compared (option field2)
 * the minimum levenshtein distance both field entries must have (option
 * minDistance)
 * add the error to field1 (option addErrorToField1, default true)
 * add the error to field2 (option addErrorToField2, default true)
 * 
 * The Levenshtein distance between the entry of fieldCompare and field is
 * calculated, it must be equal or greater then the value of minDistance. not be empty (null or "").
 * 

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

 *
 * @author Valentin Pricop
 *
 */
@Documented
@Constraint(validatedBy = LevenshteinDistanceValidator.class)
@Target({ElementType.TYPE, ElementType.ANNOTATION_TYPE})
@Retention(RetentionPolicy.RUNTIME)
public @interface LevenshteinDistance {
  /**
   * localized message.
   *
   * @return localized validation message
   */
  String message() default "{de.knightsoftnet.validators.shared.LevenshteinDistance.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();

  /**
   * minimum levenshtein distance.
   *
   * @return minimum distance between both entries
   */
  int minDistance();

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

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

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

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