/*
 * 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.
 *
 * Copyright 2012-2024 the original author or authors.
 */
package org.assertj.core.error;

import static java.util.Objects.requireNonNull;

import java.util.function.Predicate;

import org.assertj.core.presentation.PredicateDescription;

/**
 * Creates an error message indicating that an assertion that verifies that
 * <code>{@link Predicate}</code> accepts a value failed.
 *
 * @author Filip Hrisafov
 */
public class ShouldAccept extends BasicErrorMessageFactory {

  /**
   * Creates a new <code>{@link ShouldAccept}</code>.
   *
   * @param <T> guarantees that the type of the value value and the generic type of the {@code Predicate} are the same.
   * @param predicate the {@code Predicate}.
   * @param value the value value in the failed assertion.
   * @param description predicate description to include in the error message,
   * @return the created {@code ErrorMessageFactory}.
   */
  public static <T> ErrorMessageFactory shouldAccept(Predicate<? super T> predicate, T value,
                                                     PredicateDescription description) {
    requireNonNull(description, "The predicate description must not be null");
    return new ShouldAccept(value, description);
  }

  private ShouldAccept(Object value, PredicateDescription description) {
    super("%nExpecting actual:%n  %s predicate%nto accept %s but it did not.", description, value);
  }
}
