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.objects;
017
018import java.io.Serializable;
019
020/**
021 * Helper interface for integrating the test-framework with arbitrary tests. In
022 * essence it provides the method {@link #getUnderTest()} that will return the
023 * bean / value-object to be tested. Usually instantiated by Inject or other
024 * ways, but out of control of the actual test-base-class
025 *
026 * @param <T> identifying the type to be tested is usually but not necessarily
027 *            at least {@link Serializable}.
028 * @author Oliver Wolff
029 */
030public interface TestObjectProvider<T> {
031
032    /**
033     * @return the bean to be tested. Usually instantiated by Inject or other
034     *         concrete
035     */
036    T getUnderTest();
037}