001/*
002 * Copyright 2023 the original author or authors.
003 * <p>
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 * <p>
008 * https://www.apache.org/licenses/LICENSE-2.0
009 * <p>
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016package de.cuioss.test.valueobjects.api.object;
017
018import de.cuioss.test.valueobjects.objects.ParameterizedInstantiator;
019
020/**
021 * An {@link ObjectTestContract} provides a method that again runs a number of
022 * asserts regarding the canonical {@link Object} method.
023 *
024 * @author Oliver Wolff
025 */
026@FunctionalInterface
027public interface ObjectTestContract {
028
029    /**
030     * Checks the concrete contract.
031     *
032     * @param instantiator     must not be null. The actual type of the
033     *                         {@link Object} is not of interest, because we check
034     *                         {@link Object} contracts
035     * @param objectTestConfig optional configuration configuring the tests
036     */
037    void assertContract(ParameterizedInstantiator<?> instantiator, ObjectTestConfig objectTestConfig);
038}