org.microbean.assign.Matcher Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of microbean-assign Show documentation

microBean™ Assign: Utility classes for implementing Java type assignment.

There is a newer version: 0.0.1

/* -*- mode: Java; c-basic-offset: 2; indent-tabs-mode: nil; coding: utf-8-unix -*-
 *
 * Copyright © 2025 microBean™.
 *
 * 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 org.microbean.assign;

import java.util.function.BiPredicate;

/**
 * A {@link BiPredicate} with particular semantics associated with its {@link #test(Object, Object)} method.
 *
 * @param  the criteria object
 *
 * @param  the object being tested
 *
 * @author Laird Nelson
 *
 * @see #test(Object, Object)
 */
@FunctionalInterface
public interface Matcher extends BiPredicate {

  /**
   * Returns {@code true} if and only if the second argument matches the first argument.
   *
   * @param a an object serving as a kind of criteria; must not be {@code null}
   *
   * @param b an object to test; must not be {@code null}
   *
   * @return {@code true} if and only if the second argument matches the first argument; {@code false}
   * otherwise
   *
   * @exception NullPointerException if either {@code a} or {@code b} is {@code null}
   */
  @Override // BiPredicate
  public boolean test(final A a, final B b);

}