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;
017
018import java.io.Serializable;
019
020import de.cuioss.test.valueobjects.api.object.ObjectTestContracts;
021import de.cuioss.test.valueobjects.api.object.VetoObjectTestContract;
022
023/**
024 * Defines the method for testing the correctness of {@link Object} related
025 * tests, see {@link #shouldImplementObjectContracts()}
026 *
027 * @author Oliver Wolff
028 */
029public interface ObjectContractTestSupport {
030
031    /**
032     * <p>
033     * Base test for ValueObjects verifying the correctness of
034     * {@link Object#equals(Object)} {@link Object#hashCode()},
035     * {@link Object#toString()} and {@link Serializable} implementations.
036     * </p>
037     * <p>
038     * If you want to disable one of these tests you can annotate the test class
039     * with {@link VetoObjectTestContract} with the value
040     * {@link ObjectTestContracts#EQUALS_AND_HASHCODE},
041     * {@link ObjectTestContracts#SERIALIZABLE} or
042     * {@link ObjectTestContracts#TO_STRING}
043     * </p>
044     */
045    void shouldImplementObjectContracts();
046
047}