net.sf.mmm.util.validation.base.AbstractValidationStateCollector 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 net.sf.mmm.util.exception.api.NlsNullPointerException;
import net.sf.mmm.util.validation.api.ValidationFailure;
import net.sf.mmm.util.validation.api.ValidationState;

/**
 * This is the abstract base implementation of {@link ValidationState} that wraps an existing {@link ValidationState}
 * and allows to {@link #onFailure(ValidationFailure) collect the potential failures} for a part of the validation
 * process. 

 *
 * @author Joerg Hohwiller (hohwille at users.sourceforge.net)
 * @since 3.0.0
 */
public abstract class AbstractValidationStateCollector implements ValidationState {

  /** The wrapped {@link ValidationState}. */
  private final ValidationState delegate;

  /**
   * The constructor.
   *
   * @param delegate is the {@link ValidationState} to adapt.
   */
  public AbstractValidationStateCollector(ValidationState delegate) {

    super();
    NlsNullPointerException.checkNotNull(ValidationState.class, delegate);
    this.delegate = delegate;
  }

  /**
   * @return the {@link ValidationState} to adapt. Each call to {@link #onFailure(ValidationFailure)} will also be
   *         propagated to this delegate.
   */
  protected ValidationState getDelegate() {

    return this.delegate;
  }

  @Override
  public void onFailure(ValidationFailure failure) {

    this.delegate.onFailure(failure);
  }

  @Override
  public int getFailureCount() {

    return this.delegate.getFailureCount();
  }

  /**
   * {@inheritDoc}
   *
   * 

   * ATTENTION:

   * This method only returns {@code false} if a {@link ValidationFailure} has been {@link #onFailure(ValidationFailure)
   * collected} by this instance. It may therefore return {@code true} even if the {@link #getDelegate() delegate} would
   * return {@code false}.
   */
  @Override
  public boolean isValid() {

    return this.delegate.isValid();
  }

}