mockit.internal.expectations.argumentMatching.ArgumentMatcher Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jmockit Show documentation

JMockit is a Java toolkit for automated developer testing. It contains APIs for the creation of the objects to be tested, for mocking dependencies, and for faking external APIs; JUnit (4 & 5) and TestNG test runners are supported. It also contains an advanced code coverage tool.

The newest version!

/*
 * Copyright (c) 2006 JMockit developers
 * This file is subject to the terms of the MIT license (see LICENSE.txt).
 */
package mockit.internal.expectations.argumentMatching;

import edu.umd.cs.findbugs.annotations.NonNull;
import edu.umd.cs.findbugs.annotations.Nullable;

/**
 * An argument matcher for the recording/verification of expectations.
 */
public interface ArgumentMatcher> {
    /**
     * Indicates whether this matcher instance is functionally the same as another one of the same type.
     */
    boolean same(@NonNull M other);

    /**
     * Evaluates the matcher for the given argument.
     */
    boolean matches(@Nullable Object argValue);

    /**
     * Writes a phrase to be part of an error message describing an argument mismatch.
     */
    void writeMismatchPhrase(@NonNull ArgumentMismatch argumentMismatch);
}