org.axonframework.test.matchers.SequenceMatcher 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.Matcher;

import java.util.Iterator;
import java.util.List;

/**
 * A matcher that will match if all the given {@code matchers} each match against an item that the previous
 * matcher matched against. That means the second matcher should match an item that follow the item that the first
 * matcher matched.
 * 
 * If the number of items is larger than the number of matchers, the excess items are not evaluated. Use {@link
 * Matchers#exactSequenceOf(org.hamcrest.Matcher[])} to match the sequence exactly. If the last item of the list
 * has been evaluated, and Matchers still remain, they are evaluated against a {@code null} value.
 *
 * @author Allard Buijze
 * @since 1.1
 */
public class SequenceMatcher extends ListMatcher {

    /**
     * Construct a matcher that will return true if all the given {@code matchers} match against an item
     * positioned after the item that the previous matcher matched against.
     *
     * @param matchers The matchers that must match against at least one item in the list.
     */
    @SafeVarargs
    public SequenceMatcher(Matcher... matchers) {
        super(matchers);
    }

    @Override
    public boolean matchesList(List items) {
        Iterator itemIterator = items.iterator();
        Iterator> matcherIterator = getMatchers().iterator();
        Matcher currentMatcher = null;
        if (matcherIterator.hasNext()) {
            currentMatcher = matcherIterator.next();
        }

        while (itemIterator.hasNext() && currentMatcher != null) {
            boolean hasMatch = currentMatcher.matches(itemIterator.next());
            if (hasMatch) {
                if (matcherIterator.hasNext()) {
                    currentMatcher = matcherIterator.next();
                } else {
                    currentMatcher = null;
                }
            }
        }
        if (currentMatcher != null && !currentMatcher.matches(null)) {
            reportFailed(currentMatcher);
            return false;
        }

        return matchRemainder(matcherIterator);
    }

    @Override
    protected void describeCollectionType(Description description) {
        description.appendText("sequence");
    }
}