net.sf.mmm.util.validation.base.AbstractValidatorRange 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.exception.NlsBundleUtilExceptionRoot;
import net.sf.mmm.util.nls.api.NlsMessage;
import net.sf.mmm.util.pojo.path.api.TypedProperty;
import net.sf.mmm.util.validation.api.ValueValidator;
import net.sf.mmm.util.value.api.Range;

/**
 * This is the abstract implementation of a {@link ValueValidator} {@link #validate(Object) validating} that a given
 * value {@link Range#isContained(Object) is contained} in a given {@link Range}.
 *
 * @param  the generic type of the value to {@link #validate(Object) validate}.
 * @param  the generic type of the {@link Range}-bounds.
 *
 * @author hohwille
 * @since 7.1.0
 */
@SuppressWarnings("rawtypes")
public class AbstractValidatorRange extends AbstractValueValidator {

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

  private final Range range;

  /**
   * The constructor.
   *
   * @param range is the {@link Range} the value has to be {@link Range#isContained(Object) contained in}.
   */
  public AbstractValidatorRange(Range range) {
    super();
    this.range = range;
  }

  @Override
  protected String getCode() {

    return CODE;
  }

  /**
   * @return the {@link Range} to validate.
   */
  public Range getRange() {

    return this.range;
  }

  /**
   * Converts the value to the type of the range.
   *
   * @param value is the value to convert.
   * @return the converted value.
   */
  @SuppressWarnings("unchecked")
  protected R convertValue(V value) {

    return (R) value;
  }

  @Override
  protected NlsMessage validateNotNull(V value) {

    R convertedValue = convertValue(value);
    if (this.range.isContained(convertedValue)) {
      return null;
    } else {
      return createBundle(NlsBundleUtilExceptionRoot.class).errorValueOutOfRange(convertedValue, this.range.getMin(), this.range.getMax(), null);
    }
  }

  @SuppressWarnings("unchecked")
  @Override
  public  P getProperty(TypedProperty property) {

    if (property == PROPERTY_MINIMUM) {
      return (P) this.range.getMin();
    } else if (property == PROPERTY_MAXIMUM) {
      return (P) this.range.getMax();
    }
    return super.getProperty(property);
  }

  @Override
  public int hashCode() {

    return Objects.hashCode(this.range);
  }

  @Override
  public boolean equals(Object obj) {

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

}