net.sf.mmm.util.validation.base.ComposedValidator Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of mmm-util-validation Show documentation
This project provides advanced validation support.
There is a newer version: 8.7.0
/* Copyright (c) The m-m-m Team, Licensed under the Apache License, Version 2.0
 * http://www.apache.org/licenses/LICENSE-2.0 */
package net.sf.mmm.util.validation.base;

import java.util.Objects;

import net.sf.mmm.util.pojo.path.api.TypedProperty;
import net.sf.mmm.util.validation.api.ValidationFailure;
import net.sf.mmm.util.validation.api.ValueValidator;

/**
 * This is an implementation of {@link ValueValidator} that is composed out of a set of individual
 * {@link #getValidator(int) validators} given at {@link #ComposedValidator(AbstractValidator...) construction}. It will
 * always invoke all {@link #getValidator(int) contained validators} when a {@link #validate(Object, Object)
 * validation} is performed.
 *
 * @param  is the generic type of the value to {@link #validate(Object) validate}.
 *
 * @author Joerg Hohwiller (hohwille at users.sourceforge.net)
 * @since 3.1.0
 */
public class ComposedValidator extends AbstractValidator implements ComposedValueValidator {

  /** @see #getCode() */
  public static final String CODE = "ComposedValidator";

  /** The child validators. */
  private final AbstractValidator[] validators;

  /**
   * The constructor.
   *
   * @param validators are the {@link #getValidator(int) validators} to compose.
   */
  @SafeVarargs
  public ComposedValidator(AbstractValidator... validators) {

    super();
    this.validators = validators;
  }

  @Override
  protected String getCode() {

    return ComposedValidationFailure.CODE;
  }

  @Override
  public ValidationFailure validate(V value, Object valueSource) {

    ValidationFailureComposer composer = new ValidationFailureComposer();
    for (ValueValidator v : this.validators) {
      ValidationFailure failure = v.validate(value, valueSource);
      composer.add(failure);
    }
    return composer.get(valueSource);
  }

  /**
   * @see #getValidator(int)
   * @see java.util.Collection#size()
   *
   * @return the number of {@link #getValidator(int) validators}.
   */
  @Override
  public int getValidatorCount() {

    return this.validators.length;
  }

  /**
   * Gets the {@link ValueValidator} at the given {@code index}.
   *
   * @see java.util.List#get(int)
   *
   * @param index is the index of the {@link ValueValidator} to get.
   * @return the requested {@link ValueValidator}.
   */
  @Override
  public AbstractValidator getValidator(int index) {

    return this.validators[index];
  }

  @Override
  public  P getProperty(TypedProperty property) {

    P value = null;
    for (AbstractValidator validator : this.validators) {
      value = validator.getProperty(property);
      if (value != null) {
        break;
      }
    }
    return value;
  }

  @Override
  public boolean contains(AbstractValidator validator) {

    if (super.contains(validator)) {
      return true;
    }
    for (AbstractValidator childValidator : this.validators) {
      if (childValidator.contains(validator)) {
        return true;
      }
    }
    return false;
  }

  @SuppressWarnings("unchecked")
  @Override
  public ComposedValidator append(AbstractValidator... additionalValidators) {

    Objects.requireNonNull(additionalValidators, "validators");
    if (additionalValidators.length == 0) {
      return this;
    }
    AbstractValidator[] composed = new AbstractValidator[this.validators.length
        + additionalValidators.length];
    System.arraycopy(this.validators, 0, composed, 0, this.validators.length);
    System.arraycopy(additionalValidators, 0, composed, this.validators.length, additionalValidators.length);
    return new ComposedValidator<>(composed);
  }

  @Override
  public int hashCode() {

    return 97531;
  }

  @Override
  public boolean equals(Object obj) {

    if (this == obj) {
      return true;
    }
    if (obj == null) {
      return false;
    }
    if (getClass() != obj.getClass()) {
      return false;
    }
    ComposedValidator other = (ComposedValidator) obj;
    if (!Objects.equals(this.validators, other.validators)) {
      return false;
    }
    return true;
  }
}