org.axonframework.test.matchers.PredicateMatcher Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of axon-test Show documentation

Module containing Test Fixture components to test Domain Models in a given-when-then approach.

There is a newer version: 4.10.3

/*
 * Copyright (c) 2010-2022. Axon Framework
 *
 * 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.axonframework.test.matchers;

import org.hamcrest.Description;
import org.hamcrest.TypeSafeMatcher;

import java.util.function.Predicate;

/**
 * Matcher implementation that delegates the matching to a Predicate. As predicates do not provide a means to describe '
 * their expectation, this matcher defaults to '[matches a given predicate]'.
 *
 * @param  The type of value to match against
 */
public class PredicateMatcher extends TypeSafeMatcher {
    private final Predicate predicate;

    /**
     * Initializes the matcher using given {@code predicate} to test values to match against.
     *
     * @param predicate The predicate defining matching values
     */
    public PredicateMatcher(Predicate predicate) {
        this.predicate = predicate;
    }

    @Override
    protected boolean matchesSafely(T item) {
        return predicate.test(item);
    }

    @Override
    public void describeTo(Description description) {
        description.appendText("[matches a given predicate]");
    }
}