com.helger.validation.validator.string.StringMinLengthValidator Maven / Gradle / Ivy

Go to download
/**
 * Copyright (C) 2014-2016 Philip Helger (www.helger.com)
 * philip[at]helger[dot]com
 *
 * Licensed 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 com.helger.validation.validator.string;

import javax.annotation.Nonnegative;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import javax.annotation.concurrent.Immutable;

import com.helger.commons.ValueEnforcer;
import com.helger.commons.equals.EqualsHelper;
import com.helger.commons.hashcode.HashCodeGenerator;
import com.helger.commons.string.StringHelper;
import com.helger.commons.string.ToStringGenerator;
import com.helger.commons.text.display.IHasDisplayText;
import com.helger.validation.EStandardValidationErrorTexts;
import com.helger.validation.result.IValidationResult;
import com.helger.validation.result.ValidationResultError;
import com.helger.validation.result.ValidationResultSuccess;

/**
 * Check whether a string fulfills a minimum length restriction.
 *
 * @author Philip Helger
 */
@Immutable
public class StringMinLengthValidator extends AbstractStringValidator
{
  private final int m_nMinLength;
  private final IHasDisplayText m_aErrorText;

  public StringMinLengthValidator (@Nonnegative final int nMinLength)
  {
    this (nMinLength, null);
  }

  /**
   * Constructor with custom error message.
   *
   * @param nMinLength
   *        The maximum allowed string length. Must be ≥ 0.
   * @param aErrorText
   *        Optional error text. May be null.
   */
  public StringMinLengthValidator (@Nonnegative final int nMinLength, @Nullable final IHasDisplayText aErrorText)
  {
    ValueEnforcer.isGE0 (nMinLength, "MinLength");
    m_nMinLength = nMinLength;
    m_aErrorText = aErrorText;
  }

  @Nonnull
  public IValidationResult validate (@Nullable final String sValue)
  {
    if (StringHelper.getLength (sValue) >= m_nMinLength)
      return ValidationResultSuccess.getInstance ();
    return ValidationResultError.create (m_aErrorText != null ? m_aErrorText
                                                              : EStandardValidationErrorTexts.INVALID_MINLENGTH,
                                         Integer.toString (m_nMinLength));
  }

  @Override
  public boolean equals (final Object o)
  {
    if (o == this)
      return true;
    if (!super.equals (o))
      return false;
    final StringMinLengthValidator rhs = (StringMinLengthValidator) o;
    return m_nMinLength == rhs.m_nMinLength && EqualsHelper.equals (m_aErrorText, rhs.m_aErrorText);
  }

  @Override
  public int hashCode ()
  {
    return HashCodeGenerator.getDerived (super.hashCode ()).append (m_nMinLength).append (m_aErrorText).getHashCode ();
  }

  @Override
  public String toString ()
  {
    return ToStringGenerator.getDerived (super.toString ())
                            .append ("minLength", m_nMinLength)
                            .appendIfNotNull ("errorText", m_aErrorText)
                            .toString ();
  }
}